Skip to content

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,
    *,
    KeyAttributes: KeyAttributesTypeDef,  # (1)
    Exportable: bool,
    KeyCheckValueAlgorithm: KeyCheckValueAlgorithmType = ...,  # (2)
    Enabled: bool = ...,
    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)
    "KeyAttributes": ...,
    "Exportable": ...,
}

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