BedrockAgentCoreControl / Paginator / ListRegistries

ListRegistries¶

class BedrockAgentCoreControl.Paginator.ListRegistries¶

paginator = client.get_paginator('list_registries')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from BedrockAgentCoreControl.Client.list_registries().

Request Syntax

response_iterator = paginator.paginate(
    status='CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

status (string) – Filter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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) –
  
  A token to resume pagination.