SupplyChain / Client / list_data_lake_datasets

list_data_lake_datasets#

SupplyChain.Client.list_data_lake_datasets(**kwargs)#

Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.

Request Syntax

response = client.list_data_lake_datasets(
    instanceId='string',
    namespace='string',
    nextToken='string',
    maxResults=123
)

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.
nextToken (string) – The pagination token to fetch next page of datasets.
maxResults (integer) – The max number of datasets to fetch in this paginated request.

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) –
  
  The pagination token to fetch next page of datasets.

Exceptions

SupplyChain.Client.exceptions.ServiceQuotaExceededException
SupplyChain.Client.exceptions.ResourceNotFoundException
SupplyChain.Client.exceptions.ThrottlingException
SupplyChain.Client.exceptions.AccessDeniedException
SupplyChain.Client.exceptions.ValidationException
SupplyChain.Client.exceptions.InternalServerException
SupplyChain.Client.exceptions.ConflictException