BedrockAgentCoreControl / Client / list_capacity_providers

list_capacity_providers¶

BedrockAgentCoreControl.Client.list_capacity_providers(**kwargs)¶

Lists the capacity providers in your account and returns summary information for each one. To retrieve the full configuration for a specific capacity provider, use GetCapacityProvider. Results are paginated; use the nextToken parameter to retrieve additional results.

Request Syntax

response = client.list_capacity_providers(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'capacityProviders': [
        {
            'capacityProviderId': 'string',
            'capacityProviderArn': 'string',
            'name': 'string',
            'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- capacityProviders (list) –
  
  The list of capacity provider summaries.
  - (dict) –
    
    A summary of a capacity provider, as returned by ListCapacityProviders. Each summary includes the capacity provider identifier, Amazon Resource Name (ARN), name, status, and last-updated timestamp.
    - capacityProviderId (string) –
      
      The unique identifier of the capacity provider.
    - capacityProviderArn (string) –
      
      The Amazon Resource Name (ARN) of the capacity provider.
    - name (string) –
      
      The name of the capacity provider.
    - status (string) –
      
      The current status of the capacity provider. For possible values, see CapacityProviderStatus.
    - lastUpdatedAt (datetime) –
      
      The timestamp when the capacity provider was last updated.
- nextToken (string) –
  
  If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException