Skip to content

describe_key_value_store async

describe_key_value_store(
    name: KeyValueStoreName,
    *,
    config_overrides: Optional[AsyncCloudFrontClientConfig] = None,
) -> DescribeKeyValueStoreResult

Specifies the key value store and its configuration.

Parameters:

Raises:

Examples:

To describe a KeyValueStore Use the following command to describe a KeyValueStore.

>>> await client.describe_key_value_store(name='my-keyvaluestore-name')
Source code in docs_src/capo_cloudfront/_services/async_cloud_front.py
async def describe_key_value_store(
    self,
    name: "capo_cloudfront.types.key_value_store_name.KeyValueStoreName",
    *,
    config_overrides: Optional[AsyncCloudFrontClientConfig] = None,
) -> "capo_cloudfront.types.describe_key_value_store_result.DescribeKeyValueStoreResult":
    """<p>Specifies the key value store and its configuration.</p>

    Args:
        name: <p>The name of the key value store.</p>

    Raises:
        capo_cloudfront.errors.access_denied.AccessDenied: <p>Access denied.</p>
        capo_cloudfront.errors.entity_not_found.EntityNotFound: <p>The entity was not found.</p>
        capo_cloudfront.errors.invalid_argument.InvalidArgument: <p>An argument is invalid.</p>
        capo_cloudfront.errors.unsupported_operation.UnsupportedOperation: <p>This operation is not supported in this Amazon Web Services Region.</p>
        capo_cloudfront.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe a KeyValueStore
        Use the following command to describe a KeyValueStore.

        >>> await client.describe_key_value_store(name='my-keyvaluestore-name')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudfront.types.describe_key_value_store_request.DescribeKeyValueStoreRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudfront.types.describe_key_value_store_result.DescribeKeyValueStoreResult"
    ]:
        import capo_cloudfront._operations.cloudfront2020_05_31.describe_key_value_store

        (
            output,
            http_response,
        ) = await capo_cloudfront._operations.cloudfront2020_05_31.describe_key_value_store.async_describe_key_value_store(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeKeyValueStore")
    )
    input_: capo_cloudfront.types.describe_key_value_store_request.DescribeKeyValueStoreRequest = {
        "name": name
    }

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