DataExchange / Client / list_data_sets

list_data_sets#

DataExchange.Client.list_data_sets(**kwargs)#

This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.

See also: AWS API Documentation

Request Syntax

response = client.list_data_sets(
    MaxResults=123,
    NextToken='string',
    Origin='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of results returned by a single call.

  • NextToken (string) – The token value retrieved from a previous call to access the next page of results.

  • Origin (string) – A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

Return type:

dict

Returns:

Response Syntax

{
    'DataSets': [
        {
            'Arn': 'string',
            'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API'|'S3_DATA_ACCESS'|'LAKE_FORMATION_DATA_PERMISSION',
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'Id': 'string',
            'Name': 'string',
            'Origin': 'OWNED'|'ENTITLED',
            'OriginDetails': {
                'ProductId': 'string'
            },
            'SourceId': 'string',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DataSets (list) –

      The data set objects listed by the request.

      • (dict) –

        A data set is an AWS resource with one or more revisions.

        • Arn (string) –

          The ARN for the data set.

        • AssetType (string) –

          The type of asset that is added to a data set.

        • CreatedAt (datetime) –

          The date and time that the data set was created, in ISO 8601 format.

        • Description (string) –

          The description for the data set.

        • Id (string) –

          The unique identifier for the data set.

        • Name (string) –

          The name of the data set.

        • Origin (string) –

          A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

        • OriginDetails (dict) –

          If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

          • ProductId (string) –

            The product ID of the origin of the data set.

        • SourceId (string) –

          The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

        • UpdatedAt (datetime) –

          The date and time that the data set was last updated, in ISO 8601 format.

    • NextToken (string) –

      The token value retrieved from a previous call to access the next page of results.

Exceptions

  • DataExchange.Client.exceptions.ResourceNotFoundException

  • DataExchange.Client.exceptions.ThrottlingException

  • DataExchange.Client.exceptions.ValidationException

  • DataExchange.Client.exceptions.InternalServerException