SupplyChain / Client / get_data_lake_dataset

get_data_lake_dataset

SupplyChain.Client.get_data_lake_dataset(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_data_lake_dataset(
    instanceId='string',
    namespace='string',
    name='string'
)

Parameters:

• instanceId (string) –

  [REQUIRED]

  The Amazon Web Services Supply Chain instance identifier.

• namespace (string) –

  [REQUIRED]

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

  [REQUIRED]

  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.

Return type:

dict

Returns:

Response Syntax

{
    'dataset': {
        '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)
    }
}

Response Structure

• (dict) –

  The response parameters for UpdateDataLakeDataset.

  • dataset (dict) –

    The fetched 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.

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