BedrockAgentCoreControl / Client / delete_capacity_provider

delete_capacity_provider

BedrockAgentCoreControl.Client.delete_capacity_provider(**kwargs)

Deletes a capacity provider. Before you delete a capacity provider, disassociate all agent runtimes and runtime versions that reference it. If any references remain, the operation fails.

See also: AWS API Documentation

Request Syntax

response = client.delete_capacity_provider(
    capacityProviderId='string',
    clientToken='string'
)

Parameters:

• capacityProviderId (string) –

  [REQUIRED]

  The unique identifier of the capacity provider to delete.

• clientToken (string) –

  A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'capacityProviderId': 'string',
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED'
}

Response Structure

• (dict) –

  • capacityProviderId (string) –

    The unique identifier of the deleted capacity provider.

  • status (string) –

    The current status of the capacity provider. For possible values, see CapacityProviderStatus.

Exceptions

• BedrockAgentCoreControl.Client.exceptions.RetryableConflictException

• BedrockAgentCoreControl.Client.exceptions.ValidationException

• BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

• BedrockAgentCoreControl.Client.exceptions.ConflictException

• BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException

• BedrockAgentCoreControl.Client.exceptions.ThrottlingException

• BedrockAgentCoreControl.Client.exceptions.InternalServerException