CloudFrontKeyValueStore *********************** Client ====== class CloudFrontKeyValueStore.Client A low-level client representing Amazon CloudFront KeyValueStore Amazon CloudFront KeyValueStore Service to View and Update Data in a KVS Resource import boto3 client = boto3.client('cloudfront-keyvaluestore') These are the available methods: * can_paginate * close * delete_key * describe_key_value_store * get_key * get_paginator * get_waiter * list_keys * put_key * update_keys Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListKeys CloudFrontKeyValueStore / Paginator / ListKeys ListKeys ******** class CloudFrontKeyValueStore.Paginator.ListKeys paginator = client.get_paginator('list_keys') paginate(**kwargs) Creates an iterator that will paginate through responses from "CloudFrontKeyValueStore.Client.list_keys()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( KvsARN='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **KvsARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Key Value Store. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Items** *(list) --* Key value pairs * *(dict) --* A key value pair. * **Key** *(string) --* The key of the key value pair. * **Value** *(string) --* The value of the key value pair. CloudFrontKeyValueStore / Client / get_paginator get_paginator ************* CloudFrontKeyValueStore.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. CloudFrontKeyValueStore / Client / describe_key_value_store describe_key_value_store ************************ CloudFrontKeyValueStore.Client.describe_key_value_store(**kwargs) Returns metadata information about Key Value Store. See also: AWS API Documentation **Request Syntax** response = client.describe_key_value_store( KvsARN='string' ) Parameters: **KvsARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Key Value Store. Return type: dict Returns: **Response Syntax** { 'ItemCount': 123, 'TotalSizeInBytes': 123, 'KvsARN': 'string', 'Created': datetime(2015, 1, 1), 'ETag': 'string', 'LastModified': datetime(2015, 1, 1), 'Status': 'string', 'FailureReason': 'string' } **Response Structure** * *(dict) --* Metadata information about a Key Value Store. * **ItemCount** *(integer) --* Number of key value pairs in the Key Value Store. * **TotalSizeInBytes** *(integer) --* Total size of the Key Value Store in bytes. * **KvsARN** *(string) --* The Amazon Resource Name (ARN) of the Key Value Store. * **Created** *(datetime) --* Date and time when the Key Value Store was created. * **ETag** *(string) --* The version identifier for the current version of the Key Value Store. * **LastModified** *(datetime) --* Date and time when the key value pairs in the Key Value Store was last modified. * **Status** *(string) --* The current status of the Key Value Store. * **FailureReason** *(string) --* The reason for Key Value Store creation failure. **Exceptions** * "CloudFrontKeyValueStore.Client.exceptions.ConflictException" * "CloudFrontKeyValueStore.Client.exceptions.InternalServerExcepti on" * "CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundExcep tion" * "CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException" CloudFrontKeyValueStore / Client / can_paginate can_paginate ************ CloudFrontKeyValueStore.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. CloudFrontKeyValueStore / Client / get_waiter get_waiter ********** CloudFrontKeyValueStore.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" CloudFrontKeyValueStore / Client / update_keys update_keys *********** CloudFrontKeyValueStore.Client.update_keys(**kwargs) Puts or Deletes multiple key value pairs in a single, all-or- nothing operation. See also: AWS API Documentation **Request Syntax** response = client.update_keys( KvsARN='string', IfMatch='string', Puts=[ { 'Key': 'string', 'Value': 'string' }, ], Deletes=[ { 'Key': 'string' }, ] ) Parameters: * **KvsARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Key Value Store. * **IfMatch** (*string*) -- **[REQUIRED]** The current version (ETag) of the Key Value Store that you are updating keys of, which you can get using DescribeKeyValueStore. * **Puts** (*list*) -- List of key value pairs to put. * *(dict) --* List item for key value pair to put. * **Key** *(string) --* **[REQUIRED]** The key of the key value pair list item to put. * **Value** *(string) --* **[REQUIRED]** The value for the key value pair to put. * **Deletes** (*list*) -- List of keys to delete. * *(dict) --* List item for keys to delete. * **Key** *(string) --* **[REQUIRED]** The key of the key value pair to be deleted. Return type: dict Returns: **Response Syntax** { 'ItemCount': 123, 'TotalSizeInBytes': 123, 'ETag': 'string' } **Response Structure** * *(dict) --* Metadata information about a Key Value Store. * **ItemCount** *(integer) --* Number of key value pairs in the Key Value Store after the successful update. * **TotalSizeInBytes** *(integer) --* Total size of the Key Value Store after the successful update, in bytes. * **ETag** *(string) --* The current version identifier of the Key Value Store after the successful update. **Exceptions** * "CloudFrontKeyValueStore.Client.exceptions.ConflictException" * "CloudFrontKeyValueStore.Client.exceptions.ValidationException" * "CloudFrontKeyValueStore.Client.exceptions.InternalServerExcepti on" * "CloudFrontKeyValueStore.Client.exceptions.ServiceQuotaExceededE xception" * "CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundExcep tion" * "CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException" CloudFrontKeyValueStore / Client / put_key put_key ******* CloudFrontKeyValueStore.Client.put_key(**kwargs) Creates a new key value pair or replaces the value of an existing key. See also: AWS API Documentation **Request Syntax** response = client.put_key( Key='string', Value='string', KvsARN='string', IfMatch='string' ) Parameters: * **Key** (*string*) -- **[REQUIRED]** The key to put. * **Value** (*string*) -- **[REQUIRED]** The value to put. * **KvsARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Key Value Store. * **IfMatch** (*string*) -- **[REQUIRED]** The current version (ETag) of the Key Value Store that you are putting keys into, which you can get using DescribeKeyValueStore. Return type: dict Returns: **Response Syntax** { 'ItemCount': 123, 'TotalSizeInBytes': 123, 'ETag': 'string' } **Response Structure** * *(dict) --* Metadata information about a Key Value Store. * **ItemCount** *(integer) --* Number of key value pairs in the Key Value Store after the successful put. * **TotalSizeInBytes** *(integer) --* Total size of the Key Value Store after the successful put, in bytes. * **ETag** *(string) --* The current version identifier of the Key Value Store after the successful put. **Exceptions** * "CloudFrontKeyValueStore.Client.exceptions.ConflictException" * "CloudFrontKeyValueStore.Client.exceptions.ValidationException" * "CloudFrontKeyValueStore.Client.exceptions.InternalServerExcepti on" * "CloudFrontKeyValueStore.Client.exceptions.ServiceQuotaExceededE xception" * "CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundExcep tion" * "CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException" CloudFrontKeyValueStore / Client / list_keys list_keys ********* CloudFrontKeyValueStore.Client.list_keys(**kwargs) Returns a list of key value pairs. See also: AWS API Documentation **Request Syntax** response = client.list_keys( KvsARN='string', NextToken='string', MaxResults=123 ) Parameters: * **KvsARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Key Value Store. * **NextToken** (*string*) -- If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page. * **MaxResults** (*integer*) -- Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Items': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page. * **Items** *(list) --* Key value pairs * *(dict) --* A key value pair. * **Key** *(string) --* The key of the key value pair. * **Value** *(string) --* The value of the key value pair. **Exceptions** * "CloudFrontKeyValueStore.Client.exceptions.ConflictException" * "CloudFrontKeyValueStore.Client.exceptions.ValidationException" * "CloudFrontKeyValueStore.Client.exceptions.InternalServerExcepti on" * "CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundExcep tion" * "CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException" CloudFrontKeyValueStore / Client / close close ***** CloudFrontKeyValueStore.Client.close() Closes underlying endpoint connections. CloudFrontKeyValueStore / Client / delete_key delete_key ********** CloudFrontKeyValueStore.Client.delete_key(**kwargs) Deletes the key value pair specified by the key. See also: AWS API Documentation **Request Syntax** response = client.delete_key( KvsARN='string', Key='string', IfMatch='string' ) Parameters: * **KvsARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Key Value Store. * **Key** (*string*) -- **[REQUIRED]** The key to delete. * **IfMatch** (*string*) -- **[REQUIRED]** The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore. Return type: dict Returns: **Response Syntax** { 'ItemCount': 123, 'TotalSizeInBytes': 123, 'ETag': 'string' } **Response Structure** * *(dict) --* Metadata information about a Key Value Store. * **ItemCount** *(integer) --* Number of key value pairs in the Key Value Store after the successful delete. * **TotalSizeInBytes** *(integer) --* Total size of the Key Value Store after the successful delete, in bytes. * **ETag** *(string) --* The current version identifier of the Key Value Store after the successful delete. **Exceptions** * "CloudFrontKeyValueStore.Client.exceptions.ConflictException" * "CloudFrontKeyValueStore.Client.exceptions.ValidationException" * "CloudFrontKeyValueStore.Client.exceptions.InternalServerExcepti on" * "CloudFrontKeyValueStore.Client.exceptions.ServiceQuotaExceededE xception" * "CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundExcep tion" * "CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException" CloudFrontKeyValueStore / Client / get_key get_key ******* CloudFrontKeyValueStore.Client.get_key(**kwargs) Returns a key value pair. See also: AWS API Documentation **Request Syntax** response = client.get_key( KvsARN='string', Key='string' ) Parameters: * **KvsARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Key Value Store. * **Key** (*string*) -- **[REQUIRED]** The key to get. Return type: dict Returns: **Response Syntax** { 'Key': 'string', 'Value': 'string', 'ItemCount': 123, 'TotalSizeInBytes': 123 } **Response Structure** * *(dict) --* A key value pair. * **Key** *(string) --* The key of the key value pair. * **Value** *(string) --* The value of the key value pair. * **ItemCount** *(integer) --* Number of key value pairs in the Key Value Store. * **TotalSizeInBytes** *(integer) --* Total size of the Key Value Store in bytes. **Exceptions** * "CloudFrontKeyValueStore.Client.exceptions.ConflictException" * "CloudFrontKeyValueStore.Client.exceptions.InternalServerExcepti on" * "CloudFrontKeyValueStore.Client.exceptions.ResourceNotFoundExcep tion" * "CloudFrontKeyValueStore.Client.exceptions.AccessDeniedException"