CloudWatch / Client / get_dataset

get_dataset

CloudWatch.Client.get_dataset(**kwargs)

Returns information about the specified dataset. This includes its identifier, Amazon Resource Name (ARN), and any customer managed Amazon Web Services Key Management Service (Amazon Web Services KMS) key that is currently associated with it.

Only the default dataset is supported. The default dataset is implicit for every account in every Region — you can call GetDataset for it without first creating it. If no customer managed KMS key has been associated with the dataset, the response omits the KmsKeyArn field, indicating that data is encrypted at rest using an Amazon Web Services owned key managed by Amazon CloudWatch.

To associate a customer managed KMS key with a dataset, use AssociateDatasetKmsKey. To remove the association, use DisassociateDatasetKmsKey.

See also: AWS API Documentation

Request Syntax

response = client.get_dataset(
    DatasetIdentifier='string'
)
Parameters:

DatasetIdentifier (string) –

[REQUIRED]

Specifies the identifier of the dataset to retrieve. For the default dataset, you can specify either default or the full dataset Amazon Resource Name (ARN) in the format arn:aws:cloudwatch:Region:account-id:dataset/default.

Return type:

dict

Returns:

Response Syntax

{
    'DatasetId': 'string',
    'Arn': 'string',
    'KmsKeyArn': 'string'
}

Response Structure

  • (dict) –

    • DatasetId (string) –

      Returns the identifier of the dataset.

    • Arn (string) –

      Returns the Amazon Resource Name (ARN) of the dataset, in the format ``arn:aws:cloudwatch:Region:account-id:dataset/dataset-id ``.

    • KmsKeyArn (string) –

      Returns the Amazon Resource Name (ARN) of the customer managed Amazon Web Services KMS key that is currently associated with the dataset, if any. If the dataset is not associated with a customer managed KMS key, this field is not included in the response and the dataset is encrypted at rest using an Amazon Web Services owned key.

Exceptions