:doc:`LookoutEquipment <../../lookoutequipment>` / Client / create_dataset

**************
create_dataset
**************



.. py:method:: 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. For example, 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 <https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateDataset>`_  


  **Request Syntax**
  ::

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

    The name of the dataset being created.

    

  
  :type DatasetSchema: dict
  :param DatasetSchema: 

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

    

  
    - **InlineDataSchema** *(string) --* 

      The data schema used within the given dataset.

      

    
  
  :type ServerSideKmsKeyId: string
  :param ServerSideKmsKeyId: 

    Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

    

  
  :type ClientToken: string
  :param ClientToken: **[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.

  
  :type Tags: list
  :param Tags: 

    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.

        

      
    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'DatasetName': 'string',
          'DatasetArn': 'string',
          'Status': 'CREATED'|'INGESTION_IN_PROGRESS'|'ACTIVE'|'IMPORT_IN_PROGRESS'
      }
      
    **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**
  
  *   :py:class:`LookoutEquipment.Client.exceptions.ValidationException`

  
  *   :py:class:`LookoutEquipment.Client.exceptions.ConflictException`

  
  *   :py:class:`LookoutEquipment.Client.exceptions.ThrottlingException`

  
  *   :py:class:`LookoutEquipment.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`LookoutEquipment.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`LookoutEquipment.Client.exceptions.InternalServerException`

  