Skip to content

Returns information about the specified dataset

Description

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 get_dataset 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 associate_dataset_kms_key. To remove the association, use disassociate_dataset_kms_key.

Usage

cloudwatch_get_dataset(DatasetIdentifier)

Arguments

  • DatasetIdentifier

    [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.

Value

A list with the following syntax:

list(
  DatasetId = "string",
  Arn = "string",
  KmsKeyArn = "string"
)

Request syntax

svc$get_dataset(
  DatasetIdentifier = "string"
)