View a markdown version of this page

TargetSummary - Amazon Bedrock AgentCore Control Plane

TargetSummary

Contains summary information about a gateway target. A target represents an endpoint that the gateway can connect to.

Contents

createdAt

The timestamp when the target was created.

Type: Timestamp

Required: Yes

name

The name of the target.

Type: String

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

Required: Yes

status

The current status of the 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

targetId

The unique identifier of the target.

Type: String

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

Required: Yes

updatedAt

The timestamp when the target was last updated.

Type: Timestamp

Required: Yes

authorizationData

Contains the authorization data that is returned when a gateway 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 of the target.

Type: String

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

Required: No

lastSynchronizedAt

The timestamp when the target was last synchronized.

Type: Timestamp

Required: No

listingMode

The listing mode for the target. MCP resources for DEFAULT targets are cached at the control plane for faster access. MCP resources for DYNAMIC targets are retrieved dynamically when listing tools.

Type: String

Valid Values: DEFAULT | DYNAMIC

Required: No

resourcePriority

Priority for resolving resource URI conflicts across targets. Lower values take precedence. Defaults to 1000 when not set.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

targetType

The type of the target.

Type: String

Valid Values: OPEN_API_SCHEMA | SMITHY_MODEL | MCP_SERVER | LAMBDA | API_GATEWAY | CONNECTOR | AGENTCORE_RUNTIME | PASSTHROUGH | PROVIDER

Required: No

See Also

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