BedrockAgentCoreControl / Client / get_api_key_credential_provider

get_api_key_credential_provider¶

BedrockAgentCoreControl.Client.get_api_key_credential_provider(**kwargs)¶

Retrieves information about an API key credential provider.

Request Syntax

response = client.get_api_key_credential_provider(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The name of the API key credential provider to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'apiKeySecretArn': {
        'secretArn': 'string'
    },
    'apiKeySecretJsonKey': 'string',
    'apiKeySecretSource': 'MANAGED'|'EXTERNAL',
    '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 Amazon Web Services Secrets Manager.
  - secretArn (string) –
    
    The Amazon Resource Name (ARN) of the secret in Amazon Web Services Secrets Manager.
- apiKeySecretJsonKey (string) –
  
  The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.
- apiKeySecretSource (string) –
  
  The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services 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.UnauthorizedException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.DecryptionFailure
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException