View a markdown version of this page

GatewaySummary - 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).

GatewaySummary

Contains summary information about a gateway.

Contents

authorizerType

The type of authorizer used by the gateway.

Type: String

Valid Values: CUSTOM_JWT | AWS_IAM | NONE | AUTHENTICATE_ONLY

Required: Yes

createdAt

The timestamp when the gateway was created.

Type: Timestamp

Required: Yes

gatewayId

The unique identifier of the gateway.

Type: String

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

Required: Yes

name

The name of the gateway.

Type: String

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

Required: Yes

status

The current status of the gateway.

Type: String

Valid Values: CREATING | UPDATING | UPDATE_UNSUCCESSFUL | DELETING | READY | FAILED

Required: Yes

updatedAt

The timestamp when the gateway was last updated.

Type: Timestamp

Required: Yes

description

The description of the gateway.

Type: String

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

Required: No

protocolType

The protocol type used by the gateway.

Type: String

Valid Values: MCP

Required: No

See Also

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