openapi: 3.2.0 info: version: '2021-09-14' x-release: v4 title: Payment Cryptography Control Plane API description: You use the Amazon Web Services Payment Cryptography Control Plane to manage the encryption keys you use for payment-related cryptographic operations. x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: payment-cryptography x-aws-signingName: payment-cryptography x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/payment-cryptography-2021-09-14.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://controlplane.payment-cryptography.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Payment Cryptography Control Plane multi-region endpoint - url: https://controlplane.payment-cryptography.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Payment Cryptography Control Plane multi-region endpoint - url: http://controlplane.payment-cryptography.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Payment Cryptography Control Plane endpoint for China (Beijing) and China (Ningxia) - url: https://controlplane.payment-cryptography.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Payment Cryptography Control Plane endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Payment Cryptography Control Plane paths: /#X-Amz-Target=PaymentCryptographyControlPlane.CreateAlias: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateAlias description: 'Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData. You can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can''t create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region. To change the key that''s associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don''t affect the underlying key. To get the alias that you created, call ListAliases. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: DeleteAlias GetAlias ListAliases UpdateAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateAliasOutput' examples: CreateAlias200Example: summary: Default CreateAlias 200 response x-microcks-default: true value: Alias: example-string '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAliasInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.CreateAlias x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Create Alias tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.CreateKey: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateKey description: '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. You use keys for cryptographic functions such as encryption and decryption. In addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state. When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that defines the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation. Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: DeleteKey GetKey ListKeys' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateKeyOutput' examples: CreateKey200Example: summary: Default CreateKey 200 response x-microcks-default: true value: Key: example-string '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateKeyInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.CreateKey x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Create Key tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.DeleteAlias: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteAlias description: 'Deletes the alias, but doesn''t affect the underlying key. Each key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: CreateAlias GetAlias ListAliases UpdateAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteAliasOutput' '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteAliasInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.DeleteAlias x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Delete Alias tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.DeleteKey: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteKey description: 'Deletes the key material and all metadata associated with Amazon Web Services Payment Cryptography key. Key deletion is irreversible. After a key is deleted, you can''t perform cryptographic operations using the key. For example, you can''t decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn''t delete it until after a waiting period. The default waiting period is 7 days. To set a different waiting period, set DeleteKeyInDays. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE. If you delete key material, you can use ImportKey to reimport the same key material into the Amazon Web Services Payment Cryptography key. You should delete a key only when you are sure that you don''t need to use it anymore and no other parties are utilizing this key. If you aren''t sure, consider deactivating it instead by calling StopKeyUsage. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: RestoreKey StartKeyUsage StopKeyUsage' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteKeyOutput' examples: DeleteKey200Example: summary: Default DeleteKey 200 response x-microcks-default: true value: Key: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteKeyInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.DeleteKey x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Delete Key tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.ExportKey: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ExportKey description: 'Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard. Amazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard. You can use ExportKey to export main or root keys such as KEK (Key Encryption Key), using asymmetric key exchange technique following ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys. After which you can export working keys using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography TR-34 key export Amazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to export main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). In key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export. KRH is the user receiving the key. Before you initiate TR-34 key export, you must obtain an export token by calling GetParametersForExport. This operation also returns the signing key certificate that KDH uses to sign the wrapped key to generate a TR-34 wrapped key block. The export token expires after 7 days. Set the following parameters: CertificateAuthorityPublicKeyIdentifier The KeyARN of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by calling ImportKey for RootCertificatePublicKey. ExportToken Obtained from KDH by calling GetParametersForExport. WrappingKeyCertificate Amazon Web Services Payment Cryptography uses this to wrap the key under export. When this operation is successful, Amazon Web Services Payment Cryptography returns the TR-34 wrapped key block. TR-31 key export Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to export working keys. In TR-31, you must use a main key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey. When this operation is successful, Amazon Web Services Payment Cryptography returns a TR-31 wrapped key block. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: GetParametersForExport ImportKey' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportKeyOutput' examples: ExportKey200Example: summary: Default ExportKey 200 response x-microcks-default: true value: WrappedKey: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExportKeyInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.ExportKey x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Export Key tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.GetAlias: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetAlias description: 'Gets the Amazon Web Services Payment Cryptography key associated with the alias. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: CreateAlias DeleteAlias ListAliases UpdateAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAliasOutput' examples: GetAlias200Example: summary: Default GetAlias 200 response x-microcks-default: true value: Alias: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetAliasInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.GetAlias x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Get Alias tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.GetKey: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetKey description: 'Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: CreateKey DeleteKey ListKeys' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetKeyOutput' examples: GetKey200Example: summary: Default GetKey 200 response x-microcks-default: true value: Key: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetKeyInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.GetKey x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Get Key tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.GetParametersForExport: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetParametersForExport description: 'Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography. The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: ExportKey GetParametersForImport' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetParametersForExportOutput' examples: GetParametersForExport200Example: summary: Default GetParametersForExport 200 response x-microcks-default: true value: ExportToken: example-string ParametersValidUntilTimestamp: resource-abc123 SigningKeyAlgorithm: example-string SigningKeyCertificate: example-string SigningKeyCertificateChain: example-string '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetParametersForExportInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.GetParametersForExport x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Get Parameters for Export tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.GetParametersForImport: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetParametersForImport description: 'Gets the import token and the wrapping key certificate to initiate a TR-34 key import into Amazon Web Services Payment Cryptography. The wrapping key certificate wraps the key under import within the TR-34 key payload. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. The same import token can be used to import multiple keys into your service account. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: GetParametersForExport ImportKey' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetParametersForImportOutput' examples: GetParametersForImport200Example: summary: Default GetParametersForImport 200 response x-microcks-default: true value: ImportToken: example-string ParametersValidUntilTimestamp: resource-abc123 WrappingKeyAlgorithm: example-string WrappingKeyCertificate: example-string WrappingKeyCertificateChain: example-string '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetParametersForImportInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.GetParametersForImport x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Get Parameters for Import tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.GetPublicKeyCertificate: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetPublicKeyCertificate description: 'Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography. Unlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with GetPublicKeyCertificate permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment Cryptography Cross-account use: This operation can''t be used across different Amazon Web Services accounts.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetPublicKeyCertificateOutput' examples: GetPublicKeyCertificate200Example: summary: Default GetPublicKeyCertificate 200 response x-microcks-default: true value: KeyCertificate: example-string KeyCertificateChain: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetPublicKeyCertificateInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.GetPublicKeyCertificate x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Get Public Key Certificate tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.ImportKey: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ImportKey description: Imports keys and public key certificates into Amazon Web Services Payment Cryptography. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ImportKeyOutput' examples: ImportKey200Example: summary: Default ImportKey 200 response x-microcks-default: true value: Key: example-string '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ImportKeyInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.ImportKey x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Import Key tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.ListAliases: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListAliases description: 'Lists the aliases for all keys in the caller''s Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide. This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value. Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: CreateAlias DeleteAlias GetAlias UpdateAlias' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAliasesOutput' examples: ListAliases200Example: summary: Default ListAliases 200 response x-microcks-default: true value: Aliases: example-string NextToken: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListAliasesInput' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.ListAliases x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography List Aliases tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.ListKeys: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListKeys description: 'Lists the keys in the caller''s Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys. This is a paginated operation, which means that each response might contain only a subset of all the keys. When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: CreateKey DeleteKey GetKey' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListKeysOutput' examples: ListKeys200Example: summary: Default ListKeys 200 response x-microcks-default: true value: Keys: example-string NextToken: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListKeysInput' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.ListKeys x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography List Keys tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.ListTagsForResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListTagsForResource description: 'Lists the tags for an Amazon Web Services resource. This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: TagResource UntagResource' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceOutput' examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: NextToken: example-string Tags: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceInput' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.ListTagsForResource x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography List Tags for Resource tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.RestoreKey: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: RestoreKey description: 'Cancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion. During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted. After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: DeleteKey StartKeyUsage StopKeyUsage' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreKeyOutput' examples: RestoreKey200Example: summary: Default RestoreKey 200 response x-microcks-default: true value: Key: example-string '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RestoreKeyInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.RestoreKey x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Restore Key tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.StartKeyUsage: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartKeyUsage description: '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. Related operations: StopKeyUsage' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartKeyUsageOutput' examples: StartKeyUsage200Example: summary: Default StartKeyUsage 200 response x-microcks-default: true value: Key: example-string '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartKeyUsageInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.StartKeyUsage x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Start Key Usage tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.StopKeyUsage: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopKeyUsage description: 'Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography. You can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: DeleteKey StartKeyUsage' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopKeyUsageOutput' examples: StopKeyUsage200Example: summary: Default StopKeyUsage 200 response x-microcks-default: true value: Key: example-string '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopKeyUsageInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.StopKeyUsage x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Stop Key Usage tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.TagResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TagResource description: 'Adds or edits tags on an Amazon Web Services Payment Cryptography key. Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key. Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: ListTagsForResource UntagResource' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceOutput' '480': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagResourceInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.TagResource x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Tag Resource tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.UntagResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UntagResource description: 'Deletes a tag from an Amazon Web Services Payment Cryptography key. Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key. Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: ListTagsForResource TagResource' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceOutput' '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UntagResourceInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.UntagResource x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Untag Resource tags: - Payment Cryptography Control Plane /#X-Amz-Target=PaymentCryptographyControlPlane.UpdateAlias: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateAlias description: 'Associates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region Cross-account use: This operation can''t be used across different Amazon Web Services accounts. Related operations: CreateAlias DeleteAlias GetAlias ListAliases' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateAliasOutput' examples: UpdateAlias200Example: summary: Default UpdateAlias 200 response x-microcks-default: true value: Alias: example-string '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAliasInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - PaymentCryptographyControlPlane.UpdateAlias x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Payment Cryptography Update Alias tags: - Payment Cryptography Control Plane components: schemas: GetParametersForExportOutput: type: object required: - ExportToken - ParametersValidUntilTimestamp - SigningKeyAlgorithm - SigningKeyCertificate - SigningKeyCertificateChain properties: ExportToken: allOf: - $ref: '#/components/schemas/ExportTokenId' - description: The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account. ParametersValidUntilTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The validity period of the export token. SigningKeyAlgorithm: allOf: - $ref: '#/components/schemas/KeyAlgorithm' - description: The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed. SigningKeyCertificate: allOf: - $ref: '#/components/schemas/CertificateType' - description: The signing key certificate of the public key for signature within the TR-34 key block cryptogram. The certificate expires after 7 days. SigningKeyCertificateChain: allOf: - $ref: '#/components/schemas/CertificateType' - description: The certificate chain that signed the signing key certificate. This is the root certificate authority (CA) within your service account. ImportKeyOutput: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/Key' - description: The KeyARN of the key material imported within Amazon Web Services Payment Cryptography. RestoreKeyInput: type: object required: - KeyIdentifier title: RestoreKeyInput properties: KeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the key to be restored within Amazon Web Services Payment Cryptography. ListKeysOutput: type: object required: - Keys properties: Keys: allOf: - $ref: '#/components/schemas/KeySummaryList' - description: The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token for the next set of results, or an empty or null value if there are no more results. RestoreKeyOutput: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/Key' - description: 'The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed. ' ExportTr31KeyBlock: type: object required: - WrappingKeyIdentifier properties: WrappingKeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation. description: Parameter information for key material export using TR-31 standard. ExportTokenId: type: string pattern: ^export-token-[0-9a-zA-Z]{16,64}$ StartKeyUsageOutput: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/Key' - description: The KeyARN of the Amazon Web Services Payment Cryptography key activated for use. GetAliasInput: type: object required: - AliasName title: GetAliasInput properties: AliasName: allOf: - $ref: '#/components/schemas/AliasName' - description: The alias of the Amazon Web Services Payment Cryptography key. ListAliasesInput: type: object title: ListAliasesInput properties: MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description:

Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received. GetKeyInput: type: object required: - KeyIdentifier title: GetKeyInput properties: KeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the Amazon Web Services Payment Cryptography key. Timestamp: type: string format: date-time ServiceUnavailableException: {} ResourceNotFoundException: {} ExportKeyMaterial: type: object properties: Tr31KeyBlock: allOf: - $ref: '#/components/schemas/ExportTr31KeyBlock' - description: Parameter information for key material export using TR-31 standard. Tr34KeyBlock: allOf: - $ref: '#/components/schemas/ExportTr34KeyBlock' - description: Parameter information for key material export using TR-34 standard. description: Parameter information for key material export from Amazon Web Services Payment Cryptography. KeyCheckValue: type: string pattern: ^[0-9a-fA-F]+$ minLength: 4 maxLength: 16 GetParametersForImportOutput: type: object required: - ImportToken - ParametersValidUntilTimestamp - WrappingKeyAlgorithm - WrappingKeyCertificate - WrappingKeyCertificateChain properties: ImportToken: allOf: - $ref: '#/components/schemas/ImportTokenId' - description: The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account. ParametersValidUntilTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The validity period of the import token. WrappingKeyAlgorithm: allOf: - $ref: '#/components/schemas/KeyAlgorithm' - description: The algorithm of the wrapping key for use within TR-34 key block. RSA_2048 is the only wrapping key algorithm allowed. WrappingKeyCertificate: allOf: - $ref: '#/components/schemas/CertificateType' - description: The wrapping key certificate of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days. WrappingKeyCertificateChain: allOf: - $ref: '#/components/schemas/CertificateType' - description: The Amazon Web Services Payment Cryptography certificate chain that signed the wrapping key certificate. This is the root certificate authority (CA) within your service account. DeleteAliasOutput: type: object properties: {} Tags: type: array items: $ref: '#/components/schemas/Tag' minItems: 0 maxItems: 200 UntagResourceOutput: type: object properties: {} ExportTr34KeyBlock: type: object required: - CertificateAuthorityPublicKeyIdentifier - ExportToken - KeyBlockFormat - WrappingKeyCertificate properties: CertificateAuthorityPublicKeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export. ExportToken: allOf: - $ref: '#/components/schemas/ExportTokenId' - description: The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account. KeyBlockFormat: allOf: - $ref: '#/components/schemas/Tr34KeyBlockFormat' - description: The format of key block that Amazon Web Services Payment Cryptography will use during key export. RandomNonce: allOf: - $ref: '#/components/schemas/HexLength16' - description: A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass. WrappingKeyCertificate: allOf: - $ref: '#/components/schemas/CertificateType' - description: The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export. description: Parameter information for key material export using TR-34 standard. TagResourceInput: type: object required: - ResourceArn - Tags title: TagResourceInput properties: ResourceArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The KeyARN of the key whose tags are being updated. Tags: allOf: - $ref: '#/components/schemas/Tags' - description:

One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

To use this parameter, you must have TagResource permission in an IAM policy.

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

 ImportKeyInput: type: object required: - KeyMaterial title: ImportKeyInput properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether import key is enabled. KeyCheckValueAlgorithm: allOf: - $ref: '#/components/schemas/KeyCheckValueAlgorithm' - description:

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.

For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

KeyMaterial: allOf: - $ref: '#/components/schemas/ImportKeyMaterial' - description: The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey. Tags: allOf: - $ref: '#/components/schemas/Tags' - description:

The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

To use this parameter, you must have TagResource permission.

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

 CreateAliasInput: type: object required: - AliasName title: CreateAliasInput properties: AliasName: allOf: - $ref: '#/components/schemas/AliasName' - description:

A friendly name that you can use to refer a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

 KeyArn: allOf: - $ref: '#/components/schemas/KeyArn' - description: The KeyARN of the key to associate with the alias. GetParametersForExportInput: type: object required: - KeyMaterialType - SigningKeyAlgorithm title: GetParametersForExportInput properties: KeyMaterialType: allOf: - $ref: '#/components/schemas/KeyMaterialType' - description: The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK. Export token is not required for TR-31 key export. SigningKeyAlgorithm: allOf: - $ref: '#/components/schemas/KeyAlgorithm' - description: The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block cryptogram. RSA_2048 is the only signing key algorithm allowed. WrappedKeyMaterialFormat: type: string enum: - KEY_CRYPTOGRAM - TR31_KEY_BLOCK - TR34_KEY_BLOCK TrustedCertificatePublicKey: type: object required: - CertificateAuthorityPublicKeyIdentifier - KeyAttributes - PublicKeyCertificate properties: CertificateAuthorityPublicKeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import. KeyAttributes: allOf: - $ref: '#/components/schemas/KeyAttributes' - description: The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after a trusted public key is imported. PublicKeyCertificate: allOf: - $ref: '#/components/schemas/CertificateType' - description: Parameter information for trusted public key certificate import. description: Parameter information for trusted public key certificate import. KeySummaryList: type: array items: $ref: '#/components/schemas/KeySummary' TagResourceOutput: type: object properties: {} ResourceArn: type: string pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$ minLength: 70 maxLength: 150 ValidationException: {} GetPublicKeyCertificateOutput: type: object required: - KeyCertificate - KeyCertificateChain properties: KeyCertificate: allOf: - $ref: '#/components/schemas/CertificateType' - description: The public key component of the asymmetric key pair in a certificate (PEM) format. It is signed by the root certificate authority (CA) within your service account. The certificate expires in 90 days. KeyCertificateChain: allOf: - $ref: '#/components/schemas/CertificateType' - description: The certificate chain that signed the public key certificate of the asymmetric key pair. This is the root certificate authority (CA) within your service account. RootCertificatePublicKey: type: object required: - KeyAttributes - PublicKeyCertificate properties: KeyAttributes: allOf: - $ref: '#/components/schemas/KeyAttributes' - description: The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the root public key is imported. PublicKeyCertificate: allOf: - $ref: '#/components/schemas/CertificateType' - description: Parameter information for root public key certificate import. description: Parameter information for root public key certificate import. KeyAttributes: type: object required: - KeyAlgorithm - KeyClass - KeyModesOfUse - KeyUsage properties: KeyAlgorithm: allOf: - $ref: '#/components/schemas/KeyAlgorithm' - description:

The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

KeyClass: allOf: - $ref: '#/components/schemas/KeyClass' - description: The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair. KeyModesOfUse: allOf: - $ref: '#/components/schemas/KeyModesOfUse' - description: The list of cryptographic operations that you can perform using the key. KeyUsage: allOf: - $ref: '#/components/schemas/KeyUsage' - description: The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec. description: The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created. CertificateType: type: string pattern: ^[^\[;\]<>]+$ minLength: 1 maxLength: 32768 format: password ImportTokenId: type: string pattern: ^import-token-[0-9a-zA-Z]{16,64}$ StopKeyUsageInput: type: object required: - KeyIdentifier title: StopKeyUsageInput properties: KeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyArn of the key. UntagResourceInput: type: object required: - ResourceArn - TagKeys title: UntagResourceInput properties: ResourceArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The KeyARN of the key whose tags are being removed. TagKeys: allOf: - $ref: '#/components/schemas/TagKeys' - description:

One or more tag keys. Don't include the tag values.

If the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.

InternalServerException: {} Tr31WrappedKeyBlock: type: string pattern: ^[0-9A-Z]+$ minLength: 56 maxLength: 9984 CreateAliasOutput: type: object required: - Alias properties: Alias: allOf: - $ref: '#/components/schemas/Alias' - description: The alias for the key. ListKeysInput: type: object title: ListKeysInput properties: KeyState: allOf: - $ref: '#/components/schemas/KeyState' - description: The key state of the keys you want to list. MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received. TagKey: type: string minLength: 1 maxLength: 128 CreateKeyInput: type: object required: - Exportable - KeyAttributes title: CreateKeyInput properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled. Exportable: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether the key is exportable from the service. KeyAttributes: allOf: - $ref: '#/components/schemas/KeyAttributes' - description: The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created. KeyCheckValueAlgorithm: allOf: - $ref: '#/components/schemas/KeyCheckValueAlgorithm' - description:

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.

For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

Tags: allOf: - $ref: '#/components/schemas/Tags' - description:

The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

To use this parameter, you must have TagResource permission.

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

 AliasName: type: string pattern: ^alias/[a-zA-Z0-9/_-]+$ minLength: 7 maxLength: 256 ListTagsForResourceInput: type: object required: - ResourceArn title: ListTagsForResourceInput properties: MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received. ResourceArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The KeyARN of the key whose tags you are getting. ServiceQuotaExceededException: {} KeyAlgorithm: type: string enum: - TDES_2KEY - TDES_3KEY - AES_128 - AES_192 - AES_256 - RSA_2048 - RSA_3072 - RSA_4096 KeyMaterialType: type: string enum: - TR34_KEY_BLOCK - TR31_KEY_BLOCK - ROOT_PUBLIC_KEY_CERTIFICATE - TRUSTED_PUBLIC_KEY_CERTIFICATE TagKeys: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 200 Tr34KeyBlockFormat: type: string enum: - X9_TR34_2012 DeleteAliasInput: type: object required: - AliasName title: DeleteAliasInput properties: AliasName: allOf: - $ref: '#/components/schemas/AliasName' - description: A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. ThrottlingException: {} DeleteKeyInputDeleteKeyInDaysInteger: type: integer minimum: 3 maximum: 180 KeyArnOrKeyAliasType: type: string pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$ minLength: 7 maxLength: 322 StartKeyUsageInput: type: object required: - KeyIdentifier title: StartKeyUsageInput properties: KeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyArn of the key. Alias: type: object required: - AliasName properties: AliasName: allOf: - $ref: '#/components/schemas/AliasName' - description:

A friendly name that you can use to refer to a key. The value must begin with alias/.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

 KeyArn: allOf: - $ref: '#/components/schemas/KeyArn' - description: The KeyARN of the key associated with the alias. description: Contains information about an alias. NextToken: type: string minLength: 1 maxLength: 8192 Tr34WrappedKeyBlock: type: string pattern: ^[0-9A-F]+$ minLength: 2 maxLength: 4096 KeyArn: type: string pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$ minLength: 70 maxLength: 150 UpdateAliasOutput: type: object required: - Alias properties: Alias: allOf: - $ref: '#/components/schemas/Alias' - description: The alias name. KeyMaterial: type: string minLength: 48 maxLength: 16384 format: password StopKeyUsageOutput: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/Key' - description: The KeyARN of the key. ExportKeyOutput: type: object properties: WrappedKey: allOf: - $ref: '#/components/schemas/WrappedKey' - description: The key material under export as a TR-34 or TR-31 wrapped key block. DeleteKeyInput: type: object required: - KeyIdentifier title: DeleteKeyInput properties: DeleteKeyInDays: allOf: - $ref: '#/components/schemas/DeleteKeyInputDeleteKeyInDaysInteger' - description: The waiting period for key deletion. The default value is seven days. KeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the key that is scheduled for deletion. KeyOrigin: type: string enum: - EXTERNAL - AWS_PAYMENT_CRYPTOGRAPHY description: Defines the source of a key Aliases: type: array items: $ref: '#/components/schemas/Alias' GetPublicKeyCertificateInput: type: object required: - KeyIdentifier title: GetPublicKeyCertificateInput properties: KeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the asymmetric key pair. GetKeyOutput: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/Key' - description: The key material, including the immutable and mutable data for the key. ListAliasesOutput: type: object required: - Aliases properties: Aliases: allOf: - $ref: '#/components/schemas/Aliases' - description: The list of aliases. Each alias describes the KeyArn contained within. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token for the next set of results, or an empty or null value if there are no more results. ImportTr34KeyBlock: type: object required: - CertificateAuthorityPublicKeyIdentifier - ImportToken - KeyBlockFormat - SigningKeyCertificate - WrappedKeyBlock properties: CertificateAuthorityPublicKeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import. ImportToken: allOf: - $ref: '#/components/schemas/ImportTokenId' - description: The import token that initiates key import into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account. KeyBlockFormat: allOf: - $ref: '#/components/schemas/Tr34KeyBlockFormat' - description: The key block format to use during key import. The only value allowed is X9_TR34_2012. RandomNonce: allOf: - $ref: '#/components/schemas/HexLength16' - description: A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass. SigningKeyCertificate: allOf: - $ref: '#/components/schemas/CertificateType' - description: The public key component in PEM certificate format of the private key that signs the KDH TR-34 wrapped key block. WrappedKeyBlock: allOf: - $ref: '#/components/schemas/Tr34WrappedKeyBlock' - description: The TR-34 wrapped key block to import. description: Parameter information for key material import using TR-34 standard. ExportKeyInput: type: object required: - ExportKeyIdentifier - KeyMaterial title: ExportKeyInput properties: ExportKeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the key under export from Amazon Web Services Payment Cryptography. KeyMaterial: allOf: - $ref: '#/components/schemas/ExportKeyMaterial' - description: The key block format type, for example, TR-34 or TR-31, to use during key material export. KeyClass: type: string enum: - SYMMETRIC_KEY - ASYMMETRIC_KEY_PAIR - PRIVATE_KEY - PUBLIC_KEY MaxResults: type: integer minimum: 1 maximum: 100 KeyModesOfUse: type: object properties: Decrypt: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data. DeriveKey: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys. Encrypt: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data. Generate: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys. NoRestrictions: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage. Sign: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing. Unwrap: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys. Verify: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures. Wrap: allOf: - $ref: '#/components/schemas/PrimitiveBoolean' - description: Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys. description: The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec. GetParametersForImportInput: type: object required: - KeyMaterialType - WrappingKeyAlgorithm title: GetParametersForImportInput properties: KeyMaterialType: allOf: - $ref: '#/components/schemas/KeyMaterialType' - description: The key block format type such as TR-34 or TR-31 to use during key material import. Import token is only required for TR-34 key import TR34_KEY_BLOCK. Import token is not required for TR-31 key import. WrappingKeyAlgorithm: allOf: - $ref: '#/components/schemas/KeyAlgorithm' - description: The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import within the TR-34 key block cryptogram. RSA_2048 is the only wrapping key algorithm allowed. PrimitiveBoolean: type: boolean KeyState: type: string enum: - CREATE_IN_PROGRESS - CREATE_COMPLETE - DELETE_PENDING - DELETE_COMPLETE description: Defines the state of a key Boolean: type: boolean Key: type: object required: - CreateTimestamp - Enabled - Exportable - KeyArn - KeyAttributes - KeyCheckValue - KeyCheckValueAlgorithm - KeyOrigin - KeyState properties: CreateTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time when the key was created. DeletePendingTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion. DeleteTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted. Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Specifies whether the key is enabled. ' Exportable: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether the key is exportable. This data is immutable after the key is created. KeyArn: allOf: - $ref: '#/components/schemas/KeyArn' - description: The Amazon Resource Name (ARN) of the key. KeyAttributes: allOf: - $ref: '#/components/schemas/KeyAttributes' - description: The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created. KeyCheckValue: allOf: - $ref: '#/components/schemas/KeyCheckValue' - description: The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram. KeyCheckValueAlgorithm: allOf: - $ref: '#/components/schemas/KeyCheckValueAlgorithm' - description: The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. KeyOrigin: allOf: - $ref: '#/components/schemas/KeyOrigin' - description: The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL. KeyState: allOf: - $ref: '#/components/schemas/KeyState' - description: The state of key that is being created or deleted. UsageStartTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations. UsageStopTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations. description: Metadata about an Amazon Web Services Payment Cryptography key. DeleteKeyOutput: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/Key' - description: The KeyARN of the key that is scheduled for deletion. KeyUsage: type: string enum: - TR31_B0_BASE_DERIVATION_KEY - TR31_C0_CARD_VERIFICATION_KEY - TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY - TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION - TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS - TR31_E1_EMV_MKEY_CONFIDENTIALITY - TR31_E2_EMV_MKEY_INTEGRITY - TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS - TR31_E5_EMV_MKEY_CARD_PERSONALIZATION - TR31_E6_EMV_MKEY_OTHER - TR31_K0_KEY_ENCRYPTION_KEY - TR31_K1_KEY_BLOCK_PROTECTION_KEY - TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT - TR31_M3_ISO_9797_3_MAC_KEY - TR31_M6_ISO_9797_5_CMAC_KEY - TR31_M7_HMAC_KEY - TR31_P0_PIN_ENCRYPTION_KEY - TR31_P1_PIN_GENERATION_KEY - TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE - TR31_V1_IBM3624_PIN_VERIFICATION_KEY - TR31_V2_VISA_PIN_VERIFICATION_KEY - TR31_K2_TR34_ASYMMETRIC_KEY ListTagsForResourceOutput: type: object required: - Tags properties: NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token for the next set of results, or an empty or null value if there are no more results. Tags: allOf: - $ref: '#/components/schemas/Tags' - description: The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag. WrappedKey: type: object required: - KeyMaterial - WrappedKeyMaterialFormat - WrappingKeyArn properties: KeyMaterial: allOf: - $ref: '#/components/schemas/KeyMaterial' - description: Parameter information for generating a wrapped key using TR-31 or TR-34 standard. WrappedKeyMaterialFormat: allOf: - $ref: '#/components/schemas/WrappedKeyMaterialFormat' - description: The key block format of a wrapped key. WrappingKeyArn: allOf: - $ref: '#/components/schemas/KeyArn' - description: The KeyARN of the wrapped key. description: Parameter information for generating a wrapped key using TR-31 or TR-34 standard. UpdateAliasInput: type: object required: - AliasName title: UpdateAliasInput properties: AliasName: allOf: - $ref: '#/components/schemas/AliasName' - description: The alias whose associated key is changing. KeyArn: allOf: - $ref: '#/components/schemas/KeyArn' - description: The KeyARN for the key that you are updating or removing from the alias. Tag: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: The key of the tag. Value: allOf: - $ref: '#/components/schemas/TagValue' - description: The value of the tag. description: A structure that contains information about a tag. CreateKeyOutput: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/Key' - description: The key material that contains all the key attributes. ImportKeyMaterial: type: object properties: RootCertificatePublicKey: allOf: - $ref: '#/components/schemas/RootCertificatePublicKey' - description: Parameter information for root public key certificate import. Tr31KeyBlock: allOf: - $ref: '#/components/schemas/ImportTr31KeyBlock' - description: Parameter information for key material import using TR-31 standard. Tr34KeyBlock: allOf: - $ref: '#/components/schemas/ImportTr34KeyBlock' - description: Parameter information for key material import using TR-34 standard. TrustedCertificatePublicKey: allOf: - $ref: '#/components/schemas/TrustedCertificatePublicKey' - description: Parameter information for trusted public key certificate import. description: Parameter information for key material import. HexLength16: type: string pattern: ^[0-9A-F]+$ minLength: 16 maxLength: 16 KeyCheckValueAlgorithm: type: string enum: - CMAC - ANSI_X9_24 GetAliasOutput: type: object required: - Alias properties: Alias: allOf: - $ref: '#/components/schemas/Alias' - description: The alias of the Amazon Web Services Payment Cryptography key. ImportTr31KeyBlock: type: object required: - WrappedKeyBlock - WrappingKeyIdentifier properties: WrappedKeyBlock: allOf: - $ref: '#/components/schemas/Tr31WrappedKeyBlock' - description: The TR-34 wrapped key block to import. WrappingKeyIdentifier: allOf: - $ref: '#/components/schemas/KeyArnOrKeyAliasType' - description: The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import. description: Parameter information for key material import using TR-31 standard. TagValue: type: string minLength: 0 maxLength: 256 KeySummary: type: object required: - Enabled - Exportable - KeyArn - KeyAttributes - KeyCheckValue - KeyState properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Specifies whether the key is enabled. ' Exportable: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether the key is exportable. This data is immutable after the key is created. KeyArn: allOf: - $ref: '#/components/schemas/KeyArn' - description: The Amazon Resource Name (ARN) of the key. KeyAttributes: allOf: - $ref: '#/components/schemas/KeyAttributes' - description: The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created. KeyCheckValue: allOf: - $ref: '#/components/schemas/KeyCheckValue' - description: The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram. KeyState: allOf: - $ref: '#/components/schemas/KeyState' - description: The state of an Amazon Web Services Payment Cryptography that is being created or deleted. description: Metadata about an Amazon Web Services Payment Cryptography key. ConflictException: {} AccessDeniedException: {} parameters: X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/payment-cryptography/ x-hasEquivalentPaths: true