DataZone / Paginator / ListDesignations

ListDesignations¶

class DataZone.Paginator.ListDesignations¶

paginator = client.get_paginator('list_designations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from DataZone.Client.list_designations().

Request Syntax

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

Parameters:

domainIdentifier (string) –
[REQUIRED]

The identifier of the Amazon DataZone domain that contains the designations to list.
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': [
        {
            'domainId': 'string',
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'designationType': 'MANAGED'|'USER_CREATED',
            'deletionProtection': True|False,
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The designation summaries that ListDesignations returned. Each item contains summary information about a designation in the domain.
  - (dict) –
    
    The summary representation of a designation returned by ListDesignations. The summary omits the Cedar permit policy. Call GetDesignation to retrieve the full designation record including the policy.
    - domainId (string) –
      
      The identifier of the Amazon DataZone domain that contains the designation.
    - id (string) –
      
      The unique ID of the designation.
    - name (string) –
      
      The name of the designation. The name is unique within the domain.
    - description (string) –
      
      A human-readable description of the designation and its intended use.
    - designationType (string) –
      
      The classification of this designation. Valid values:
      - MANAGED — System-defined designation.
      - USER_CREATED — User-created designation.
    - deletionProtection (boolean) –
      
      Specifies whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled through UpdateDesignation.
    - createdBy (string) –
      
      The identifier of the Amazon DataZone user who created the designation.
    - createdAt (datetime) –
      
      The date and time when the designation was created.
    - updatedAt (datetime) –
      
      The date and time when the designation was last updated.
- NextToken (string) –
  
  A token to resume pagination.