BedrockAgentCoreControl / Paginator / ListConsentPortals

ListConsentPortals¶

class BedrockAgentCoreControl.Paginator.ListConsentPortals¶

paginator = client.get_paginator('list_consent_portals')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'consentPortals': [
        {
            'sources': [
                {
                    'identifier': 'string',
                    'type': 'agentcore-gateway'
                },
            ],
            'consentPortalArn': 'string',
            'consentPortalId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'name': 'string',
            'portalUrl': 'string',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'FAILED',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- consentPortals (list) –
  
  The list of consent portals.
  - (dict) –
    
    Summary information about a consent portal.
    - sources (list) –
      
      The resources served by the consent portal.
      - (dict) –
        
        A resource served by the consent portal.
        
        identifier (string) –
        
        The identifier of the source resource. For an agentcore-gateway source, this is the gateway ID or its Amazon Resource Name (ARN).
        
        type (string) –
        
        The type of the source resource.
    - consentPortalArn (string) –
      
      The Amazon Resource Name (ARN) of the consent portal.
    - consentPortalId (string) –
      
      The unique identifier of the consent portal.
    - createdAt (datetime) –
      
      The timestamp for when the consent portal was created.
    - description (string) –
      
      The description of the consent portal.
    - name (string) –
      
      The name of the consent portal.
    - portalUrl (string) –
      
      The URL used to access the consent portal.
    - status (string) –
      
      The current status of the consent portal.
    - updatedAt (datetime) –
      
      The timestamp for when the consent portal was last updated.
- NextToken (string) –
  
  A token to resume pagination.