AWS SDK for Go v2 bedrockagentcorecontrol

https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol
Admin
AWS SDK for Go v2 bedrockagentcorecontrol provides the API client, operations, and parameter types...
Tokens:2,637
Snippets:30
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Unmarshal response document into a key/value map with UnmarshalSmithyDocument

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/document

Shows how to retrieve the content of a response document by calling UnmarshalSmithyDocument on the response document, passing a reference to a map to map the response to. The example includes error handling.

```go
var kv map[string]interface{}
if err := outputDocument.UnmarshalSmithyDocument(&kv); err != nil {
    // handle error
}
```

--------------------------------

### Dynamically handle response document types with type switch

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/document

Shows how to handle a response document that can return one or more data-types by unmarshalling into an empty interface and using a type switch to handle each possible type, including map, slice, bool, document.Number, and string.

```go
var v interface{}
if err := outputDocument.UnmarshalSmithyDocument(&v); err != nil {
   // handle error
}

switch vv := v.(type) {
case map[string]interface{}:
    // handle key/value map
case []interface{}:
    // handle array of values
case bool:
    // handle boolean
case document.Number:
    // handle an arbitrary precision number
case string:
   // handle string
default:
   // handle unknown case
}
```

--------------------------------

### New function for Resolver

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Returns a new Resolver instance.

```go
func New() *Resolver
```

--------------------------------

### Options getter methods

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Getter methods for the Options struct fields, returning the respective configuration values.

```go
func (o Options) GetDisableHTTPS() bool
```

```go
func (o Options) GetResolvedRegion() string
```

```go
func (o Options) GetUseDualStackEndpoint() aws.DualStackEndpointState
```

```go
func (o Options) GetUseFIPSEndpoint() aws.FIPSEndpointState
```

--------------------------------

### New

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Creates a new Resolver instance for resolving Bedrock AgentCore Control service endpoints.

```APIDOC
## New

### Description
Creates a new Resolver instance for resolving Bedrock AgentCore Control service endpoints.

### Function Signature
`func New() *Resolver`

### Parameters
None

### Returns
- `*Resolver` - A new Resolver instance.

```

--------------------------------

### Options struct definition

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Defines the Options struct used for endpoint resolver configuration, including fields for logging, deprecated endpoint logging, resolved region override, HTTPS disabling, and dual-stack/FIPS endpoint states.

```go
type Options struct {
	// Logger is a logging implementation that log events should be sent to.
	Logger logging.Logger

	// LogDeprecated indicates that deprecated endpoints should be logged to the
	// provided logger.
	LogDeprecated bool

	// ResolvedRegion is used to override the region to be resolved, rather then the
	// using the value passed to the ResolveEndpoint method. This value is used by the
	// SDK to translate regions like fips-us-east-1 or us-east-1-fips to an alternative
	// name. You must not set this value directly in your application.
	ResolvedRegion string

	// DisableHTTPS informs the resolver to return an endpoint that does not use the
	// HTTPS scheme.
	DisableHTTPS bool

	// UseDualStackEndpoint specifies the resolver must resolve a dual-stack endpoint.
	UseDualStackEndpoint aws.DualStackEndpointState

	// UseFIPSEndpoint specifies the resolver must resolve a FIPS endpoint.
	UseFIPSEndpoint aws.FIPSEndpointState
}
```

--------------------------------

### Options

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Options is the endpoint resolver configuration options. It contains fields to control endpoint resolution behavior such as disabling HTTPS, using dual-stack or FIPS endpoints, and overriding the region.

```APIDOC
## Options

### Description
Options is the endpoint resolver configuration options. It contains fields to control endpoint resolution behavior such as disabling HTTPS, using dual-stack or FIPS endpoints, and overriding the region.

### Fields
- `Logger` (logging.Logger) - Optional - A logging implementation that log events should be sent to.
- `LogDeprecated` (bool) - Optional - Indicates that deprecated endpoints should be logged to the provided logger.
- `ResolvedRegion` (string) - Optional - Used to override the region to be resolved, rather than using the value passed to the ResolveEndpoint method. This value is used by the SDK to translate regions like fips-us-east-1 or us-east-1-fips to an alternative name. You must not set this value directly in your application.
- `DisableHTTPS` (bool) - Optional - Informs the resolver to return an endpoint that does not use the HTTPS scheme.
- `UseDualStackEndpoint` (aws.DualStackEndpointState) - Optional - Specifies the resolver must resolve a dual-stack endpoint.
- `UseFIPSEndpoint` (aws.FIPSEndpointState) - Optional - Specifies the resolver must resolve a FIPS endpoint.

```

--------------------------------

### Create document types with NewLazyDocument using basic Go types

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/document

Shows how to create document types using NewLazyDocument with basic Go types: a map, a float, a slice, and a boolean. The document is encoded during request serialization after invoking an API client operation.

```go
NewLazyDocument(map[string]interface{}{
    "favoriteNumber": 42,
    "fruits":         []string{"apple", "orange"},
    "capitals":       map[string]interface{}{
        "Washington": "Olympia",
        "Oregon":     "Salem",
    },
    "skyIsBlue":      true,
})

NewLazyDocument(3.14159)

NewLazyDocument([]interface{"One", 2, 3, 3.5, "four"})

NewLazyDocument(true)
```

--------------------------------

### ResolveEndpoint method

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Resolves the service endpoint for the given region and options.

```go
func (r *Resolver) ResolveEndpoint(region string, options Options) (endpoint aws.Endpoint, err error)
```

--------------------------------

### Options.GetUseFIPSEndpoint

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Returns the value of the UseFIPSEndpoint field.

```APIDOC
## Options.GetUseFIPSEndpoint

### Description
Returns the value of the UseFIPSEndpoint field.

### Method
`GetUseFIPSEndpoint`

### Signature
`func (o Options) GetUseFIPSEndpoint() aws.FIPSEndpointState`

### Parameters
None

### Returns
- `aws.FIPSEndpointState` - The value of the UseFIPSEndpoint field.

```

--------------------------------

### Options.GetUseDualStackEndpoint

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Returns the value of the UseDualStackEndpoint field.

```APIDOC
## Options.GetUseDualStackEndpoint

### Description
Returns the value of the UseDualStackEndpoint field.

### Method
`GetUseDualStackEndpoint`

### Signature
`func (o Options) GetUseDualStackEndpoint() aws.DualStackEndpointState`

### Parameters
None

### Returns
- `aws.DualStackEndpointState` - The value of the UseDualStackEndpoint field.

```

--------------------------------

### Resolver struct definition

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Defines the Resolver struct for the Bedrock AgentCore Control endpoint resolver. It contains unexported fields.

```go
type Resolver struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### NewLazyDocument function signature

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/document

Declares the NewLazyDocument function that returns an Interface. It is used to create a document type from a Go value to be marshaled and sent to the service.

```go
func NewLazyDocument(v interface{}) Interface
```

--------------------------------

### Options.GetDisableHTTPS

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Returns the value of the DisableHTTPS field.

```APIDOC
## Options.GetDisableHTTPS

### Description
Returns the value of the DisableHTTPS field.

### Method
`GetDisableHTTPS`

### Signature
`func (o Options) GetDisableHTTPS() bool`

### Parameters
None

### Returns
- `bool` - The value of the DisableHTTPS field.

```

--------------------------------

### Resolver.ResolveEndpoint

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Resolves the service endpoint for the given region and options. This method is used to determine the endpoint URL for the Bedrock AgentCore Control service.

```APIDOC
## Resolver.ResolveEndpoint

### Description
Resolves the service endpoint for the given region and options. This method is used to determine the endpoint URL for the Bedrock AgentCore Control service.

### Method
`ResolveEndpoint`

### Signature
`func (r *Resolver) ResolveEndpoint(region string, options Options) (endpoint aws.Endpoint, err error)`

### Parameters
- `region` (string) - Required - The AWS region for which to resolve the endpoint.
- `options` (Options) - Required - The endpoint resolver configuration options.

### Returns
- `endpoint` (aws.Endpoint) - The resolved endpoint.
- `err` (error) - An error if resolution fails.

```

--------------------------------

### Interface type alias definition

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/document

Defines the Interface type as an alias for internaldocument.Interface. This type is used to represent a document with a JSON-like data model.

```go
type Interface = internaldocument.Interface
```

--------------------------------

### Options.GetResolvedRegion

Source: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol/internal/endpoints

Returns the value of the ResolvedRegion field.

```APIDOC
## Options.GetResolvedRegion

### Description
Returns the value of the ResolvedRegion field.

### Method
`GetResolvedRegion`

### Signature
`func (o Options) GetResolvedRegion() string`

### Parameters
None

### Returns
- `string` - The value of the ResolvedRegion field.

```
Tokens:
Raw