DataZone / Client / list_data_sources

list_data_sources#

DataZone.Client.list_data_sources(**kwargs)#

Lists data sources in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.list_data_sources(
    domainIdentifier='string',
    environmentIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    projectIdentifier='string',
    status='CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION',
    type='string'
)
Parameters:

  • 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.

  • maxResults (integer) – The maximum number of data sources to return in a single call to ListDataSources. When the number of data sources to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSources to list the next set of data sources.

  • name (string) – The name of the data source.

  • nextToken (string) – When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'dataSourceId': '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.

        • createdAt (datetime) –

          The timestamp of when the data source was created.

        • dataSourceId (string) –

          The ID of the data source.

        • 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) –

      When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

Exceptions