BedrockAgentCoreControl / Client / list_registries

list_registries¶

BedrockAgentCoreControl.Client.list_registries(**kwargs)¶

Lists all registries in the account. You can optionally filter results by status using the status parameter.

Request Syntax

response = client.list_registries(
    maxResults=123,
    nextToken='string',
    status='CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
)

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.
status (string) – Filter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

Return type:

dict

Returns:

Response Syntax

{
    'registries': [
        {
            'name': 'string',
            'description': 'string',
            'registryId': 'string',
            'registryArn': 'string',
            'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
            'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
            'statusReason': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- registries (list) –
  
  The list of registry summaries. For details about the fields in each summary, see the RegistrySummary data type.
  - (dict) –
    
    Contains summary information about a registry.
    - name (string) –
      
      The name of the registry.
    - description (string) –
      
      The description of the registry.
    - registryId (string) –
      
      The unique identifier of the registry.
    - registryArn (string) –
      
      The Amazon Resource Name (ARN) of the registry.
    - authorizerType (string) –
      
      The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.
      - CUSTOM_JWT - Authorize with a bearer token.
      - AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
    - status (string) –
      
      The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.
    - statusReason (string) –
      
      The reason for the current status, typically set when the status is a failure state.
    - createdAt (datetime) –
      
      The timestamp when the registry was created.
    - updatedAt (datetime) –
      
      The timestamp when the registry 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.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException