SupplyChain / Client / create_data_lake_dataset

create_data_lake_dataset#

SupplyChain.Client.create_data_lake_dataset(**kwargs)#

Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name.

See also: AWS API Documentation

Request Syntax

response = client.create_data_lake_dataset(
    instanceId='string',
    namespace='string',
    name='string',
    schema={
        'name': 'string',
        'fields': [
            {
                'name': 'string',
                'type': 'INT'|'DOUBLE'|'STRING'|'TIMESTAMP',
                'isRequired': True|False
            },
        ]
    },
    description='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • instanceId (string) –

    [REQUIRED]

    The Amazon Web Services Supply Chain instance identifier.

  • namespace (string) –

    [REQUIRED]

    The name space of the dataset.

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

  • schema (dict) –

    The custom schema of the data lake dataset and is only required when the name space is default.

    • name (string) – [REQUIRED]

      The name of the dataset schema.

    • fields (list) – [REQUIRED]

      The list of field details of the dataset schema.

      • (dict) –

        The dataset field details.

        • name (string) – [REQUIRED]

          The dataset field name.

        • type (string) – [REQUIRED]

          The dataset field type.

        • isRequired (boolean) – [REQUIRED]

          Indicate if the field is required or not.

  • description (string) – The description of the dataset.

  • tags (dict) –

    The tags of the dataset.

    • (string) –

      • (string) –

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 of CreateDataLakeDataset.

    • dataset (dict) –

      The detail of created dataset.

      • instanceId (string) –

        The Amazon Web Services Supply Chain instance identifier.

      • namespace (string) –

        The name space of the dataset. The available values are:

      • 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