SupplyChain / Paginator / ListDataLakeDatasets

ListDataLakeDatasets#

class SupplyChain.Paginator.ListDataLakeDatasets#

paginator = client.get_paginator('list_data_lake_datasets')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from SupplyChain.Client.list_data_lake_datasets().

Request Syntax

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

Parameters:

instanceId (string) –
[REQUIRED]

The Amazon Web Services Supply Chain instance identifier.
namespace (string) –
[REQUIRED]

The namespace of the dataset. The available values are:
- asc: for AWS Supply Chain supported datasets.
- default: for datasets with custom user-defined schemas.
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

{
    'datasets': [
        {
            'instanceId': 'string',
            'namespace': 'string',
            'name': 'string',
            'arn': 'string',
            'schema': {
                'name': 'string',
                'fields': [
                    {
                        'name': 'string',
                        'type': 'INT'|'DOUBLE'|'STRING'|'TIMESTAMP',
                        'isRequired': True|False
                    },
                ]
            },
            'description': 'string',
            'createdTime': datetime(2015, 1, 1),
            'lastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

The response parameters of ListDataLakeDatasets.
- datasets (list) –
  
  The list of fetched dataset details.
  - (dict) –
    
    The data lake dataset details.
    - instanceId (string) –
      
      The Amazon Web Services Supply Chain instance identifier.
    - namespace (string) –
      
      The name space of the dataset. The available values are:
      - asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
      - default - For datasets with custom user-defined schemas.
    - name (string) –
      
      The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
    - arn (string) –
      
      The arn of the dataset.
    - schema (dict) –
      
      The schema of the dataset.
      - name (string) –
        
        The name of the dataset schema.
      - fields (list) –
        
        The list of field details of the dataset schema.
        
        (dict) –
        
        The dataset field details.
        
        name (string) –
        
        The dataset field name.
        
        type (string) –
        
        The dataset field type.
        
        isRequired (boolean) –
        
        Indicate if the field is required or not.
    - description (string) –
      
      The description of the dataset.
    - createdTime (datetime) –
      
      The creation time of the dataset.
    - lastModifiedTime (datetime) –
      
      The last modified time of the dataset.
- NextToken (string) –
  
  A token to resume pagination.