BedrockAgentCoreControl / Client / update_capacity_provider

update_capacity_provider¶

BedrockAgentCoreControl.Client.update_capacity_provider(**kwargs)¶

Updates a capacity provider. Only the description can be changed. To change other configuration, such as instance types, networking, or storage, create a new capacity provider.

Request Syntax

response = client.update_capacity_provider(
    capacityProviderId='string',
    description={
        'optionalValue': 'string'
    },
    clientToken='string'
)

Parameters:

capacityProviderId (string) –
[REQUIRED]

The unique identifier of the capacity provider to update.
description (dict) –
The updated description of the capacity provider.
- optionalValue (string) –
  
  Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource.
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',
    'capacityProviderArn': 'string',
    'name': 'string',
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- 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.
- createdAt (datetime) –
  
  The timestamp when the capacity provider was created.
- lastUpdatedAt (datetime) –
  
  The timestamp when the capacity provider was last updated.

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