PaymentCryptographyControlPlaneClient

Index > PaymentCryptographyControlPlane > PaymentCryptographyControlPlaneClient

Auto-generated documentation for PaymentCryptographyControlPlane type annotations stubs module mypy-boto3-payment-cryptography.

PaymentCryptographyControlPlaneClient

Type annotations and code completion for boto3.client("payment-cryptography"). boto3 documentation

# PaymentCryptographyControlPlaneClient usage example

from boto3.session import Session
from mypy_boto3_payment_cryptography.client import PaymentCryptographyControlPlaneClient

def get_payment-cryptography_client() -> PaymentCryptographyControlPlaneClient:
    return Session().client("payment-cryptography")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("payment-cryptography")

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.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_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 boto3.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 boto3.client("payment-cryptography").close method. boto3 documentation

# close method definition

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 boto3.client("payment-cryptography").create_alias method. boto3 documentation

# create_alias method definition

def create_alias(
    self,
    *,
    AliasName: str,
    KeyArn: str = ...,
) -> CreateAliasOutputTypeDef:  # (1)
    ...

1. See CreateAliasOutputTypeDef

# create_alias method usage example with argument unpacking

kwargs: CreateAliasInputRequestTypeDef = {  # (1)
    "AliasName": ...,
}

parent.create_alias(**kwargs)

1. See CreateAliasInputRequestTypeDef

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 boto3.client("payment-cryptography").create_key method. boto3 documentation

# create_key method definition

def create_key(
    self,
    *,
    Exportable: bool,
    KeyAttributes: KeyAttributesTypeDef,  # (1)
    Enabled: bool = ...,
    KeyCheckValueAlgorithm: KeyCheckValueAlgorithmType = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateKeyOutputTypeDef:  # (4)
    ...

1. See KeyAttributesTypeDef
2. See KeyCheckValueAlgorithmType
3. See TagTypeDef
4. See CreateKeyOutputTypeDef

# create_key method usage example with argument unpacking

kwargs: CreateKeyInputRequestTypeDef = {  # (1)
    "Exportable": ...,
    "KeyAttributes": ...,
}

parent.create_key(**kwargs)

1. See CreateKeyInputRequestTypeDef

delete_alias

Deletes the alias, but doesn't affect the underlying key.

Type annotations and code completion for boto3.client("payment-cryptography").delete_alias method. boto3 documentation

# delete_alias method definition

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)

1. See DeleteAliasInputRequestTypeDef

delete_key

Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.

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

# delete_key method definition

def delete_key(
    self,
    *,
    KeyIdentifier: str,
    DeleteKeyInDays: int = ...,
) -> DeleteKeyOutputTypeDef:  # (1)
    ...

1. See DeleteKeyOutputTypeDef

# delete_key method usage example with argument unpacking

kwargs: DeleteKeyInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
}

parent.delete_key(**kwargs)

1. See DeleteKeyInputRequestTypeDef

export_key

Exports a key from Amazon Web Services Payment Cryptography.

Type annotations and code completion for boto3.client("payment-cryptography").export_key method. boto3 documentation

# export_key method definition

def export_key(
    self,
    *,
    ExportKeyIdentifier: str,
    KeyMaterial: ExportKeyMaterialTypeDef,  # (1)
    ExportAttributes: ExportAttributesTypeDef = ...,  # (2)
) -> ExportKeyOutputTypeDef:  # (3)
    ...

1. See ExportKeyMaterialTypeDef
2. See ExportAttributesTypeDef
3. See ExportKeyOutputTypeDef

# export_key method usage example with argument unpacking

kwargs: ExportKeyInputRequestTypeDef = {  # (1)
    "ExportKeyIdentifier": ...,
    "KeyMaterial": ...,
}

parent.export_key(**kwargs)

1. See ExportKeyInputRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("payment-cryptography").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_alias

Gets the Amazon Web Services Payment Cryptography key associated with the alias.

Type annotations and code completion for boto3.client("payment-cryptography").get_alias method. boto3 documentation

# get_alias method definition

def get_alias(
    self,
    *,
    AliasName: str,
) -> GetAliasOutputTypeDef:  # (1)
    ...

1. See GetAliasOutputTypeDef

# get_alias method usage example with argument unpacking

kwargs: GetAliasInputRequestTypeDef = {  # (1)
    "AliasName": ...,
}

parent.get_alias(**kwargs)

1. See GetAliasInputRequestTypeDef

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 boto3.client("payment-cryptography").get_key method. boto3 documentation

# get_key method definition

def get_key(
    self,
    *,
    KeyIdentifier: str,
) -> GetKeyOutputTypeDef:  # (1)
    ...

1. See GetKeyOutputTypeDef

# get_key method usage example with argument unpacking

kwargs: GetKeyInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
}

parent.get_key(**kwargs)

1. See GetKeyInputRequestTypeDef

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 boto3.client("payment-cryptography").get_parameters_for_export method. boto3 documentation

# get_parameters_for_export method definition

def get_parameters_for_export(
    self,
    *,
    KeyMaterialType: KeyMaterialTypeType,  # (1)
    SigningKeyAlgorithm: KeyAlgorithmType,  # (2)
) -> GetParametersForExportOutputTypeDef:  # (3)
    ...

1. See KeyMaterialTypeType
2. See KeyAlgorithmType
3. See GetParametersForExportOutputTypeDef

# get_parameters_for_export method usage example with argument unpacking

kwargs: GetParametersForExportInputRequestTypeDef = {  # (1)
    "KeyMaterialType": ...,
    "SigningKeyAlgorithm": ...,
}

parent.get_parameters_for_export(**kwargs)

1. See GetParametersForExportInputRequestTypeDef

get_parameters_for_import

Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.

Type annotations and code completion for boto3.client("payment-cryptography").get_parameters_for_import method. boto3 documentation

# get_parameters_for_import method definition

def get_parameters_for_import(
    self,
    *,
    KeyMaterialType: KeyMaterialTypeType,  # (1)
    WrappingKeyAlgorithm: KeyAlgorithmType,  # (2)
) -> GetParametersForImportOutputTypeDef:  # (3)
    ...

1. See KeyMaterialTypeType
2. See KeyAlgorithmType
3. See GetParametersForImportOutputTypeDef

# get_parameters_for_import method usage example with argument unpacking

kwargs: GetParametersForImportInputRequestTypeDef = {  # (1)
    "KeyMaterialType": ...,
    "WrappingKeyAlgorithm": ...,
}

parent.get_parameters_for_import(**kwargs)

1. See GetParametersForImportInputRequestTypeDef

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 boto3.client("payment-cryptography").get_public_key_certificate method. boto3 documentation

# get_public_key_certificate method definition

def get_public_key_certificate(
    self,
    *,
    KeyIdentifier: str,
) -> GetPublicKeyCertificateOutputTypeDef:  # (1)
    ...

1. See GetPublicKeyCertificateOutputTypeDef

# get_public_key_certificate method usage example with argument unpacking

kwargs: GetPublicKeyCertificateInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
}

parent.get_public_key_certificate(**kwargs)

1. See GetPublicKeyCertificateInputRequestTypeDef

import_key

Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.

Type annotations and code completion for boto3.client("payment-cryptography").import_key method. boto3 documentation

# import_key method definition

def import_key(
    self,
    *,
    KeyMaterial: ImportKeyMaterialTypeDef,  # (1)
    Enabled: bool = ...,
    KeyCheckValueAlgorithm: KeyCheckValueAlgorithmType = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> ImportKeyOutputTypeDef:  # (4)
    ...

1. See ImportKeyMaterialTypeDef
2. See KeyCheckValueAlgorithmType
3. See TagTypeDef
4. See ImportKeyOutputTypeDef

# import_key method usage example with argument unpacking

kwargs: ImportKeyInputRequestTypeDef = {  # (1)
    "KeyMaterial": ...,
}

parent.import_key(**kwargs)

1. See ImportKeyInputRequestTypeDef

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 boto3.client("payment-cryptography").list_aliases method. boto3 documentation

# list_aliases method definition

def list_aliases(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAliasesOutputTypeDef:  # (1)
    ...

1. See ListAliasesOutputTypeDef

# list_aliases method usage example with argument unpacking

kwargs: ListAliasesInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_aliases(**kwargs)

1. See ListAliasesInputRequestTypeDef

list_keys

Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.

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

# list_keys method definition

def list_keys(
    self,
    *,
    KeyState: KeyStateType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListKeysOutputTypeDef:  # (2)
    ...

1. See KeyStateType
2. See ListKeysOutputTypeDef

# list_keys method usage example with argument unpacking

kwargs: ListKeysInputRequestTypeDef = {  # (1)
    "KeyState": ...,
}

parent.list_keys(**kwargs)

1. See ListKeysInputRequestTypeDef

list_tags_for_resource

Lists the tags for an Amazon Web Services resource.

Type annotations and code completion for boto3.client("payment-cryptography").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

restore_key

Cancels a scheduled key deletion during the waiting period.

Type annotations and code completion for boto3.client("payment-cryptography").restore_key method. boto3 documentation

# restore_key method definition

def restore_key(
    self,
    *,
    KeyIdentifier: str,
) -> RestoreKeyOutputTypeDef:  # (1)
    ...

1. See RestoreKeyOutputTypeDef

# restore_key method usage example with argument unpacking

kwargs: RestoreKeyInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
}

parent.restore_key(**kwargs)

1. See RestoreKeyInputRequestTypeDef

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 boto3.client("payment-cryptography").start_key_usage method. boto3 documentation

# start_key_usage method definition

def start_key_usage(
    self,
    *,
    KeyIdentifier: str,
) -> StartKeyUsageOutputTypeDef:  # (1)
    ...

1. See StartKeyUsageOutputTypeDef

# start_key_usage method usage example with argument unpacking

kwargs: StartKeyUsageInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
}

parent.start_key_usage(**kwargs)

1. See StartKeyUsageInputRequestTypeDef

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 boto3.client("payment-cryptography").stop_key_usage method. boto3 documentation

# stop_key_usage method definition

def stop_key_usage(
    self,
    *,
    KeyIdentifier: str,
) -> StopKeyUsageOutputTypeDef:  # (1)
    ...

1. See StopKeyUsageOutputTypeDef

# stop_key_usage method usage example with argument unpacking

kwargs: StopKeyUsageInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
}

parent.stop_key_usage(**kwargs)

1. See StopKeyUsageInputRequestTypeDef

tag_resource

Adds or edits tags on an Amazon Web Services Payment Cryptography key.

Type annotations and code completion for boto3.client("payment-cryptography").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Deletes a tag from an Amazon Web Services Payment Cryptography key.

Type annotations and code completion for boto3.client("payment-cryptography").untag_resource method. boto3 documentation

# untag_resource method definition

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)

1. See UntagResourceInputRequestTypeDef

update_alias

Associates an existing Amazon Web Services Payment Cryptography alias with a different key.

Type annotations and code completion for boto3.client("payment-cryptography").update_alias method. boto3 documentation

# update_alias method definition

def update_alias(
    self,
    *,
    AliasName: str,
    KeyArn: str = ...,
) -> UpdateAliasOutputTypeDef:  # (1)
    ...

1. See UpdateAliasOutputTypeDef

# update_alias method usage example with argument unpacking

kwargs: UpdateAliasInputRequestTypeDef = {  # (1)
    "AliasName": ...,
}

parent.update_alias(**kwargs)

1. See UpdateAliasInputRequestTypeDef

get_paginator

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

• client.get_paginator("list_aliases") -> ListAliasesPaginator
• client.get_paginator("list_keys") -> ListKeysPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator