CloudWatchOmni / Paginator / ListAccessProfiles

ListAccessProfiles¶

class CloudWatchOmni.Paginator.ListAccessProfiles¶

paginator = client.get_paginator('list_access_profiles')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CloudWatchOmni.Client.list_access_profiles().

Request Syntax

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

Parameters:

spaceId (string) –
[REQUIRED]

The unique ID of the space.
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

{
    'items': [
        {
            'profileId': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'profileType': 'SERVICE_MANAGED'|'CUSTOMER_MANAGED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The list of access profile summaries.
  - (dict) –
    
    Summary of an access profile. Call GetAccessProfile for the full profile.
    - profileId (string) –
      
      The unique ID of the access profile.
    - arn (string) –
      
      The ARN of this access profile.
    - name (string) –
      
      A name that identifies the access profile.
    - description (string) –
      
      An optional description of the access profile.
    - profileType (string) –
      
      Who manages the access profile.
- NextToken (string) –
  
  A token to resume pagination.