Skip to content

Bedrock AgentCore Control  >  Structures  >  GatewayApiKeyCredentialProvider

GatewayApiKeyCredentialProvider

Structure Class

GatewayApiKeyCredentialProvider dataclass

An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.

Attributes

credential_location class-attribute instance-attribute 
credential_location: ApiKeyCredentialLocation | None = None

The location of the API key credential. This field specifies where in the request the API key should be placed.

credential_parameter_name class-attribute instance-attribute 
credential_parameter_name: str | None = None

The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

credential_prefix class-attribute instance-attribute 
credential_prefix: str | None = None

The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

provider_arn instance-attribute 
provider_arn: str

The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.