BedrockAgentCoreControlPlaneFrontingLayer / Client / get_gateway

get_gateway

BedrockAgentCoreControlPlaneFrontingLayer.Client.get_gateway(**kwargs)

Retrieves information about a specific Gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_gateway(
    gatewayIdentifier='string'
)
Parameters:

gatewayIdentifier (string) –

[REQUIRED]

The identifier of the gateway to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayArn': 'string',
    'gatewayId': 'string',
    'gatewayUrl': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED',
    'statusReasons': [
        'string',
    ],
    'name': 'string',
    'description': 'string',
    'roleArn': 'string',
    'protocolType': 'MCP',
    'protocolConfiguration': {
        'mcp': {
            'supportedVersions': [
                'string',
            ],
            'instructions': 'string',
            'searchType': 'SEMANTIC'
        }
    },
    'authorizerType': 'CUSTOM_JWT',
    'authorizerConfiguration': {
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ]
        }
    },
    'kmsKeyArn': 'string',
    'workloadIdentityDetails': {
        'workloadIdentityArn': 'string'
    },
    'exceptionLevel': 'DEBUG'
}

Response Structure

  • (dict) –

    • gatewayArn (string) –

      The Amazon Resource Name (ARN) of the gateway.

    • gatewayId (string) –

      The unique identifier of the gateway.

    • gatewayUrl (string) –

      An endpoint for invoking gateway.

    • createdAt (datetime) –

      The timestamp when the gateway was created.

    • updatedAt (datetime) –

      The timestamp when the gateway was last updated.

    • status (string) –

      The current status of the gateway.

    • statusReasons (list) –

      The reasons for the current status of the gateway.

      • (string) –

    • name (string) –

      The name of the gateway.

    • description (string) –

      The description of the gateway.

    • roleArn (string) –

      The IAM role ARN that provides permissions for the gateway.

    • protocolType (string) –

      Protocol applied to a gateway.

    • protocolConfiguration (dict) –

      The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: mcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • mcp (dict) –

        The configuration for the Model Context Protocol (MCP). This protocol enables communication between Amazon Bedrock Agent and external tools.

        • supportedVersions (list) –

          The supported versions of the Model Context Protocol. This field specifies which versions of the protocol the gateway can use.

          • (string) –

        • instructions (string) –

          The instructions for using the Model Context Protocol gateway. These instructions provide guidance on how to interact with the gateway.

        • searchType (string) –

          The search type for the Model Context Protocol gateway. This field specifies how the gateway handles search operations.

    • authorizerType (string) –

      Authorizer type for the gateway.

    • authorizerConfiguration (dict) –

      The authorizer configuration for the gateway.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: customJWTAuthorizer. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • customJWTAuthorizer (dict) –

        The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

        • discoveryUrl (string) –

          This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

        • allowedAudience (list) –

          Represents individual audience values that are validated in the incoming JWT token validation process.

          • (string) –

        • allowedClients (list) –

          Represents individual client IDs that are validated in the incoming JWT token validation process.

          • (string) –

    • kmsKeyArn (string) –

      The Amazon Resource Name (ARN) of the KMS key used to encrypt the gateway.

    • workloadIdentityDetails (dict) –

      The workload identity details for the gateway.

      • workloadIdentityArn (string) –

        The ARN associated with the workload identity.

    • exceptionLevel (string) –

      The level of detail in error messages returned when invoking the gateway.

      • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

      • If the value is omitted, a generic error message is returned to the end user.

Exceptions