CloudFrontKeyValueStoreClient

Index > CloudFrontKeyValueStore > CloudFrontKeyValueStoreClient

Auto-generated documentation for CloudFrontKeyValueStore type annotations stubs module mypy-boto3-cloudfront-keyvaluestore.

CloudFrontKeyValueStoreClient

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore"). boto3 documentation

# CloudFrontKeyValueStoreClient usage example

from boto3.session import Session
from mypy_boto3_cloudfront_keyvaluestore.client import CloudFrontKeyValueStoreClient

def get_cloudfront-keyvaluestore_client() -> CloudFrontKeyValueStoreClient:
    return Session().client("cloudfront-keyvaluestore")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("cloudfront-keyvaluestore").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("cloudfront-keyvaluestore")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_cloudfront_keyvaluestore.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

delete_key

Deletes the key value pair specified by the key.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").delete_key method. boto3 documentation

# delete_key method definition

def delete_key(
    self,
    *,
    KvsARN: str,
    Key: str,
    IfMatch: str,
) -> DeleteKeyResponseTypeDef:  # (1)
    ...

1. See DeleteKeyResponseTypeDef

# delete_key method usage example with argument unpacking

kwargs: DeleteKeyRequestRequestTypeDef = {  # (1)
    "KvsARN": ...,
    "Key": ...,
    "IfMatch": ...,
}

parent.delete_key(**kwargs)

1. See DeleteKeyRequestRequestTypeDef

describe_key_value_store

Returns metadata information about Key Value Store.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").describe_key_value_store method. boto3 documentation

# describe_key_value_store method definition

def describe_key_value_store(
    self,
    *,
    KvsARN: str,
) -> DescribeKeyValueStoreResponseTypeDef:  # (1)
    ...

1. See DescribeKeyValueStoreResponseTypeDef

# describe_key_value_store method usage example with argument unpacking

kwargs: DescribeKeyValueStoreRequestRequestTypeDef = {  # (1)
    "KvsARN": ...,
}

parent.describe_key_value_store(**kwargs)

1. See DescribeKeyValueStoreRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_key

Returns a key value pair.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").get_key method. boto3 documentation

# get_key method definition

def get_key(
    self,
    *,
    KvsARN: str,
    Key: str,
) -> GetKeyResponseTypeDef:  # (1)
    ...

1. See GetKeyResponseTypeDef

# get_key method usage example with argument unpacking

kwargs: GetKeyRequestRequestTypeDef = {  # (1)
    "KvsARN": ...,
    "Key": ...,
}

parent.get_key(**kwargs)

1. See GetKeyRequestRequestTypeDef

list_keys

Returns a list of key value pairs.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").list_keys method. boto3 documentation

# list_keys method definition

def list_keys(
    self,
    *,
    KvsARN: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListKeysResponseTypeDef:  # (1)
    ...

1. See ListKeysResponseTypeDef

# list_keys method usage example with argument unpacking

kwargs: ListKeysRequestRequestTypeDef = {  # (1)
    "KvsARN": ...,
}

parent.list_keys(**kwargs)

1. See ListKeysRequestRequestTypeDef

put_key

Creates a new key value pair or replaces the value of an existing key.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").put_key method. boto3 documentation

# put_key method definition

def put_key(
    self,
    *,
    Key: str,
    Value: str,
    KvsARN: str,
    IfMatch: str,
) -> PutKeyResponseTypeDef:  # (1)
    ...

1. See PutKeyResponseTypeDef

# put_key method usage example with argument unpacking

kwargs: PutKeyRequestRequestTypeDef = {  # (1)
    "Key": ...,
    "Value": ...,
    "KvsARN": ...,
    "IfMatch": ...,
}

parent.put_key(**kwargs)

1. See PutKeyRequestRequestTypeDef

update_keys

Puts or Deletes multiple key value pairs in a single, all-or-nothing operation.

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").update_keys method. boto3 documentation

# update_keys method definition

def update_keys(
    self,
    *,
    KvsARN: str,
    IfMatch: str,
    Puts: Sequence[PutKeyRequestListItemTypeDef] = ...,  # (1)
    Deletes: Sequence[DeleteKeyRequestListItemTypeDef] = ...,  # (2)
) -> UpdateKeysResponseTypeDef:  # (3)
    ...

1. See PutKeyRequestListItemTypeDef
2. See DeleteKeyRequestListItemTypeDef
3. See UpdateKeysResponseTypeDef

# update_keys method usage example with argument unpacking

kwargs: UpdateKeysRequestRequestTypeDef = {  # (1)
    "KvsARN": ...,
    "IfMatch": ...,
}

parent.update_keys(**kwargs)

1. See UpdateKeysRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("cloudfront-keyvaluestore").get_paginator method with overloads.

• client.get_paginator("list_keys") -> ListKeysPaginator