IoTSiteWise / Client / describe_dataset

describe_dataset#

IoTSiteWise.Client.describe_dataset(**kwargs)#

Retrieves information about a dataset.

Request Syntax

response = client.describe_dataset(
    datasetId='string'
)

Parameters:

datasetId (string) –

[REQUIRED]

The ID of the dataset.

Return type:

dict

Returns:

Response Syntax

{
    'datasetId': 'string',
    'datasetArn': 'string',
    'datasetName': 'string',
    'datasetDescription': 'string',
    'datasetSource': {
        'sourceType': 'KENDRA',
        'sourceFormat': 'KNOWLEDGE_BASE',
        'sourceDetail': {
            'kendra': {
                'knowledgeBaseArn': 'string',
                'roleArn': 'string'
            }
        }
    },
    'datasetStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    },
    'datasetCreationDate': datetime(2015, 1, 1),
    'datasetLastUpdateDate': datetime(2015, 1, 1),
    'datasetVersion': 'string'
}

Response Structure

(dict) –
- datasetId (string) –
  
  The ID of the dataset.
- datasetArn (string) –
  
  The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
- datasetName (string) –
  
  The name of the dataset.
- datasetDescription (string) –
  
  A description about the dataset, and its functionality.
- datasetSource (dict) –
  
  The data source for the dataset.
  - sourceType (string) –
    
    The type of data source for the dataset.
  - sourceFormat (string) –
    
    The format of the dataset source associated with the dataset.
  - sourceDetail (dict) –
    
    The details of the dataset source associated with the dataset.
    - kendra (dict) –
      
      Contains details about the Kendra dataset source.
      - knowledgeBaseArn (string) –
        
        The knowledgeBaseArn details for the Kendra dataset source.
      - roleArn (string) –
        
        The roleARN details for the Kendra dataset source.
- datasetStatus (dict) –
  
  The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.
  - state (string) –
    
    The current status of the dataset.
  - error (dict) –
    
    Contains the details of an IoT SiteWise error.
    - code (string) –
      
      The error code.
    - message (string) –
      
      The error message.
    - details (list) –
      
      A list of detailed errors.
      - (dict) –
        
        Contains detailed error information.
        
        code (string) –
        
        The error code.
        
        message (string) –
        
        The error message.
- datasetCreationDate (datetime) –
  
  The dataset creation date, in Unix epoch time.
- datasetLastUpdateDate (datetime) –
  
  The date the dataset was last updated, in Unix epoch time.
- datasetVersion (string) –
  
  The version of the dataset.

Exceptions

IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.ThrottlingException