get_dataset `async` ¶

get_dataset(
    *,
    config_overrides: Optional[AsyncCloudWatchClientConfig] = None,
    dataset_identifier: Optional[DatasetIdentifier] = None,
) -> GetDatasetOutput

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.

Parameters:

dataset_identifier (Optional[DatasetIdentifier], default: None ) –

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.

Raises:

ResourceNotFoundException –

The named resource does not exist.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_cloudwatch/_services/async_cloud_watch.py

async def get_dataset(
    self,
    *,
    config_overrides: Optional[AsyncCloudWatchClientConfig] = None,
    dataset_identifier: Optional[
        "capo_cloudwatch.types.dataset_identifier.DatasetIdentifier"
    ] = None,
) -> "capo_cloudwatch.types.get_dataset_output.GetDatasetOutput":
    """<p>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.</p> <p>Only the <code>default</code> dataset is supported. The <code>default</code> dataset is implicit for every account in every Region — you can call <code>GetDataset</code> for it without first creating it. If no customer managed KMS key has been associated with the dataset, the response omits the <code>KmsKeyArn</code> field, indicating that data is encrypted at rest using an Amazon Web Services owned key managed by Amazon CloudWatch.</p> <p>To associate a customer managed KMS key with a dataset, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AssociateDatasetKmsKey.html">AssociateDatasetKmsKey</a>. To remove the association, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DisassociateDatasetKmsKey.html">DisassociateDatasetKmsKey</a>.</p>

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

    Raises:
        capo_cloudwatch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The named resource does not exist.</p>
        capo_cloudwatch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatch.types.get_dataset_input.GetDatasetInput]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatch.types.get_dataset_output.GetDatasetOutput"
    ]:
        import capo_cloudwatch._operations.granite_service_version20100801.get_dataset

        (
            output,
            http_response,
        ) = await capo_cloudwatch._operations.granite_service_version20100801.get_dataset.async_get_dataset(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDataset")
    )
    input_: capo_cloudwatch.types.get_dataset_input.GetDatasetInput = {}
    if dataset_identifier is not None:
        input_["dataset_identifier"] = dataset_identifier

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_dataset async ¶

get_dataset `async` ¶