

# DatasetSummary


The summary details for the dataset.

## Contents


 ** arn **   <a name="iotsitewise-Type-DatasetSummary-arn"></a>
The [ARN](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) of the dataset. The format is `arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$`   
Required: Yes

 ** creationDate **   <a name="iotsitewise-Type-DatasetSummary-creationDate"></a>
The dataset creation date, in Unix epoch time.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="iotsitewise-Type-DatasetSummary-description"></a>
A description about the dataset, and its functionality.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: Yes

 ** id **   <a name="iotsitewise-Type-DatasetSummary-id"></a>
The ID of the dataset.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`   
Required: Yes

 ** lastUpdateDate **   <a name="iotsitewise-Type-DatasetSummary-lastUpdateDate"></a>
The date the dataset was last updated, in Unix epoch time.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="iotsitewise-Type-DatasetSummary-name"></a>
The name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9 _\-#$*!@]+$`   
Required: Yes

 ** status **   <a name="iotsitewise-Type-DatasetSummary-status"></a>
The status of the dataset. This contains the state and any error messages. The state is `ACTIVE` when ready to use.  
Type: [DatasetStatus](API_DatasetStatus.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotsitewise-2019-12-02/DatasetSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DatasetSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotsitewise-2019-12-02/DatasetSummary) 