BedrockAgentCoreControl / Client / get_gateway_target

get_gateway_target¶

BedrockAgentCoreControl.Client.get_gateway_target(**kwargs)¶

Retrieves information about a specific gateway target.

Request Syntax

response = client.get_gateway_target(
    gatewayIdentifier='string',
    targetId='string'
)

Parameters:

gatewayIdentifier (string) –
[REQUIRED]

The identifier of the gateway that contains the target.
targetId (string) –
[REQUIRED]

The unique identifier of the target to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayArn': 'string',
    'targetId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH'|'SYNCHRONIZE_PENDING_AUTH',
    'statusReasons': [
        'string',
    ],
    'name': 'string',
    'description': 'string',
    'targetConfiguration': {
        'mcp': {
            'openApiSchema': {
                's3': {
                    'uri': 'string',
                    'bucketOwnerAccountId': 'string'
                },
                'inlinePayload': 'string'
            },
            'smithyModel': {
                's3': {
                    'uri': 'string',
                    'bucketOwnerAccountId': 'string'
                },
                'inlinePayload': 'string'
            },
            'lambda': {
                'lambdaArn': 'string',
                'toolSchema': {
                    's3': {
                        'uri': 'string',
                        'bucketOwnerAccountId': 'string'
                    },
                    'inlinePayload': [
                        {
                            'name': 'string',
                            'description': 'string',
                            'inputSchema': {
                                'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                'properties': {
                                    'string': {'... recursive ...'}
                                },
                                'required': [
                                    'string',
                                ],
                                'items': {'... recursive ...'},
                                'description': 'string'
                            },
                            'outputSchema': {
                                'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                'properties': {
                                    'string': {'... recursive ...'}
                                },
                                'required': [
                                    'string',
                                ],
                                'items': {'... recursive ...'},
                                'description': 'string'
                            }
                        },
                    ]
                }
            },
            'mcpServer': {
                'endpoint': 'string',
                'mcpToolSchema': {
                    's3': {
                        'uri': 'string',
                        'bucketOwnerAccountId': 'string'
                    },
                    'inlinePayload': 'string'
                },
                'listingMode': 'DEFAULT'|'DYNAMIC',
                'resourcePriority': 123
            },
            'apiGateway': {
                'restApiId': 'string',
                'stage': 'string',
                'apiGatewayToolConfiguration': {
                    'toolOverrides': [
                        {
                            'name': 'string',
                            'description': 'string',
                            'path': 'string',
                            'method': 'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST'
                        },
                    ],
                    'toolFilters': [
                        {
                            'filterPath': 'string',
                            'methods': [
                                'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST',
                            ]
                        },
                    ]
                }
            },
            'connector': {
                'source': {
                    'connectorId': 'string'
                },
                'enabled': [
                    'string',
                ],
                'configurations': [
                    {
                        'name': 'string',
                        'description': 'string',
                        'parameterValues': {...}|[...]|123|123.4|'string'|True|None,
                        'parameterOverrides': [
                            {
                                'path': 'string',
                                'description': 'string',
                                'visible': True|False
                            },
                        ]
                    },
                ]
            }
        },
        'http': {
            'agentcoreRuntime': {
                'arn': 'string',
                'qualifier': 'string',
                'schema': {
                    'source': {
                        's3': {
                            'uri': 'string',
                            'bucketOwnerAccountId': 'string'
                        },
                        'inlinePayload': 'string'
                    }
                }
            },
            'passthrough': {
                'endpoint': 'string',
                'protocolType': 'MCP'|'A2A'|'INFERENCE'|'CUSTOM',
                'schema': {
                    'source': {
                        's3': {
                            'uri': 'string',
                            'bucketOwnerAccountId': 'string'
                        },
                        'inlinePayload': 'string'
                    }
                },
                'stickinessConfiguration': {
                    'identifier': 'string',
                    'timeout': 123
                }
            }
        },
        'inference': {
            'connector': {
                'source': {
                    'connectorId': 'string'
                }
            },
            'provider': {
                'endpoint': 'string',
                'modelMapping': {
                    'providerPrefix': {
                        'strip': True|False,
                        'separator': 'string'
                    }
                },
                'operations': [
                    {
                        'path': 'string',
                        'providerPath': 'string',
                        'models': [
                            {
                                'model': 'string'
                            },
                        ]
                    },
                ]
            }
        }
    },
    'credentialProviderConfigurations': [
        {
            'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY'|'CALLER_IAM_CREDENTIALS'|'JWT_PASSTHROUGH',
            'credentialProvider': {
                'oauthCredentialProvider': {
                    'providerArn': 'string',
                    'scopes': [
                        'string',
                    ],
                    'customParameters': {
                        'string': 'string'
                    },
                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE'|'TOKEN_EXCHANGE',
                    'defaultReturnUrl': 'string'
                },
                'apiKeyCredentialProvider': {
                    'providerArn': 'string',
                    'credentialParameterName': 'string',
                    'credentialPrefix': 'string',
                    'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
                },
                'iamCredentialProvider': {
                    'service': 'string',
                    'region': 'string'
                }
            }
        },
    ],
    'lastSynchronizedAt': datetime(2015, 1, 1),
    'metadataConfiguration': {
        'allowedRequestHeaders': [
            'string',
        ],
        'allowedQueryParameters': [
            'string',
        ],
        'allowedResponseHeaders': [
            'string',
        ]
    },
    'privateEndpoint': {
        'selfManagedLatticeResource': {
            'resourceConfigurationIdentifier': 'string'
        },
        'managedVpcResource': {
            'vpcIdentifier': 'string',
            'subnetIds': [
                'string',
            ],
            'endpointIpAddressType': 'IPV4'|'IPV6',
            'securityGroupIds': [
                'string',
            ],
            'tags': {
                'string': 'string'
            },
            'routingDomain': 'string'
        }
    },
    'privateEndpointManagedResources': [
        {
            'domain': 'string',
            'resourceGatewayArn': 'string',
            'resourceAssociationArn': 'string'
        },
    ],
    'authorizationData': {
        'oauth2': {
            'authorizationUrl': 'string',
            'userId': 'string'
        }
    },
    'protocolType': 'MCP'|'HTTP'
}

Response Structure

(dict) –
- gatewayArn (string) –
  
  The Amazon Resource Name (ARN) of the gateway.
- targetId (string) –
  
  The unique identifier of the gateway target.
- createdAt (datetime) –
  
  The timestamp when the gateway target was created.
- updatedAt (datetime) –
  
  The timestamp when the gateway target was last updated.
- status (string) –
  
  The current status of the gateway target.
- statusReasons (list) –
  
  The reasons for the current status of the gateway target.
  - (string) –
- name (string) –
  
  The name of the gateway target.
- description (string) –
  
  The description of the gateway target.
- targetConfiguration (dict) –
  
  The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: mcp, http, inference. 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 Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: openApiSchema, smithyModel, lambda, mcpServer, apiGateway, connector. 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'}
    - openApiSchema (dict) –
      
      The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3, inlinePayload. 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'}
      - s3 (dict) –
        
        The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
        
        uri (string) –
        
        The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
        
        bucketOwnerAccountId (string) –
        
        The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
      - inlinePayload (string) –
        
        The inline payload containing the API schema definition.
    - smithyModel (dict) –
      
      The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3, inlinePayload. 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'}
      - s3 (dict) –
        
        The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
        
        uri (string) –
        
        The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
        
        bucketOwnerAccountId (string) –
        
        The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
      - inlinePayload (string) –
        
        The inline payload containing the API schema definition.
    - lambda (dict) –
      
      The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
      - lambdaArn (string) –
        
        The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.
      - toolSchema (dict) –
        
        The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: s3, inlinePayload. 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'}
        
        s3 (dict) –
        
        The Amazon S3 location of the tool schema. This location contains the schema definition file.
        
        uri (string) –
        
        The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
        
        bucketOwnerAccountId (string) –
        
        The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
        
        inlinePayload (list) –
        
        The inline payload of the tool schema. This payload contains the schema definition directly in the request.
        
        (dict) –
        
        A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
        
        name (string) –
        
        The name of the tool. This name identifies the tool in the Model Context Protocol.
        
        description (string) –
        
        The description of the tool. This description provides information about the purpose and usage of the tool.
        
        inputSchema (dict) –
        
        The input schema for the tool. This schema defines the structure of the input that the tool accepts.
        
        type (string) –
        
        The type of the schema definition. This field specifies the data type of the schema.
        
        properties (dict) –
        
        The properties of the schema definition. These properties define the fields in the schema.
        
        (string) –
        
        (dict) –
        
        A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
        
        required (list) –
        
        The required fields in the schema definition. These fields must be provided when using the schema.
        
        (string) –
        
        items (dict) –
        
        The items in the schema definition. This field is used for array types to define the structure of the array elements.
        
        description (string) –
        
        The description of the schema definition. This description provides information about the purpose and usage of the schema.
        
        outputSchema (dict) –
        
        The output schema for the tool. This schema defines the structure of the output that the tool produces.
        
        type (string) –
        
        The type of the schema definition. This field specifies the data type of the schema.
        
        properties (dict) –
        
        The properties of the schema definition. These properties define the fields in the schema.
        
        (string) –
        
        (dict) –
        
        A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
        
        required (list) –
        
        The required fields in the schema definition. These fields must be provided when using the schema.
        
        (string) –
        
        items (dict) –
        
        The items in the schema definition. This field is used for array types to define the structure of the array elements.
        
        description (string) –
        
        The description of the schema definition. This description provides information about the purpose and usage of the schema.
    - mcpServer (dict) –
      
      The MCP server specified as the gateway target.
      - endpoint (string) –
        
        The endpoint for the MCP server target configuration.
      - mcpToolSchema (dict) –
        
        The tool schema configuration for the MCP server target. Supported only when the credential provider is configured with an authorization code grant type. Dynamic tool discovery/synchronization will be disabled when target is configured with mcpToolSchema.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: s3, inlinePayload. 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'}
        
        s3 (dict) –
        
        The Amazon S3 location of the tool schema. This location contains the schema definition file.
        
        uri (string) –
        
        The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
        
        bucketOwnerAccountId (string) –
        
        The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
        
        inlinePayload (string) –
        
        The inline payload containing the MCP tool schema definition.
      - listingMode (string) –
        
        The listing mode for the MCP server target configuration. MCP resources for default targets are cached at the control plane for faster access. MCP resources for dynamic targets will be dynamically retrieved when listing tools.
      - resourcePriority (integer) –
        
        Priority for resolving MCP server targets with shared resource URIs. Lower values take precedence. Defaults to 1000 when not set.
    - apiGateway (dict) –
      
      The configuration for an Amazon API Gateway target.
      - restApiId (string) –
        
        The ID of the API Gateway REST API.
      - stage (string) –
        
        The ID of the stage of the REST API to add as a target.
      - apiGatewayToolConfiguration (dict) –
        
        The configuration for defining REST API tool filters and overrides for the gateway target.
        
        toolOverrides (list) –
        
        A list of explicit tool definitions with optional custom names and descriptions.
        
        (dict) –
        
        Settings to override configurations for a tool.
        
        name (string) –
        
        The name of tool. Identifies the tool in the Model Context Protocol.
        
        description (string) –
        
        The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API’s OpenAPI specification.
        
        path (string) –
        
        Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.
        
        method (string) –
        
        The HTTP method to expose for the specified path.
        
        toolFilters (list) –
        
        A list of path and method patterns to expose as tools using metadata from the REST API’s OpenAPI specification.
        
        (dict) –
        
        Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API’s exported OpenAPI specification.
        
        filterPath (string) –
        
        Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.
        
        methods (list) –
        
        The methods to filter for.
        
        (string) –
    - connector (dict) –
      
      The connector integration configuration for the Model Context Protocol target. This configuration defines how the gateway uses a pre-built connector to communicate with the target.
      - source (dict) –
        
        The source configuration identifying which connector to use.
        
        connectorId (string) –
        
        The identifier for the connector integration (for example, bedrock-knowledge-bases).
      - enabled (list) –
        
        A list of tool names to enable from this connector. If absent, all tools provided by the connector are enabled.
        
        (string) –
      - configurations (list) –
        
        A list of per-tool configurations for the connector.
        
        (dict) –
        
        Configuration for a single tool within a connector.
        
        name (string) –
        
        The tool or operation name (for example, retrieve or webSearch).
        
        description (string) –
        
        An agent-facing description override for this tool.
        
        parameterValues (document) –
        
        Parameters to set as fixed or default values when provisioning this tool.
        
        parameterOverrides (list) –
        
        Parameters to expose to the agent at runtime, with optional description overrides.
        
        (dict) –
        
        Specifies a parameter override for a connector tool, allowing you to control parameter visibility and descriptions.
        
        path (string) –
        
        A JSON Pointer path identifying the parameter (for example, /numberOfResults or /filter).
        
        description (string) –
        
        An agent-facing description override for this parameter.
        
        visible (boolean) –
        
        Whether this parameter is visible to the agent. If not specified, uses the service default.
  - http (dict) –
    
    The HTTP target configuration. Use this to route gateway requests to an HTTP-based endpoint such as an AgentCore Runtime.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: agentcoreRuntime, passthrough. 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'}
    - agentcoreRuntime (dict) –
      
      The AgentCore Runtime target configuration for HTTP-based communication with an agent runtime.
      - arn (string) –
        
        The Amazon Resource Name (ARN) of the AgentCore Runtime to route requests to.
      - qualifier (string) –
        
        The qualifier for the agent runtime, used to target a specific endpoint version. If not specified, the default endpoint is used.
      - schema (dict) –
        
        The API schema configuration that defines the structure of the runtime target’s API.
        
        source (dict) –
        
        Configuration for API schema.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: s3, inlinePayload. 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'}
        
        s3 (dict) –
        
        The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
        
        uri (string) –
        
        The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
        
        bucketOwnerAccountId (string) –
        
        The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
        
        inlinePayload (string) –
        
        The inline payload containing the API schema definition.
    - passthrough (dict) –
      
      The passthrough configuration for the HTTP target. A passthrough target forwards requests directly to an external HTTP endpoint.
      - endpoint (string) –
        
        The HTTPS endpoint that the gateway forwards requests to for this passthrough target.
      - protocolType (string) –
        
        The application protocol that the passthrough target implements. This value is required for passthrough targets:
        
        MCP - The Model Context Protocol.
        
        A2A - The Agent-to-Agent protocol.
        
        INFERENCE - The protocol for routing requests to a large language model (LLM) provider.
        
        CUSTOM - A custom application protocol.
      - schema (dict) –
        
        The API schema configuration that defines the structure of the passthrough target’s API.
        
        source (dict) –
        
        Configuration for API schema.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: s3, inlinePayload. 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'}
        
        s3 (dict) –
        
        The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
        
        uri (string) –
        
        The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
        
        bucketOwnerAccountId (string) –
        
        The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
        
        inlinePayload (string) –
        
        The inline payload containing the API schema definition.
      - stickinessConfiguration (dict) –
        
        The session stickiness configuration for the passthrough target. This configuration routes requests within the same session to the same target.
        
        identifier (string) –
        
        The expression that identifies where to extract the session identifier from the request (for example, $context.header.x-session-id).
        
        timeout (integer) –
        
        The session stickiness timeout, in seconds. After this duration of inactivity, the session affinity expires. Valid values range from 1 to 86400.
  - inference (dict) –
    
    The inference configuration for the target. This configuration routes requests to a large language model (LLM) provider.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: connector, provider. 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'}
    - connector (dict) –
      
      The connector-based inference configuration. Use this option to route requests to an LLM provider through a built-in connector that includes predefined provider rules.
      - source (dict) –
        
        The source configuration identifying which inference connector to use.
        
        connectorId (string) –
        
        The identifier for the inference connector (for example, bedrock-mantle, openai, or anthropic).
    - provider (dict) –
      
      The provider-based inference configuration. Use this option to explicitly configure the endpoint, model mapping, and operations for an LLM provider.
      - endpoint (string) –
        
        The HTTPS endpoint of the inference provider that the gateway forwards requests to.
      - modelMapping (dict) –
        
        The configuration that translates client-facing model IDs to the model IDs expected by the provider.
        
        providerPrefix (dict) –
        
        The provider prefix configuration used for model ID translation.
        
        strip (boolean) –
        
        Whether clients can omit the provider prefix from model IDs. If true, the gateway accepts model IDs without the prefix and restores the full prefixed form before forwarding to the provider. The default is false.
        
        separator (string) –
        
        The single character that separates the provider prefix from the model name (for example, .). The default is ..
      - operations (list) –
        
        A list of per-operation configurations that map request paths to the models supported for each operation.
        
        (dict) –
        
        The configuration for a specific inference operation, including its request path and the models that the operation supports.
        
        path (string) –
        
        The request path for this operation (for example, /v1/messages or /v1/responses).
        
        providerPath (string) –
        
        The provider path to forward requests to, if it differs from the request path. For example, /anthropic/v1/messages when the provider expects a different path than the client-facing /v1/messages.
        
        models (list) –
        
        The list of models supported for this operation.
        
        (dict) –
        
        A model entry that specifies a model supported for an inference operation.
        
        model (string) –
        
        The model ID or glob pattern that identifies the model (for example, anthropic.claude-opus-* or openai.gpt-oss-*).
- credentialProviderConfigurations (list) –
  
  The credential provider configurations for the gateway target.
  - (dict) –
    
    The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
    - credentialProviderType (string) –
      
      The type of credential provider. This field specifies which authentication method the gateway uses.
    - credentialProvider (dict) –
      
      The credential provider. This field contains the specific configuration for the credential provider type.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: oauthCredentialProvider, apiKeyCredentialProvider, iamCredentialProvider. 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'}
      - oauthCredentialProvider (dict) –
        
        The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
        
        providerArn (string) –
        
        The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
        
        scopes (list) –
        
        The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
        
        (string) –
        
        customParameters (dict) –
        
        The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
        
        (string) –
        
        (string) –
        
        grantType (string) –
        
        Specifies the kind of credentials to use for authorization:
        
        CLIENT_CREDENTIALS - Authorization with a client ID and secret.
        
        AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.
        
        TOKEN_EXCHANGE - Authorization using on-behalf-of token exchange. An inbound user token is exchanged for a downstream access token scoped to the target audience.
        
        defaultReturnUrl (string) –
        
        The URL where the end user’s browser is redirected after obtaining the authorization code. Generally points to the customer’s application.
      - apiKeyCredentialProvider (dict) –
        
        The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
        
        providerArn (string) –
        
        The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
        
        credentialParameterName (string) –
        
        The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
        
        credentialPrefix (string) –
        
        The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
        
        credentialLocation (string) –
        
        The location of the API key credential. This field specifies where in the request the API key should be placed.
      - iamCredentialProvider (dict) –
        
        The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.
        
        service (string) –
        
        The target Amazon Web Services service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.
        
        region (string) –
        
        The Amazon Web Services Region used for SigV4 signing. If not specified, defaults to the gateway’s Region.
- lastSynchronizedAt (datetime) –
  
  The last synchronization of the target.
- metadataConfiguration (dict) –
  
  The metadata configuration for HTTP header and query parameter propagation for the retrieved gateway target.
  - allowedRequestHeaders (list) –
    
    A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.
    - (string) –
  - allowedQueryParameters (list) –
    
    A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.
    - (string) –
  - allowedResponseHeaders (list) –
    
    A list of HTTP headers that are allowed to be propagated from the target response back to the client.
    - (string) –
- privateEndpoint (dict) –
  
  The private endpoint configuration for the gateway target.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: selfManagedLatticeResource, managedVpcResource. 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'}
  - selfManagedLatticeResource (dict) –
    
    Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: resourceConfigurationIdentifier. 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'}
    - resourceConfigurationIdentifier (string) –
      
      The ARN or ID of the VPC Lattice resource configuration.
  - managedVpcResource (dict) –
    
    Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
    - vpcIdentifier (string) –
      
      The ID of the VPC that contains your private resource.
    - subnetIds (list) –
      
      The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
      - (string) –
    - endpointIpAddressType (string) –
      
      The IP address type for the resource configuration endpoint.
    - securityGroupIds (list) –
      
      The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
      - (string) –
    - tags (dict) –
      
      Tags to apply to the managed VPC Lattice resource gateway.
      - (string) –
        
        (string) –
    - routingDomain (string) –
      
      An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
- privateEndpointManagedResources (list) –
  
  The managed resources created by the gateway for private endpoint connectivity.
  - (dict) –
    
    Details of a resource created and managed by the gateway for private endpoint connectivity.
    - domain (string) –
      
      The domain associated with this managed resource.
    - resourceGatewayArn (string) –
      
      The ARN of the VPC Lattice resource gateway created in your account.
    - resourceAssociationArn (string) –
      
      The ARN of the service network resource association.
- authorizationData (dict) –
  
  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.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: oauth2. 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'}
  - oauth2 (dict) –
    
    OAuth2 authorization data for the gateway target.
    - authorizationUrl (string) –
      
      The URL to initiate the authorization process. This URL is provided when the OAuth2 access token requires user authorization.
    - userId (string) –
      
      The user identifier associated with the OAuth2 authorization session that is defined by AgentCore Gateway.
- protocolType (string) –
  
  The protocol type of the gateway target.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException