Skip to content

describe_key_value_store async

describe_key_value_store(
    kvs_arn: KvsARN,
    *,
    config_overrides: Optional[AsyncCloudFrontKeyValueStoreClientConfig] = None,
) -> DescribeKeyValueStoreResponse

Returns metadata information about Key Value Store.

Parameters:

  • kvs_arn (KvsARN) –

    The Amazon Resource Name (ARN) of the Key Value Store.

Raises:

Examples:

Describe the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'

>>> await client.describe_key_value_store(kvs_arn='arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58')
Describe the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-1234a9d35678'
>>> await client.describe_key_value_store(kvs_arn='arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-1234a9d35678')
Source code in docs_src/capo_cloudfront_keyvaluestore/_services/async_cloud_front_key_value_store.py
async def describe_key_value_store(
    self,
    kvs_arn: "capo_cloudfront_keyvaluestore.types.kvs_arn.KvsARN",
    *,
    config_overrides: Optional[AsyncCloudFrontKeyValueStoreClientConfig] = None,
) -> "capo_cloudfront_keyvaluestore.types.describe_key_value_store_response.DescribeKeyValueStoreResponse":
    """<p>Returns metadata information about Key Value Store.</p>

    Args:
        kvs_arn: <p>The Amazon Resource Name (ARN) of the Key Value Store.</p>

    Raises:
        capo_cloudfront_keyvaluestore.errors.access_denied_exception.AccessDeniedException: <p>Access denied.</p>
        capo_cloudfront_keyvaluestore.errors.conflict_exception.ConflictException: <p>Resource is not in expected state.</p>
        capo_cloudfront_keyvaluestore.errors.internal_server_exception.InternalServerException: <p>Internal server error.</p>
        capo_cloudfront_keyvaluestore.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource was not found.</p>
        capo_cloudfront_keyvaluestore.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Describe the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58'

        >>> await client.describe_key_value_store(kvs_arn='arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-26b9a9d31b58')
        Describe the key value store with ARN 'arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-1234a9d35678'

        >>> await client.describe_key_value_store(kvs_arn='arn:aws:cloudfront::123456789012:key-value-store/327284aa-bcd5-499f-a3ff-1234a9d35678')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudfront_keyvaluestore.types.describe_key_value_store_request.DescribeKeyValueStoreRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudfront_keyvaluestore.types.describe_key_value_store_response.DescribeKeyValueStoreResponse"
    ]:
        import capo_cloudfront_keyvaluestore._operations.cloud_front_key_value_store.describe_key_value_store

        (
            output,
            http_response,
        ) = await capo_cloudfront_keyvaluestore._operations.cloud_front_key_value_store.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_keyvaluestore.types.describe_key_value_store_request.DescribeKeyValueStoreRequest = {
        "kvs_arn": kvs_arn
    }

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