BedrockAgentCoreControl / Client / create_api_key_credential_provider

create_api_key_credential_provider

BedrockAgentCoreControl.Client.create_api_key_credential_provider(**kwargs)

Creates a new API key credential provider.

See also: AWS API Documentation

Request Syntax

response = client.create_api_key_credential_provider(
    name='string',
    apiKey='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• name (string) –

  [REQUIRED]

  The name of the API key credential provider. The name must be unique within your account.

• apiKey (string) –

  [REQUIRED]

  The API key to use for authentication. This value is encrypted and stored securely.

• tags (dict) –

  A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'apiKeySecretArn': {
        'secretArn': 'string'
    },
    'name': 'string',
    'credentialProviderArn': 'string'
}

Response Structure

• (dict) –

  • apiKeySecretArn (dict) –

    The Amazon Resource Name (ARN) of the secret containing the API key.

    • secretArn (string) –

      The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.

  • name (string) –

    The name of the created API key credential provider.

  • credentialProviderArn (string) –

    The Amazon Resource Name (ARN) of the created API key credential provider.

Exceptions

• BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException

• BedrockAgentCoreControl.Client.exceptions.UnauthorizedException

• BedrockAgentCoreControl.Client.exceptions.ResourceLimitExceededException

• BedrockAgentCoreControl.Client.exceptions.ValidationException

• BedrockAgentCoreControl.Client.exceptions.ConflictException

• BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

• BedrockAgentCoreControl.Client.exceptions.DecryptionFailure

• BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException

• BedrockAgentCoreControl.Client.exceptions.ThrottlingException

• BedrockAgentCoreControl.Client.exceptions.InternalServerException

• BedrockAgentCoreControl.Client.exceptions.EncryptionFailure