BedrockAgentCoreControl / Client / update_api_key_credential_provider

update_api_key_credential_provider

BedrockAgentCoreControl.Client.update_api_key_credential_provider(**kwargs)

Updates an existing API key credential provider.

See also: AWS API Documentation

Request Syntax

response = client.update_api_key_credential_provider(
    name='string',
    apiKey='string'
)

Parameters:

• name (string) –

  [REQUIRED]

  The name of the API key credential provider to update.

• apiKey (string) –

  [REQUIRED]

  The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

Return type:

dict

Returns:

Response Syntax

{
    'apiKeySecretArn': {
        'secretArn': 'string'
    },
    'name': 'string',
    'credentialProviderArn': 'string',
    'createdTime': datetime(2015, 1, 1),
    'lastUpdatedTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • apiKeySecretArn (dict) –

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

    • secretArn (string) –

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

  • name (string) –

    The name of the API key credential provider.

  • credentialProviderArn (string) –

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

  • createdTime (datetime) –

    The timestamp when the API key credential provider was created.

  • lastUpdatedTime (datetime) –

    The timestamp when the API key credential provider was last updated.

Exceptions

• BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException

• BedrockAgentCoreControl.Client.exceptions.UnauthorizedException

• BedrockAgentCoreControl.Client.exceptions.ValidationException

• BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

• BedrockAgentCoreControl.Client.exceptions.ConflictException

• BedrockAgentCoreControl.Client.exceptions.DecryptionFailure

• BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException

• BedrockAgentCoreControl.Client.exceptions.ThrottlingException

• BedrockAgentCoreControl.Client.exceptions.InternalServerException

• BedrockAgentCoreControl.Client.exceptions.EncryptionFailure