DataZone / Paginator / ListDataSources

ListDataSources¶

class DataZone.Paginator.ListDataSources¶

paginator = client.get_paginator('list_data_sources')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    connectionIdentifier='string',
    domainIdentifier='string',
    environmentIdentifier='string',
    name='string',
    projectIdentifier='string',
    status='CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION',
    type='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

connectionIdentifier (string) – The ID of the connection.
domainIdentifier (string) –
[REQUIRED]

The identifier of the Amazon DataZone domain in which to list the data sources.
environmentIdentifier (string) – The identifier of the environment in which to list the data sources.
name (string) – The name of the data source.
projectIdentifier (string) –
[REQUIRED]

The identifier of the project in which to list data sources.
status (string) – The status of the data source.
type (string) – The type of the data source.
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': [
        {
            'connectionId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'dataSourceId': 'string',
            'description': 'string',
            'domainId': 'string',
            'enableSetting': 'ENABLED'|'DISABLED',
            'environmentId': 'string',
            'lastRunAssetCount': 123,
            'lastRunAt': datetime(2015, 1, 1),
            'lastRunErrorMessage': {
                'errorDetail': 'string',
                'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
            },
            'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS',
            'name': 'string',
            'schedule': {
                'schedule': 'string',
                'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC'
            },
            'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION',
            'type': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The results of the ListDataSources action.
  - (dict) –
    
    The details of the data source.
    - connectionId (string) –
      
      The connection ID that’s part of the data source summary.
    - createdAt (datetime) –
      
      The timestamp of when the data source was created.
    - dataSourceId (string) –
      
      The ID of the data source.
    - description (string) –
      
      The data source description.
    - domainId (string) –
      
      The ID of the Amazon DataZone domain in which the data source exists.
    - enableSetting (string) –
      
      Specifies whether the data source is enabled.
    - environmentId (string) –
      
      The ID of the environment in which the data source exists.
    - lastRunAssetCount (integer) –
      
      The count of the assets created during the last data source run.
    - lastRunAt (datetime) –
      
      The timestamp of when the data source run was last performed.
    - lastRunErrorMessage (dict) –
      
      The details of the error message that is returned if the operation cannot be successfully completed.
      - errorDetail (string) –
        
        The details of the error message that is returned if the operation cannot be successfully completed.
      - errorType (string) –
        
        The type of the error message that is returned if the operation cannot be successfully completed.
    - lastRunStatus (string) –
      
      The status of the last data source run.
    - name (string) –
      
      The name of the data source.
    - schedule (dict) –
      
      The details of the schedule of the data source runs.
      - schedule (string) –
        
        The schedule of the data source runs.
      - timezone (string) –
        
        The timezone of the data source run.
    - status (string) –
      
      The status of the data source.
    - type (string) –
      
      The type of the data source.
    - updatedAt (datetime) –
      
      The timestamp of when the data source was updated.
- NextToken (string) –
  
  A token to resume pagination.