LookoutEquipment / Client / create_dataset

create_dataset#

LookoutEquipment.Client.create_dataset(**kwargs)#

Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. In other words, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data.

See also: AWS API Documentation

Request Syntax

response = client.create_dataset(
    DatasetName='string',
    DatasetSchema={
        'InlineDataSchema': 'string'
    },
    ServerSideKmsKeyId='string',
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • DatasetName (string) –

    [REQUIRED]

    The name of the dataset being created.

  • DatasetSchema (dict) –

    A JSON description of the data that is in each time series dataset, including names, column names, and data types.

    • InlineDataSchema (string) –

  • ServerSideKmsKeyId (string) – Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

  • ClientToken (string) –

    [REQUIRED]

    A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

    This field is autopopulated if not provided.

  • Tags (list) –

    Any tags associated with the ingested data described in the dataset.

    • (dict) –

      A tag is a key-value pair that can be added to a resource as metadata.

      • Key (string) – [REQUIRED]

        The key for the specified tag.

      • Value (string) – [REQUIRED]

        The value for the specified tag.

Return type:

dict

Returns:

Response Syntax

{
    'DatasetName': 'string',
    'DatasetArn': 'string',
    'Status': 'CREATED'|'INGESTION_IN_PROGRESS'|'ACTIVE'
}

Response Structure

  • (dict) –

    • DatasetName (string) –

      The name of the dataset being created.

    • DatasetArn (string) –

      The Amazon Resource Name (ARN) of the dataset being created.

    • Status (string) –

      Indicates the status of the CreateDataset operation.

Exceptions

  • LookoutEquipment.Client.exceptions.ValidationException

  • LookoutEquipment.Client.exceptions.ConflictException

  • LookoutEquipment.Client.exceptions.ThrottlingException

  • LookoutEquipment.Client.exceptions.ServiceQuotaExceededException

  • LookoutEquipment.Client.exceptions.AccessDeniedException

  • LookoutEquipment.Client.exceptions.InternalServerException