PaymentCryptographyControlPlaneClient#
Index > PaymentCryptographyControlPlane > PaymentCryptographyControlPlaneClient
Auto-generated documentation for PaymentCryptographyControlPlane type annotations stubs module types-aiobotocore-payment-cryptography.
PaymentCryptographyControlPlaneClient#
Type annotations and code completion for session.create_client("payment-cryptography")
boto3 documentation
PaymentCryptographyControlPlaneClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_payment_cryptography.client import PaymentCryptographyControlPlaneClient
session = get_session()
async with session.create_client("payment-cryptography") as client:
client: PaymentCryptographyControlPlaneClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("payment-cryptography").exceptions
structure.
PaymentCryptographyControlPlaneClient.exceptions usage example
async with session.create_client("payment-cryptography") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ServiceUnavailableException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
PaymentCryptographyControlPlaneClient usage type checking example
from types_aiobotocore_payment_cryptography.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 session.create_client("payment-cryptography").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 session.create_client("payment-cryptography").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_alias#
Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key.
Type annotations and code completion for session.create_client("payment-cryptography").create_alias
method.
boto3 documentation
# create_alias method definition
await def create_alias(
self,
*,
AliasName: str,
KeyArn: str = ...,
) -> CreateAliasOutputTypeDef: # (1)
...
# create_alias method usage example with argument unpacking
kwargs: CreateAliasInputRequestTypeDef = { # (1)
"AliasName": ...,
}
parent.create_alias(**kwargs)
create_key#
Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region.
Type annotations and code completion for session.create_client("payment-cryptography").create_key
method.
boto3 documentation
# create_key method definition
await def create_key(
self,
*,
Exportable: bool,
KeyAttributes: KeyAttributesTypeDef, # (1)
Enabled: bool = ...,
KeyCheckValueAlgorithm: KeyCheckValueAlgorithmType = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateKeyOutputTypeDef: # (4)
...
# create_key method usage example with argument unpacking
kwargs: CreateKeyInputRequestTypeDef = { # (1)
"Exportable": ...,
"KeyAttributes": ...,
}
parent.create_key(**kwargs)
delete_alias#
Deletes the alias, but doesn't affect the underlying key.
Type annotations and code completion for session.create_client("payment-cryptography").delete_alias
method.
boto3 documentation
# delete_alias method definition
await def delete_alias(
self,
*,
AliasName: str,
) -> Dict[str, Any]:
...
# delete_alias method usage example with argument unpacking
kwargs: DeleteAliasInputRequestTypeDef = { # (1)
"AliasName": ...,
}
parent.delete_alias(**kwargs)
delete_key#
Deletes the key material and all metadata associated with Amazon Web Services Payment Cryptography key.
Type annotations and code completion for session.create_client("payment-cryptography").delete_key
method.
boto3 documentation
# delete_key method definition
await def delete_key(
self,
*,
KeyIdentifier: str,
DeleteKeyInDays: int = ...,
) -> DeleteKeyOutputTypeDef: # (1)
...
# delete_key method usage example with argument unpacking
kwargs: DeleteKeyInputRequestTypeDef = { # (1)
"KeyIdentifier": ...,
}
parent.delete_key(**kwargs)
export_key#
Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.
Type annotations and code completion for session.create_client("payment-cryptography").export_key
method.
boto3 documentation
# export_key method definition
await def export_key(
self,
*,
ExportKeyIdentifier: str,
KeyMaterial: ExportKeyMaterialTypeDef, # (1)
) -> ExportKeyOutputTypeDef: # (2)
...
# export_key method usage example with argument unpacking
kwargs: ExportKeyInputRequestTypeDef = { # (1)
"ExportKeyIdentifier": ...,
"KeyMaterial": ...,
}
parent.export_key(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("payment-cryptography").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_alias#
Gets the Amazon Web Services Payment Cryptography key associated with the alias.
Type annotations and code completion for session.create_client("payment-cryptography").get_alias
method.
boto3 documentation
# get_alias method definition
await def get_alias(
self,
*,
AliasName: str,
) -> GetAliasOutputTypeDef: # (1)
...
# get_alias method usage example with argument unpacking
kwargs: GetAliasInputRequestTypeDef = { # (1)
"AliasName": ...,
}
parent.get_alias(**kwargs)
get_key#
Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
Type annotations and code completion for session.create_client("payment-cryptography").get_key
method.
boto3 documentation
# get_key method definition
await def get_key(
self,
*,
KeyIdentifier: str,
) -> GetKeyOutputTypeDef: # (1)
...
# get_key method usage example with argument unpacking
kwargs: GetKeyInputRequestTypeDef = { # (1)
"KeyIdentifier": ...,
}
parent.get_key(**kwargs)
get_parameters_for_export#
Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
Type annotations and code completion for session.create_client("payment-cryptography").get_parameters_for_export
method.
boto3 documentation
# get_parameters_for_export method definition
await def get_parameters_for_export(
self,
*,
KeyMaterialType: KeyMaterialTypeType, # (1)
SigningKeyAlgorithm: KeyAlgorithmType, # (2)
) -> GetParametersForExportOutputTypeDef: # (3)
...
# get_parameters_for_export method usage example with argument unpacking
kwargs: GetParametersForExportInputRequestTypeDef = { # (1)
"KeyMaterialType": ...,
"SigningKeyAlgorithm": ...,
}
parent.get_parameters_for_export(**kwargs)
get_parameters_for_import#
Gets the import token and the wrapping key certificate to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.
Type annotations and code completion for session.create_client("payment-cryptography").get_parameters_for_import
method.
boto3 documentation
# get_parameters_for_import method definition
await def get_parameters_for_import(
self,
*,
KeyMaterialType: KeyMaterialTypeType, # (1)
WrappingKeyAlgorithm: KeyAlgorithmType, # (2)
) -> GetParametersForImportOutputTypeDef: # (3)
...
# get_parameters_for_import method usage example with argument unpacking
kwargs: GetParametersForImportInputRequestTypeDef = { # (1)
"KeyMaterialType": ...,
"WrappingKeyAlgorithm": ...,
}
parent.get_parameters_for_import(**kwargs)
get_public_key_certificate#
Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
Type annotations and code completion for session.create_client("payment-cryptography").get_public_key_certificate
method.
boto3 documentation
# get_public_key_certificate method definition
await def get_public_key_certificate(
self,
*,
KeyIdentifier: str,
) -> GetPublicKeyCertificateOutputTypeDef: # (1)
...
# get_public_key_certificate method usage example with argument unpacking
kwargs: GetPublicKeyCertificateInputRequestTypeDef = { # (1)
"KeyIdentifier": ...,
}
parent.get_public_key_certificate(**kwargs)
import_key#
Imports keys and public key certificates into Amazon Web Services Payment Cryptography.
Type annotations and code completion for session.create_client("payment-cryptography").import_key
method.
boto3 documentation
# import_key method definition
await def import_key(
self,
*,
KeyMaterial: ImportKeyMaterialTypeDef, # (1)
Enabled: bool = ...,
KeyCheckValueAlgorithm: KeyCheckValueAlgorithmType = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> ImportKeyOutputTypeDef: # (4)
...
- See ImportKeyMaterialTypeDef
- See KeyCheckValueAlgorithmType
- See TagTypeDef
- See ImportKeyOutputTypeDef
# import_key method usage example with argument unpacking
kwargs: ImportKeyInputRequestTypeDef = { # (1)
"KeyMaterial": ...,
}
parent.import_key(**kwargs)
list_aliases#
Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region.
Type annotations and code completion for session.create_client("payment-cryptography").list_aliases
method.
boto3 documentation
# list_aliases method definition
await def list_aliases(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAliasesOutputTypeDef: # (1)
...
# list_aliases method usage example with argument unpacking
kwargs: ListAliasesInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_aliases(**kwargs)
list_keys#
Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.
Type annotations and code completion for session.create_client("payment-cryptography").list_keys
method.
boto3 documentation
# list_keys method definition
await def list_keys(
self,
*,
KeyState: KeyStateType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListKeysOutputTypeDef: # (2)
...
- See KeyStateType
- See ListKeysOutputTypeDef
# list_keys method usage example with argument unpacking
kwargs: ListKeysInputRequestTypeDef = { # (1)
"KeyState": ...,
}
parent.list_keys(**kwargs)
list_tags_for_resource#
Lists the tags for an Amazon Web Services resource.
Type annotations and code completion for session.create_client("payment-cryptography").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
restore_key#
Cancels a scheduled key deletion during the waiting period.
Type annotations and code completion for session.create_client("payment-cryptography").restore_key
method.
boto3 documentation
# restore_key method definition
await def restore_key(
self,
*,
KeyIdentifier: str,
) -> RestoreKeyOutputTypeDef: # (1)
...
# restore_key method usage example with argument unpacking
kwargs: RestoreKeyInputRequestTypeDef = { # (1)
"KeyIdentifier": ...,
}
parent.restore_key(**kwargs)
start_key_usage#
Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Type annotations and code completion for session.create_client("payment-cryptography").start_key_usage
method.
boto3 documentation
# start_key_usage method definition
await def start_key_usage(
self,
*,
KeyIdentifier: str,
) -> StartKeyUsageOutputTypeDef: # (1)
...
# start_key_usage method usage example with argument unpacking
kwargs: StartKeyUsageInputRequestTypeDef = { # (1)
"KeyIdentifier": ...,
}
parent.start_key_usage(**kwargs)
stop_key_usage#
Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
Type annotations and code completion for session.create_client("payment-cryptography").stop_key_usage
method.
boto3 documentation
# stop_key_usage method definition
await def stop_key_usage(
self,
*,
KeyIdentifier: str,
) -> StopKeyUsageOutputTypeDef: # (1)
...
# stop_key_usage method usage example with argument unpacking
kwargs: StopKeyUsageInputRequestTypeDef = { # (1)
"KeyIdentifier": ...,
}
parent.stop_key_usage(**kwargs)
tag_resource#
Adds or edits tags on an Amazon Web Services Payment Cryptography key.
Type annotations and code completion for session.create_client("payment-cryptography").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Deletes a tag from an Amazon Web Services Payment Cryptography key.
Type annotations and code completion for session.create_client("payment-cryptography").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_alias#
Associates an existing Amazon Web Services Payment Cryptography alias with a different key.
Type annotations and code completion for session.create_client("payment-cryptography").update_alias
method.
boto3 documentation
# update_alias method definition
await def update_alias(
self,
*,
AliasName: str,
KeyArn: str = ...,
) -> UpdateAliasOutputTypeDef: # (1)
...
# update_alias method usage example with argument unpacking
kwargs: UpdateAliasInputRequestTypeDef = { # (1)
"AliasName": ...,
}
parent.update_alias(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("payment-cryptography").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> PaymentCryptographyControlPlaneClient:
...
__aexit__#
Type annotations and code completion for session.create_client("payment-cryptography").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("payment-cryptography").get_paginator
method with overloads.
client.get_paginator("list_aliases")
-> ListAliasesPaginatorclient.get_paginator("list_keys")
-> ListKeysPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginator