View a markdown version of this page

GatewayTarget - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GatewayTarget

The gateway target.

Contents

createdAt

The date and time at which the target was created.

Type: Timestamp

Required: Yes

credentialProviderConfigurations

The provider configurations.

Type: Array of CredentialProviderConfiguration objects

Array Members: Fixed number of 1 item.

Required: Yes

gatewayArn

The Amazon Resource Name (ARN) of the gateway target.

Type: String

Pattern: arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}

Required: Yes

name

The name of the gateway target.

Type: String

Pattern: ([0-9a-zA-Z][-]?){1,100}

Required: Yes

status

The status of the gateway target.

Type: String

Valid Values: CREATING | UPDATING | UPDATE_UNSUCCESSFUL | DELETING | READY | FAILED | SYNCHRONIZING | SYNCHRONIZE_UNSUCCESSFUL | CREATE_PENDING_AUTH | UPDATE_PENDING_AUTH | SYNCHRONIZE_PENDING_AUTH

Required: Yes

targetConfiguration

The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

Type: TargetConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

targetId

The target ID.

Type: String

Pattern: [0-9a-zA-Z]{10}

Required: Yes

updatedAt

The date and time at which the target was updated.

Type: Timestamp

Required: Yes

authorizationData

OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

Type: AuthorizationData object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

description

The description for the gateway target.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

lastSynchronizedAt

The last synchronization time.

Type: Timestamp

Required: No

metadataConfiguration

The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.

Type: MetadataConfiguration object

Required: No

privateEndpoint

The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.

Type: PrivateEndpoint object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

privateEndpointManagedResources

A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

Type: Array of ManagedResourceDetails objects

Required: No

protocolType

The protocol type of the gateway target.

Type: String

Valid Values: MCP | HTTP

Required: No

statusReasons

The status reasons for the target status.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: