Class: Aws::PaymentCryptography::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-paymentcryptography/client.rb

Overview

An API client for PaymentCryptography. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::PaymentCryptography::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::PaymentCryptography::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::PaymentCryptography::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



480
481
482
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 480

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



3526
3527
3528
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3526

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



3529
3530
3531
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3529

def errors_module
  Errors
end

Instance Method Details

#add_key_replication_regions(params = {}) ⇒ Types::AddKeyReplicationRegionsOutput

Adds replication Amazon Web Services Regions to an existing Amazon Web Services Payment Cryptography key, enabling the key to be used for cryptographic operations in additional Amazon Web Services Regions.

Multi-Region key replication][1

allow you to use the same key

material across multiple Amazon Web Services Regions, providing lower latency for applications distributed across regions. When you add Replication Regions, Amazon Web Services Payment Cryptography securely replicates the key material to the specified Amazon Web Services Regions.

The key must be in an active state to add Replication Regions. You can add multiple regions in a single operation, and the key will be available for use in those regions once replication is complete.

**Cross-account use:** This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • RemoveKeyReplicationRegions][3
  • EnableDefaultKeyReplicationRegions][4
  • GetDefaultKeyReplicationRegions][5

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_RemoveKeyReplicationRegions.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_EnableDefaultKeyReplicationRegions.html [5]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetDefaultKeyReplicationRegions.html

Examples:

Request syntax with placeholder values


resp = client.add_key_replication_regions({
  key_identifier: "KeyArnOrKeyAliasType", # required
  replication_regions: ["Region"], # required
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The key identifier (ARN or alias) of the key for which to add replication regions.

    This key must exist and be in a valid state for replication operations.

  • :replication_regions (required, Array<String>) —

    The list of Amazon Web Services Regions to add to the key’s replication configuration.

    Each region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available. The key will be replicated to these regions, allowing cryptographic operations to be performed closer to your applications.

Returns:

See Also:



590
591
592
593
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 590

def add_key_replication_regions(params = {}, options = {})
  req = build_request(:add_key_replication_regions, params)
  req.send_request(options)
end

#associate_mpa_team(params = {}) ⇒ Types::AssociateMpaTeamOutput

Associates a Multi-Party Approval (MPA) team with a protected operation. For more information, see [Multi-Party Approval] in the *Amazon Web Services Payment Cryptography User Guide.*

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • DisassociateMpaTeam][2
  • GetMpaTeamAssociation][3

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/mpa.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisassociateMpaTeam.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetMpaTeamAssociation.html

Examples:

Request syntax with placeholder values


resp = client.associate_mpa_team({
  action: "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE", # required, accepts IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE
  mpa_team_arn: "MpaTeamArn", # required
  requester_comment: "MpaRequesterComment",
})

Response structure


resp.mpa_team_association.action #=> String, one of "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE"
resp.mpa_team_association.mpa_team_arn #=> String
resp.mpa_team_association.association_state #=> String, one of "ACTIVE", "UPDATE_PENDING", "DELETE_PENDING"
resp.mpa_team_association.mpa_status.mpa_session_arn #=> String
resp.mpa_team_association.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.mpa_team_association.mpa_status.initiation_date #=> Time
resp.mpa_team_association.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action (required, String) —

    The protected operation to associate with the MPA team. Currently, the only supported value is ‘IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE`.

  • :mpa_team_arn (required, String) —

    The ARN of the MPA team to associate with the protected operation.

  • :requester_comment (String) —

    The comment from the requester explaining the reason for the association.

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

Returns:

See Also:



655
656
657
658
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 655

def associate_mpa_team(params = {}, options = {})
  req = build_request(:associate_mpa_team, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3499

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::PaymentCryptography')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-paymentcryptography'
  context[:gem_version] = '1.54.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_alias(params = {}) ⇒ Types::CreateAliasOutput

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][1

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][4
  • GetAlias][6
  • ListAliases][5
  • UpdateAlias][3

[1]: docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_EncryptData.html [2]: docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_DecryptData.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html [5]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html [6]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html

Examples:

Request syntax with placeholder values


resp = client.create_alias({
  alias_name: "AliasName", # required
  key_arn: "KeyArn",
})

Response structure


resp.alias.alias_name #=> String
resp.alias.key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias_name (required, String) —

    A friendly name that you can use to refer to 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 personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

  • :key_arn (String) —

    The ‘KeyARN` of the key to associate with the alias.

Returns:

See Also:



732
733
734
735
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 732

def create_alias(params = {}, options = {})
  req = build_request(:create_alias, params)
  req.send_request(options)
end

#create_key(params = {}) ⇒ Types::CreateKeyOutput

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 define 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`). 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.

For information about valid combinations of key attributes, see

Understanding key attributes][1

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.

You can use the ‘CreateKey` operation to generate an ECC (Elliptic Curve Cryptography) key pair used for establishing an ECDH (Elliptic Curve Diffie-Hellman) key agreement between two parties. In the ECDH key agreement process, both parties generate their own ECC key pair with key usage K3 and exchange the public keys. Each party then use their private key, the received public key from the other party, and the key derivation parameters including key derivation function, hash algorithm, derivation data, and key algorithm to derive a shared key.

To maintain the single-use principle of cryptographic keys in payments, ECDH derived keys should not be used for multiple purposes, such as a ‘TR31_P0_PIN_ENCRYPTION_KEY` and `TR31_K1_KEY_BLOCK_PROTECTION_KEY`. When creating ECC key pairs in Amazon Web Services Payment Cryptography you can optionally set the `DeriveKeyUsage` parameter, which defines the key usage bound to the symmetric key that will be derived using the ECC key pair.

**Cross-account use**: This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • DeleteKey][2
  • GetKey][3
  • ListKeys][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html

Examples:

Request syntax with placeholder values


resp = client.create_key({
  key_attributes: { # required
    key_usage: "TR31_B0_BASE_DERIVATION_KEY", # required, accepts 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_M0_ISO_16609_MAC_KEY, TR31_M3_ISO_9797_3_MAC_KEY, TR31_M1_ISO_9797_1_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
    key_class: "SYMMETRIC_KEY", # required, accepts SYMMETRIC_KEY, ASYMMETRIC_KEY_PAIR, PRIVATE_KEY, PUBLIC_KEY
    key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
    key_modes_of_use: { # required
      encrypt: false,
      decrypt: false,
      wrap: false,
      unwrap: false,
      generate: false,
      sign: false,
      verify: false,
      derive_key: false,
      no_restrictions: false,
    },
  },
  key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  exportable: false, # required
  enabled: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  derive_key_usage: "TR31_B0_BASE_DERIVATION_KEY", # accepts TR31_B0_BASE_DERIVATION_KEY, TR31_C0_CARD_VERIFICATION_KEY, TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY, 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_M3_ISO_9797_3_MAC_KEY, TR31_M1_ISO_9797_1_MAC_KEY, TR31_M6_ISO_9797_5_CMAC_KEY, TR31_M7_HMAC_KEY, TR31_P0_PIN_ENCRYPTION_KEY, TR31_P1_PIN_GENERATION_KEY, TR31_V1_IBM3624_PIN_VERIFICATION_KEY, TR31_V2_VISA_PIN_VERIFICATION_KEY
  replication_regions: ["Region"],
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_attributes (required, Types::KeyAttributes) —

    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.

  • :key_check_value_algorithm (String) —

    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

  • :exportable (required, Boolean) —

    Specifies whether the key is exportable from the service.

  • :enabled (Boolean) —

    Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.

  • :tags (Array<Types::Tag>) —

    Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the [TagResource] operation.

    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.

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

    <note markdown=“1”> Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

    </note>

    [1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html

  • :derive_key_usage (String) —

    The intended cryptographic usage of keys derived from the ECC key pair to be created.

    After creating an ECC key pair, you cannot change the intended cryptographic usage of keys derived from it using ECDH.

  • :replication_regions (Array<String>) —

    A list of Amazon Web Services Regions for key replication operations.

    Each region in the list must be a valid Amazon Web Services Region identifier where Amazon Web Services Payment Cryptography is available. This list is used to specify which regions should be added to or removed from a key’s replication configuration.

Returns:

See Also:



940
941
942
943
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 940

def create_key(params = {}, options = {})
  req = build_request(:create_key, params)
  req.send_request(options)
end

#delete_alias(params = {}) ⇒ Struct

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 [UpdateAlias] operation. To change the alias of a key, first use [DeleteAlias] to delete the current alias and then use

CreateAlias][3

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][3
  • GetAlias][4
  • ListAliases][5
  • UpdateAlias][1

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html [5]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html

Examples:

Request syntax with placeholder values


resp = client.delete_alias({
  alias_name: "AliasName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias_name (required, String) —

    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`.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



991
992
993
994
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 991

def delete_alias(params = {}, options = {})
  req = build_request(:delete_alias, params)
  req.send_request(options)
end

#delete_key(params = {}) ⇒ Types::DeleteKeyOutput

Deletes the key material and 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 set using ‘DeleteKeyInDays`. The default waiting period is 7 days. During the waiting period, the `KeyState` is `DELETE_PENDING`. After the key is deleted, the `KeyState` is `DELETE_COMPLETE`.

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • RestoreKey][3
  • StartKeyUsage][4
  • StopKeyUsage][1

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_RestoreKey.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html

Examples:

Request syntax with placeholder values


resp = client.delete_key({
  key_identifier: "KeyArnOrKeyAliasType", # required
  delete_key_in_days: 1,
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The ‘KeyARN` of the key that is scheduled for deletion.

  • :delete_key_in_days (Integer) —

    The waiting period for key deletion. The default value is seven days.

Returns:

See Also:



1095
1096
1097
1098
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1095

def delete_key(params = {}, options = {})
  req = build_request(:delete_key, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Struct

Removes the resource-based policy attached to an Amazon Web Services Payment Cryptography key.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • PutResourcePolicy][1
  • GetResourcePolicy][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_PutResourcePolicy.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetResourcePolicy.html

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "ResourceArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ‘KeyARN` of the key whose resource-based policy you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1133
1134
1135
1136
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1133

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#disable_default_key_replication_regions(params = {}) ⇒ Types::DisableDefaultKeyReplicationRegionsOutput

Disables [Multi-Region key replication] settings for the specified Amazon Web Services Regions in your Amazon Web Services account, preventing new keys from being automatically replicated to those regions.

After disabling Multi-Region key replication for specific regions, new keys created in your account will not be automatically replicated to those regions. You can still manually add replication to those regions for individual keys using the [AddKeyReplicationRegions] operation.

This operation does not affect existing keys or their current replication configuration.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • EnableDefaultKeyReplicationRegions][3
  • GetDefaultKeyReplicationRegions][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AddKeyReplicationRegions.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_EnableDefaultKeyReplicationRegions.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetDefaultKeyReplicationRegions.html

Examples:

Request syntax with placeholder values


resp = client.disable_default_key_replication_regions({
  replication_regions: ["Region"], # required
})

Response structure


resp.enabled_replication_regions #=> Array
resp.enabled_replication_regions[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :replication_regions (required, Array<String>) —

    The list of Amazon Web Services Regions to remove from the account’s default replication regions.

    New keys created after this operation will not automatically be replicated to these regions, though existing keys with replication to these regions will be unaffected.

Returns:

See Also:



1194
1195
1196
1197
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1194

def disable_default_key_replication_regions(params = {}, options = {})
  req = build_request(:disable_default_key_replication_regions, params)
  req.send_request(options)
end

#disassociate_mpa_team(params = {}) ⇒ Types::DisassociateMpaTeamOutput

Removes the association between a Multi-Party Approval (MPA) team and a protected operation.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • AssociateMpaTeam][1
  • GetMpaTeamAssociation][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AssociateMpaTeam.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetMpaTeamAssociation.html

Examples:

Request syntax with placeholder values


resp = client.disassociate_mpa_team({
  action: "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE", # required, accepts IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE
  requester_comment: "MpaRequesterComment",
})

Response structure


resp.mpa_team_association.action #=> String, one of "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE"
resp.mpa_team_association.mpa_team_arn #=> String
resp.mpa_team_association.association_state #=> String, one of "ACTIVE", "UPDATE_PENDING", "DELETE_PENDING"
resp.mpa_team_association.mpa_status.mpa_session_arn #=> String
resp.mpa_team_association.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.mpa_team_association.mpa_status.initiation_date #=> Time
resp.mpa_team_association.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action (required, String) —

    The protected operation to disassociate from the MPA team. Currently, the only supported value is ‘IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE`.

  • :requester_comment (String) —

    The comment from the requester explaining the reason for the disassociation.

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

Returns:

See Also:



1253
1254
1255
1256
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1253

def disassociate_mpa_team(params = {}, options = {})
  req = build_request(:disassociate_mpa_team, params)
  req.send_request(options)
end

#enable_default_key_replication_regions(params = {}) ⇒ Types::EnableDefaultKeyReplicationRegionsOutput

Enables [Multi-Region key replication] settings for your Amazon Web Services account, causing new keys to be automatically replicated to the specified Amazon Web Services Regions when created.

When Multi-Region key replication are enabled, any new keys created in your account will automatically be replicated to these regions unless you explicitly override this behavior during key creation. This simplifies key management for applications that operate across multiple regions.

Existing keys are not affected by this operation - only keys created after enabling default replication will be automatically replicated.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • DisableDefaultKeyReplicationRegions][2
  • GetDefaultKeyReplicationRegions][3

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisableDefaultKeyReplicationRegions.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetDefaultKeyReplicationRegions.html

Examples:

Request syntax with placeholder values


resp = client.enable_default_key_replication_regions({
  replication_regions: ["Region"], # required
})

Response structure


resp.enabled_replication_regions #=> Array
resp.enabled_replication_regions[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1317
1318
1319
1320
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1317

def enable_default_key_replication_regions(params = {}, options = {})
  req = build_request(:enable_default_key_replication_regions, params)
  req.send_request(options)
end

#export_key(params = {}) ⇒ Types::ExportKeyOutput

Exports a key from Amazon Web Services Payment Cryptography.

Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ‘ExportKey` you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. 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

For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.

PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see [Importing and exporting keys] in the *Amazon Web Services Payment Cryptography User Guide*.

You can also use ‘ExportKey` functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and `ExportDukptInitialKey` attribute KSN (`KeySerialNumber`). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.

For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The ‘KeyVersion` within `KeyBlockHeaders` indicates the version of the key within the key block. Furthermore, `KeyExportability` within `KeyBlockHeaders` can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

The ‘OptionalBlocks` contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to [ASC X9.143-2022].

<note markdown=“1”> Data included in key block headers is signed but transmitted in clear text. Sensitive or confidential information should not be included in optional blocks. Refer to ASC X9.143-2022 standard for information on allowed data type.

</note>

**To export initial keys (KEK) or IPEK using TR-34**

Using this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. 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 Device (KRD). During key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key.

To initiate TR-34 key export, the KRD must obtain an export token by calling [GetParametersForExport]. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 30 days.

Next the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling [ImportKey] for ‘RootCertificatePublicKey`. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section [Exporting symmetric keys] in the *Amazon Web Services Payment Cryptography User Guide*.

Set the following parameters:

  • ‘ExportAttributes`: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.

  • ‘ExportKeyIdentifier`: The `KeyARN` of the KEK or BDK (in case of IPEK) under export.

  • ‘KeyMaterial`: Use `Tr34KeyBlock` parameters.

  • ‘CertificateAuthorityPublicKeyIdentifier`: The `KeyARN` of the certificate chain that signed the KRD wrapping key certificate.

  • ‘ExportToken`: Obtained from KDH by calling [GetParametersForImport].

  • ‘WrappingKeyCertificate`: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.

When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock.

**To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap**

Using this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling [ImportKey] for ‘RootCertificatePublicKey`.

Next call ‘ExportKey` and set the following parameters:

  • ‘CertificateAuthorityPublicKeyIdentifier`: The `KeyARN` of the certificate chain that signed wrapping key certificate.

  • ‘KeyMaterial`: Set to `KeyCryptogram`.

  • ‘WrappingKeyCertificate`: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.

When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram.

**To export working keys or IPEK using TR-31**

Using this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use [CreateKey] or [ImportKey].

Set the following parameters:

  • ‘ExportAttributes`: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.

  • ‘ExportKeyIdentifier`: The `KeyARN` of the KEK or BDK (in case of IPEK) under export.

  • ‘KeyMaterial`: Use `Tr31KeyBlock` parameters.

**To export working keys using ECDH**

You can also use ECDH key agreement to export working keys in a TR-31 keyblock, where the wrapping key is an ECDH derived key.

To initiate a TR-31 key export using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling ‘CreateKey`. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling `ImportKey` with input `RootCertificatePublicKey` for root CA or `TrustedPublicKey` for intermediate CA. You can then complete a TR-31 key export by deriving a shared wrapping key using the service ECC key pair, public certificate of your ECC key pair outside of Amazon Web Services Payment Cryptography, and the key derivation parameters including key derivation function, hash algorithm, derivation data, key algorithm.

  • ‘KeyMaterial`: Use `DiffieHellmanTr31KeyBlock` parameters.

  • ‘PrivateKeyIdentifier`: The `KeyArn` of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.

  • ‘PublicKeyCertificate`: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.

  • ‘CertificateAuthorityPublicKeyIdentifier`: The `keyARN` of the CA that signed the public key certificate of the receiving ECC key pair.

When this operation is successful, Amazon Web Services Payment Cryptography returns the working key as a TR-31 WrappedKeyBlock, where the wrapping key is the ECDH derived key.

**Cross-account use:** This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • GetParametersForExport][3
  • ImportKey][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-importexport.html [2]: webstore.ansi.org/standards/ascx9/ansix91432022 [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html [6]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html [7]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [8]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html

Examples:

Request syntax with placeholder values


resp = client.export_key({
  key_material: { # required
    tr_31_key_block: {
      wrapping_key_identifier: "KeyArnOrKeyAliasType", # required
      key_block_headers: {
        key_modes_of_use: {
          encrypt: false,
          decrypt: false,
          wrap: false,
          unwrap: false,
          generate: false,
          sign: false,
          verify: false,
          derive_key: false,
          no_restrictions: false,
        },
        key_exportability: "EXPORTABLE", # accepts EXPORTABLE, NON_EXPORTABLE, SENSITIVE
        key_version: "KeyVersion",
        optional_blocks: {
          "OptionalBlockId" => "OptionalBlockValue",
        },
      },
    },
    tr_34_key_block: {
      certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
      wrapping_key_certificate: "CertificateType", # required
      export_token: "ExportTokenId",
      signing_key_identifier: "KeyArnOrKeyAliasType",
      signing_key_certificate: "CertificateType",
      key_block_format: "X9_TR34_2012", # required, accepts X9_TR34_2012
      random_nonce: "EvenHexLengthBetween16And32",
      key_block_headers: {
        key_modes_of_use: {
          encrypt: false,
          decrypt: false,
          wrap: false,
          unwrap: false,
          generate: false,
          sign: false,
          verify: false,
          derive_key: false,
          no_restrictions: false,
        },
        key_exportability: "EXPORTABLE", # accepts EXPORTABLE, NON_EXPORTABLE, SENSITIVE
        key_version: "KeyVersion",
        optional_blocks: {
          "OptionalBlockId" => "OptionalBlockValue",
        },
      },
    },
    key_cryptogram: {
      certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
      wrapping_key_certificate: "CertificateType", # required
      wrapping_spec: "RSA_OAEP_SHA_256", # accepts RSA_OAEP_SHA_256, RSA_OAEP_SHA_512
    },
    diffie_hellman_tr_31_key_block: {
      private_key_identifier: "KeyArnOrKeyAliasType", # required
      certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
      public_key_certificate: "CertificateType", # required
      derive_key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
      key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
      key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
      derivation_data: { # required
        shared_information: "SharedInformation",
      },
      key_block_headers: {
        key_modes_of_use: {
          encrypt: false,
          decrypt: false,
          wrap: false,
          unwrap: false,
          generate: false,
          sign: false,
          verify: false,
          derive_key: false,
          no_restrictions: false,
        },
        key_exportability: "EXPORTABLE", # accepts EXPORTABLE, NON_EXPORTABLE, SENSITIVE
        key_version: "KeyVersion",
        optional_blocks: {
          "OptionalBlockId" => "OptionalBlockValue",
        },
      },
    },
    as_2805_key_cryptogram: {
      wrapping_key_identifier: "KeyArnOrKeyAliasType", # required
      as_2805_key_variant: "TERMINAL_MAJOR_KEY_VARIANT_00", # required, accepts TERMINAL_MAJOR_KEY_VARIANT_00, PIN_ENCRYPTION_KEY_VARIANT_28, MESSAGE_AUTHENTICATION_KEY_VARIANT_24, DATA_ENCRYPTION_KEY_VARIANT_22
    },
  },
  export_key_identifier: "KeyArnOrKeyAliasType", # required
  export_attributes: {
    export_dukpt_initial_key: {
      key_serial_number: "HexLength20Or24", # required
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
})

Response structure


resp.wrapped_key.wrapping_key_arn #=> String
resp.wrapped_key.wrapped_key_material_format #=> String, one of "KEY_CRYPTOGRAM", "TR31_KEY_BLOCK", "TR34_KEY_BLOCK"
resp.wrapped_key.key_material #=> String
resp.wrapped_key.key_check_value #=> String
resp.wrapped_key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_material (required, Types::ExportKeyMaterial) —

    The key block format type, for example, TR-34 or TR-31, to use during key material export.

  • :export_key_identifier (required, String) —

    The ‘KeyARN` of the key under export from Amazon Web Services Payment Cryptography.

  • :export_attributes (Types::ExportAttributes) —

    The attributes for IPEK generation during export.

Returns:

See Also:



1663
1664
1665
1666
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1663

def export_key(params = {}, options = {})
  req = build_request(:export_key, params)
  req.send_request(options)
end

#get_alias(params = {}) ⇒ Types::GetAliasOutput

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][1
  • DeleteAlias][2
  • ListAliases][3
  • UpdateAlias][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html

Examples:

Request syntax with placeholder values


resp = client.get_alias({
  alias_name: "AliasName", # required
})

Response structure


resp.alias.alias_name #=> String
resp.alias.key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias_name (required, String) —

    The alias of the Amazon Web Services Payment Cryptography key.

Returns:

See Also:



1713
1714
1715
1716
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1713

def get_alias(params = {}, options = {})
  req = build_request(:get_alias, params)
  req.send_request(options)
end

#get_certificate_signing_request(params = {}) ⇒ Types::GetCertificateSigningRequestOutput

Creates a certificate signing request (CSR) from a key pair.

Examples:

Request syntax with placeholder values


resp = client.get_certificate_signing_request({
  key_identifier: "KeyArnOrKeyAliasType", # required
  signing_algorithm: "SHA224", # required, accepts SHA224, SHA256, SHA384, SHA512
  certificate_subject: { # required
    common_name: "CertificateSubjectTypeCommonNameString", # required
    organization_unit: "CertificateSubjectTypeOrganizationUnitString",
    organization: "CertificateSubjectTypeOrganizationString",
    city: "CertificateSubjectTypeCityString",
    country: "CertificateSubjectTypeCountryString",
    state_or_province: "CertificateSubjectTypeStateOrProvinceString",
    email_address: "CertificateSubjectTypeEmailAddressString",
  },
})

Response structure


resp.certificate_signing_request #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    Asymmetric key used for generating the certificate signing request

  • :signing_algorithm (required, String) —

    The cryptographic algorithm used to sign your CSR.

  • :certificate_subject (required, Types::CertificateSubjectType) —

    The metadata used to create the CSR.

Returns:

See Also:



1757
1758
1759
1760
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1757

def get_certificate_signing_request(params = {}, options = {})
  req = build_request(:get_certificate_signing_request, params)
  req.send_request(options)
end

#get_default_key_replication_regions(params = {}) ⇒ Types::GetDefaultKeyReplicationRegionsOutput

Retrieves the list of Amazon Web Services Regions where [Multi-Region key replication] is currently enabled for your Amazon Web Services account.

This operation returns the current Multi-Region key replication configuration. New keys created in your account will be automatically replicated to these regions unless explicitly overridden during key creation.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • EnableDefaultKeyReplicationRegions][2
  • DisableDefaultKeyReplicationRegions][3

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_EnableDefaultKeyReplicationRegions.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisableDefaultKeyReplicationRegions.html

Examples:

Response structure


resp.enabled_replication_regions #=> Array
resp.enabled_replication_regions[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1799
1800
1801
1802
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1799

def get_default_key_replication_regions(params = {}, options = {})
  req = build_request(:get_default_key_replication_regions, params)
  req.send_request(options)
end

#get_key(params = {}) ⇒ Types::GetKeyOutput

Gets the key metadata for an Amazon Web Services Payment Cryptography key, including the immutable and mutable attributes specified when the key was created. Returns key metadata including attributes, state, and timestamps, but does not return the actual cryptographic key material.

**Cross-account use:** This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • CreateKey][2
  • DeleteKey][3
  • ListKeys][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html

Examples:

Request syntax with placeholder values


resp = client.get_key({
  key_identifier: "KeyArnOrKeyAliasType", # required
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The ‘KeyARN` of the Amazon Web Services Payment Cryptography key.

Returns:

See Also:



1883
1884
1885
1886
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1883

def get_key(params = {}, options = {})
  req = build_request(:get_key, params)
  req.send_request(options)
end

#get_mpa_team_association(params = {}) ⇒ Types::GetMpaTeamAssociationOutput

Returns the Multi-Party Approval (MPA) team association for a protected operation.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • AssociateMpaTeam][1
  • DisassociateMpaTeam][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AssociateMpaTeam.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisassociateMpaTeam.html

Examples:

Request syntax with placeholder values


resp = client.get_mpa_team_association({
  action: "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE", # required, accepts IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE
})

Response structure


resp.mpa_team_association.action #=> String, one of "IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE"
resp.mpa_team_association.mpa_team_arn #=> String
resp.mpa_team_association.association_state #=> String, one of "ACTIVE", "UPDATE_PENDING", "DELETE_PENDING"
resp.mpa_team_association.mpa_status.mpa_session_arn #=> String
resp.mpa_team_association.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.mpa_team_association.mpa_status.initiation_date #=> Time
resp.mpa_team_association.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action (required, String) —

    The protected operation whose MPA team association you want to retrieve. Currently, the only supported value is ‘IMPORT_ROOT_PUBLIC_KEY_CERTIFICATE`.

Returns:

See Also:



1934
1935
1936
1937
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 1934

def get_mpa_team_association(params = {}, options = {})
  req = build_request(:get_mpa_team_association, params)
  req.send_request(options)
end

#get_parameters_for_export(params = {}) ⇒ Types::GetParametersForExportOutput

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 30 days. You can use the same export token to export multiple keys from your service account.

To return a previously generated export token and signing key certificate instead of generating new ones, set ‘ReuseLastGeneratedToken` to `true`.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • ExportKey][1
  • GetParametersForImport][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html

Examples:

Request syntax with placeholder values


resp = client.get_parameters_for_export({
  key_material_type: "TR34_KEY_BLOCK", # required, accepts TR34_KEY_BLOCK, TR31_KEY_BLOCK, ROOT_PUBLIC_KEY_CERTIFICATE, TRUSTED_PUBLIC_KEY_CERTIFICATE, KEY_CRYPTOGRAM
  signing_key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
  reuse_last_generated_token: false,
})

Response structure


resp.signing_key_certificate #=> String
resp.signing_key_certificate_chain #=> String
resp.signing_key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.export_token #=> String
resp.parameters_valid_until_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_material_type (required, String) —

    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.

  • :signing_key_algorithm (required, String) —

    The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block. ‘RSA_2048` is the only signing key algorithm allowed.

  • :reuse_last_generated_token (Boolean) —

    Specifies whether to reuse the existing export token and signing key certificate. If set to ‘true` and a valid export token exists for the same key material type and signing key algorithm with at least 7 days of remaining validity, the existing token and signing key certificate are returned. Otherwise, a new export token and signing key certificate are generated. The default value is `false`, which generates a new export token and signing key certificate on every call.

Returns:

See Also:



2015
2016
2017
2018
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2015

def get_parameters_for_export(params = {}, options = {})
  req = build_request(:get_parameters_for_export, params)
  req.send_request(options)
end

#get_parameters_for_import(params = {}) ⇒ Types::GetParametersForImportOutput

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

The wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling [ImportKey]. The import token expires in 30 days. You can use the same import token to import multiple keys into your service account.

To return a previously generated import token and wrapping key certificate instead of generating new ones, set ‘ReuseLastGeneratedToken` to `true`.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • GetParametersForExport][2
  • ImportKey][1

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html

Examples:

Request syntax with placeholder values


resp = client.get_parameters_for_import({
  key_material_type: "TR34_KEY_BLOCK", # required, accepts TR34_KEY_BLOCK, TR31_KEY_BLOCK, ROOT_PUBLIC_KEY_CERTIFICATE, TRUSTED_PUBLIC_KEY_CERTIFICATE, KEY_CRYPTOGRAM
  wrapping_key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
  reuse_last_generated_token: false,
})

Response structure


resp.wrapping_key_certificate #=> String
resp.wrapping_key_certificate_chain #=> String
resp.wrapping_key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.import_token #=> String
resp.parameters_valid_until_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_material_type (required, String) —

    The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock (‘TR34_KEY_BLOCK`) and RSA WrappedKeyCryptogram (`KEY_CRYPTOGRAM`).

    Import token is not required for TR-31, root public key cerificate or trusted public key certificate.

  • :wrapping_key_algorithm (required, String) —

    The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.

    At this time, ‘RSA_2048` is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, `RSA_2048`, `RSA_3072`, `RSA_4096` are the allowed algorithms for RSA WrappedKeyCryptogram import.

  • :reuse_last_generated_token (Boolean) —

    Specifies whether to reuse the existing import token and wrapping key certificate. If set to ‘true` and a valid import token exists for the same key material type and wrapping key algorithm with at least 7 days of remaining validity, the existing token and wrapping key certificate are returned. Otherwise, a new import token and wrapping key certificate are generated. The default value is `false`, which generates a new import token and wrapping key certificate on every call.

Returns:

See Also:



2104
2105
2106
2107
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2104

def get_parameters_for_import(params = {}, options = {})
  req = build_request(:get_parameters_for_import, params)
  req.send_request(options)
end

#get_public_key_certificate(params = {}) ⇒ Types::GetPublicKeyCertificateOutput

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html

Examples:

Request syntax with placeholder values


resp = client.get_public_key_certificate({
  key_identifier: "KeyArnOrKeyAliasType", # required
})

Response structure


resp.key_certificate #=> String
resp.key_certificate_chain #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The ‘KeyARN` of the asymmetric key pair.

Returns:

See Also:



2150
2151
2152
2153
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2150

def get_public_key_certificate(params = {}, options = {})
  req = build_request(:get_public_key_certificate, params)
  req.send_request(options)
end

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyOutput

Returns the resource-based policy attached to an Amazon Web Services Payment Cryptography key.

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • PutResourcePolicy][1
  • DeleteResourcePolicy][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_PutResourcePolicy.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteResourcePolicy.html

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.resource_arn #=> String
resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ‘KeyARN` of the key whose resource-based policy you want to retrieve.

Returns:

See Also:



2196
2197
2198
2199
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2196

def get_resource_policy(params = {}, options = {})
  req = build_request(:get_resource_policy, params)
  req.send_request(options)
end

#import_key(params = {}) ⇒ Types::ImportKeyOutput

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

Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ‘ImportKey` you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.

For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.

PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see [Importing and exporting keys] in the *Amazon Web Services Payment Cryptography User Guide*.

You can also import a *root public key certificate*, used to sign other public key certificates, or a *trusted public key certificate* under an already established root public key certificate.

**To import a public root key certificate**

Using this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.

Set the following parameters:

  • ‘KeyMaterial`: `RootCertificatePublicKey`

  • ‘KeyClass`: `PUBLIC_KEY`

  • ‘KeyModesOfUse`: `Verify`

  • ‘KeyUsage`: `TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE`

  • ‘PublicKeyCertificate`: The public key certificate in PEM format (base64 encoded) of the private root key under import.

**To import a trusted public key certificate**

The root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:

  • ‘KeyMaterial`: `TrustedCertificatePublicKey`

  • ‘CertificateAuthorityPublicKeyIdentifier`: `KeyArn` of the `RootCertificatePublicKey`.

  • ‘KeyModesOfUse` and `KeyUsage`: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.

  • ‘PublicKeyCertificate`: The trusted public key certificate in PEM format (base64 encoded) under import.

**To import initial keys (KEK or ZMK or similar) using TR-34**

Using this operation, you can import initial key using TR-34 asymmetric key exchange. 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 Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.

To initiate TR-34 key import, the KDH must obtain an import token by calling [GetParametersForImport]. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 30 days.

Next the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling ‘ImportKey` for `RootCertificatePublicKey`. For more information on TR-34 key import, see section [Importing symmetric keys] in the *Amazon Web Services Payment Cryptography User Guide*.

Set the following parameters:

  • ‘KeyMaterial`: Use `Tr34KeyBlock` parameters.

  • ‘CertificateAuthorityPublicKeyIdentifier`: The `KeyARN` of the certificate chain that signed the KDH signing key certificate.

  • ‘ImportToken`: Obtained from KRD by calling [GetParametersForImport].

  • ‘WrappedKeyBlock`: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.

  • ‘SigningKeyCertificate`: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.

**To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap**

Using this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call

GetParametersForImport][2

with ‘KeyMaterial` set to `KEY_CRYPTOGRAM`

to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 30 days.

You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call ‘ImportKey` with `KeyMaterial` set to `KEY_CRYPTOGRAM` and provide the `ImportToken` and `KeyAttributes` for the key under import.

**To import working keys using TR-31**

Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using [CreateKey]. To initiate a TR-31 key import, set the following parameters:

  • ‘KeyMaterial`: Use `Tr31KeyBlock` parameters.

  • ‘WrappedKeyBlock`: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography.

  • ‘WrappingKeyIdentifier`: The `KeyArn` of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.

**To import working keys using ECDH**

You can also use ECDH key agreement to import working keys as a TR-31 keyblock, where the wrapping key is an ECDH derived key.

To initiate a TR-31 key import using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling ‘CreateKey` and then `GetPublicKeyCertificate` to retrieve its public key certificate. Next, you can then generate a TR-31 WrappedKeyBlock using your own ECC key pair, the public certificate of the service’s ECC key pair, and the key derivation parameters including key derivation function, hash algorithm, derivation data, and key algorithm. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling ‘ImportKey` with input `RootCertificatePublicKey` for root CA or `TrustedPublicKey` for intermediate CA. To complete the TR-31 key import, you can use the following parameters. It is important that the ECDH key derivation parameters you use should match those used during import to derive the same shared wrapping key within Amazon Web Services Payment Cryptography.

  • ‘KeyMaterial`: Use `DiffieHellmanTr31KeyBlock` parameters.

  • ‘PrivateKeyIdentifier`: The `KeyArn` of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.

  • ‘PublicKeyCertificate`: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.

  • ‘CertificateAuthorityPublicKeyIdentifier`: The `keyARN` of the CA that signed the public key certificate of the receiving ECC key pair.

**Cross-account use:** This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • ExportKey][6
  • GetParametersForImport][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-importexport.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [6]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html

Examples:

Request syntax with placeholder values


resp = client.import_key({
  key_material: { # required
    root_certificate_public_key: {
      key_attributes: { # required
        key_usage: "TR31_B0_BASE_DERIVATION_KEY", # required, accepts 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_M0_ISO_16609_MAC_KEY, TR31_M3_ISO_9797_3_MAC_KEY, TR31_M1_ISO_9797_1_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
        key_class: "SYMMETRIC_KEY", # required, accepts SYMMETRIC_KEY, ASYMMETRIC_KEY_PAIR, PRIVATE_KEY, PUBLIC_KEY
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
        key_modes_of_use: { # required
          encrypt: false,
          decrypt: false,
          wrap: false,
          unwrap: false,
          generate: false,
          sign: false,
          verify: false,
          derive_key: false,
          no_restrictions: false,
        },
      },
      public_key_certificate: "CertificateType", # required
    },
    trusted_certificate_public_key: {
      key_attributes: { # required
        key_usage: "TR31_B0_BASE_DERIVATION_KEY", # required, accepts 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_M0_ISO_16609_MAC_KEY, TR31_M3_ISO_9797_3_MAC_KEY, TR31_M1_ISO_9797_1_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
        key_class: "SYMMETRIC_KEY", # required, accepts SYMMETRIC_KEY, ASYMMETRIC_KEY_PAIR, PRIVATE_KEY, PUBLIC_KEY
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
        key_modes_of_use: { # required
          encrypt: false,
          decrypt: false,
          wrap: false,
          unwrap: false,
          generate: false,
          sign: false,
          verify: false,
          derive_key: false,
          no_restrictions: false,
        },
      },
      public_key_certificate: "CertificateType", # required
      certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
    },
    tr_31_key_block: {
      wrapping_key_identifier: "KeyArnOrKeyAliasType", # required
      wrapped_key_block: "Tr31WrappedKeyBlock", # required
    },
    tr_34_key_block: {
      certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
      signing_key_certificate: "CertificateType", # required
      import_token: "ImportTokenId",
      wrapping_key_identifier: "KeyArnOrKeyAliasType",
      wrapping_key_certificate: "CertificateType",
      wrapped_key_block: "Tr34WrappedKeyBlock", # required
      key_block_format: "X9_TR34_2012", # required, accepts X9_TR34_2012
      random_nonce: "EvenHexLengthBetween16And32",
    },
    key_cryptogram: {
      key_attributes: { # required
        key_usage: "TR31_B0_BASE_DERIVATION_KEY", # required, accepts 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_M0_ISO_16609_MAC_KEY, TR31_M3_ISO_9797_3_MAC_KEY, TR31_M1_ISO_9797_1_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
        key_class: "SYMMETRIC_KEY", # required, accepts SYMMETRIC_KEY, ASYMMETRIC_KEY_PAIR, PRIVATE_KEY, PUBLIC_KEY
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
        key_modes_of_use: { # required
          encrypt: false,
          decrypt: false,
          wrap: false,
          unwrap: false,
          generate: false,
          sign: false,
          verify: false,
          derive_key: false,
          no_restrictions: false,
        },
      },
      exportable: false, # required
      wrapped_key_cryptogram: "WrappedKeyCryptogram", # required
      import_token: "ImportTokenId", # required
      wrapping_spec: "RSA_OAEP_SHA_256", # accepts RSA_OAEP_SHA_256, RSA_OAEP_SHA_512
    },
    diffie_hellman_tr_31_key_block: {
      private_key_identifier: "KeyArnOrKeyAliasType", # required
      certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
      public_key_certificate: "CertificateType", # required
      derive_key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
      key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
      key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
      derivation_data: { # required
        shared_information: "SharedInformation",
      },
      wrapped_key_block: "Tr31WrappedKeyBlock", # required
    },
    as_2805_key_cryptogram: {
      as_2805_key_variant: "TERMINAL_MAJOR_KEY_VARIANT_00", # required, accepts TERMINAL_MAJOR_KEY_VARIANT_00, PIN_ENCRYPTION_KEY_VARIANT_28, MESSAGE_AUTHENTICATION_KEY_VARIANT_24, DATA_ENCRYPTION_KEY_VARIANT_22
      key_modes_of_use: { # required
        encrypt: false,
        decrypt: false,
        wrap: false,
        unwrap: false,
        generate: false,
        sign: false,
        verify: false,
        derive_key: false,
        no_restrictions: false,
      },
      key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521
      exportable: false, # required
      wrapping_key_identifier: "KeyArnOrKeyAliasType", # required
      wrapped_key_cryptogram: "WrappedKeyCryptogram", # required
    },
  },
  key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  enabled: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  replication_regions: ["Region"],
  requester_comment: "MpaRequesterComment",
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_material (required, Types::ImportKeyMaterial) —

    The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.

  • :key_check_value_algorithm (String) —

    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

    For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

  • :enabled (Boolean) —

    Specifies whether import key is enabled.

  • :tags (Array<Types::Tag>) —

    Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the [TagResource] operation.

    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. 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.

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

    <note markdown=“1”> Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

    </note>

    [1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html

  • :replication_regions (Array<String>) —

    A list of Amazon Web Services Regions for key replication operations.

    Each region in the list must be a valid Amazon Web Services Region identifier where Amazon Web Services Payment Cryptography is available. This list is used to specify which regions should be added to or removed from a key’s replication configuration.

  • :requester_comment (String) —

    The comment from the requester explaining the reason for the import.

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

Returns:

See Also:



2638
2639
2640
2641
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2638

def import_key(params = {}, options = {})
  req = build_request(:import_key, params)
  req.send_request(options)
end

#list_aliases(params = {}) ⇒ Types::ListAliasesOutput

Lists the aliases for all keys in the caller’s Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by ‘keyARN`. 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][2
  • DeleteAlias][3
  • GetAlias][4
  • UpdateAlias][5

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-managealias.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html [5]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_aliases({
  key_arn: "KeyArn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.aliases #=> Array
resp.aliases[0].alias_name #=> String
resp.aliases[0].key_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_arn (String) —

    The ‘keyARN` for which you want to list all aliases.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

Returns:

See Also:



2719
2720
2721
2722
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2719

def list_aliases(params = {}, options = {})
  req = build_request(:list_aliases, params)
  req.send_request(options)
end

#list_keys(params = {}) ⇒ Types::ListKeysOutput

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][1
  • DeleteKey][2
  • GetKey][3

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_keys({
  key_state: "CREATE_IN_PROGRESS", # accepts CREATE_IN_PROGRESS, CREATE_COMPLETE, DELETE_PENDING, DELETE_COMPLETE
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.keys #=> Array
resp.keys[0].key_arn #=> String
resp.keys[0].key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.keys[0].key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.keys[0].key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.keys[0].key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.keys[0].key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.keys[0].key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.keys[0].key_attributes.key_modes_of_use.wrap #=> Boolean
resp.keys[0].key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.keys[0].key_attributes.key_modes_of_use.generate #=> Boolean
resp.keys[0].key_attributes.key_modes_of_use.sign #=> Boolean
resp.keys[0].key_attributes.key_modes_of_use.verify #=> Boolean
resp.keys[0].key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.keys[0].key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.keys[0].key_check_value #=> String
resp.keys[0].exportable #=> Boolean
resp.keys[0].enabled #=> Boolean
resp.keys[0].multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.keys[0].primary_region #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_state (String) —

    The key state of the keys you want to list.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

Returns:

See Also:



2811
2812
2813
2814
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2811

def list_keys(params = {}, options = {})
  req = build_request(:list_keys, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • TagResource][2
  • UntagResource][3

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ‘KeyARN` of the key whose tags you are getting.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

Returns:

See Also:



2884
2885
2886
2887
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2884

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyOutput

Attaches or replaces a resource-based policy on an Amazon Web Services Payment Cryptography key. A resource-based policy can grant cross-account access to your key.

If the policy would grant public access, the request fails with a ‘PublicPolicyException`.

To remove a resource-based policy from a key, use [DeleteResourcePolicy].

**Cross-account use:** This operation can’t be used across different Amazon Web Services accounts.

**Related operations:**

  • GetResourcePolicy][2
  • DeleteResourcePolicy][1

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteResourcePolicy.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetResourcePolicy.html

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "ResourceArn", # required
  policy: "ResourcePolicy", # required
})

Response structure


resp.resource_arn #=> String
resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ‘KeyARN` of the key to attach the resource-based policy to.

  • :policy (required, String) —

    The resource-based policy to attach to the key, in JSON format.

Returns:

See Also:



2940
2941
2942
2943
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 2940

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#remove_key_replication_regions(params = {}) ⇒ Types::RemoveKeyReplicationRegionsOutput

Removes Replication Regions from an existing Amazon Web Services Payment Cryptography key, disabling the key’s availability for cryptographic operations in the specified Amazon Web Services Regions.

When you remove Replication Regions, the key material is securely deleted from those regions and can no longer be used for cryptographic operations there. This operation is irreversible for the specified Amazon Web Services Regions. For more information, see [Multi-Region key replication].

Ensure that no active cryptographic operations or applications depend on the key in the regions you’re removing before performing this operation.

**Cross-account use:** This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • AddKeyReplicationRegions][3
  • DisableDefaultKeyReplicationRegions][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AddKeyReplicationRegions.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisableDefaultKeyReplicationRegions.html

Examples:

Request syntax with placeholder values


resp = client.remove_key_replication_regions({
  key_identifier: "KeyArnOrKeyAliasType", # required
  replication_regions: ["Region"], # required
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The key identifier (ARN or alias) of the key from which to remove replication regions.

    This key must exist and have replication enabled in the specified regions.

  • :replication_regions (required, Array<String>) —

    The list of Amazon Web Services Regions to remove from the key’s replication configuration.

    The key will no longer be available for cryptographic operations in these regions after removal. Ensure no active operations depend on the key in these regions before removal.

Returns:

See Also:



3044
3045
3046
3047
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3044

def remove_key_replication_regions(params = {}, options = {})
  req = build_request(:remove_key_replication_regions, params)
  req.send_request(options)
end

#restore_key(params = {}) ⇒ Types::RestoreKeyOutput

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • DeleteKey][2
  • StartKeyUsage][3
  • StopKeyUsage][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html

Examples:

Request syntax with placeholder values


resp = client.restore_key({
  key_identifier: "KeyArnOrKeyAliasType", # required
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The ‘KeyARN` of the key to be restored within Amazon Web Services Payment Cryptography.

Returns:

See Also:



3133
3134
3135
3136
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3133

def restore_key(params = {}, options = {})
  req = build_request(:restore_key, params)
  req.send_request(options)
end

#start_key_usage(params = {}) ⇒ Types::StartKeyUsageOutput

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • StopKeyUsage][2

^

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html

Examples:

Request syntax with placeholder values


resp = client.start_key_usage({
  key_identifier: "KeyArnOrKeyAliasType", # required
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The ‘KeyArn` of the key.

Returns:

See Also:



3212
3213
3214
3215
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3212

def start_key_usage(params = {}, options = {})
  req = build_request(:start_key_usage, params)
  req.send_request(options)
end

#stop_key_usage(params = {}) ⇒ Types::StopKeyUsageOutput

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • DeleteKey][1
  • StartKeyUsage][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html

Examples:

Request syntax with placeholder values


resp = client.stop_key_usage({
  key_identifier: "KeyArnOrKeyAliasType", # required
})

Response structure


resp.key.key_arn #=> String
resp.key.key_attributes.key_usage #=> String, one of "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_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"
resp.key.key_attributes.key_class #=> String, one of "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY"
resp.key.key_attributes.key_algorithm #=> String, one of "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521"
resp.key.key_attributes.key_modes_of_use.encrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.decrypt #=> Boolean
resp.key.key_attributes.key_modes_of_use.wrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.unwrap #=> Boolean
resp.key.key_attributes.key_modes_of_use.generate #=> Boolean
resp.key.key_attributes.key_modes_of_use.sign #=> Boolean
resp.key.key_attributes.key_modes_of_use.verify #=> Boolean
resp.key.key_attributes.key_modes_of_use.derive_key #=> Boolean
resp.key.key_attributes.key_modes_of_use.no_restrictions #=> Boolean
resp.key.key_check_value #=> String
resp.key.key_check_value_algorithm #=> String, one of "CMAC", "ANSI_X9_24", "HMAC", "SHA_1"
resp.key.enabled #=> Boolean
resp.key.exportable #=> Boolean
resp.key.key_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE"
resp.key.key_origin #=> String, one of "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY"
resp.key.create_timestamp #=> Time
resp.key.usage_start_timestamp #=> Time
resp.key.usage_stop_timestamp #=> Time
resp.key.delete_pending_timestamp #=> Time
resp.key.delete_timestamp #=> Time
resp.key.derive_key_usage #=> String, one of "TR31_B0_BASE_DERIVATION_KEY", "TR31_C0_CARD_VERIFICATION_KEY", "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", "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_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY"
resp.key.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA"
resp.key.primary_region #=> String
resp.key.replication_status #=> Hash
resp.key.replication_status["Region"].status #=> String, one of "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED"
resp.key.replication_status["Region"].status_message #=> String
resp.key.using_default_replication_regions #=> Boolean
resp.key.mpa_status.mpa_session_arn #=> String
resp.key.mpa_status.status #=> String, one of "PENDING", "APPROVED", "FAILED", "CANCELLED"
resp.key.mpa_status.initiation_date #=> Time
resp.key.mpa_status.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The ‘KeyArn` of the key.

Returns:

See Also:



3295
3296
3297
3298
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3295

def stop_key_usage(params = {}, options = {})
  req = build_request(:stop_key_usage, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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

<note markdown=“1”> Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

</note>

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • ListTagsForResource][3
  • UntagResource][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ‘KeyARN` of the key whose tags are being updated.

  • :tags (required, Array<Types::Tag>) —

    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 personal, 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 personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    [1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3375
3376
3377
3378
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3375

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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

<note markdown=“1”> Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

</note>

**Cross-account use:** This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see [Resource-based policies].

**Related operations:**

  • ListTagsForResource][2
  • TagResource][3

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ‘KeyARN` of the key whose tags are being removed.

  • :tag_keys (required, Array<String>) —

    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.

    [1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3431
3432
3433
3434
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3431

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_alias(params = {}) ⇒ Types::UpdateAliasOutput

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][1
  • DeleteAlias][2
  • GetAlias][3
  • ListAliases][4

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html [4]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html

Examples:

Request syntax with placeholder values


resp = client.update_alias({
  alias_name: "AliasName", # required
  key_arn: "KeyArn",
})

Response structure


resp.alias.alias_name #=> String
resp.alias.key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias_name (required, String) —

    The alias whose associated key is changing.

  • :key_arn (String) —

    The ‘KeyARN` for the key that you are updating or removing from the alias.

Returns:

See Also:



3490
3491
3492
3493
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3490

def update_alias(params = {}, options = {})
  req = build_request(:update_alias, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


3519
3520
3521
 
# File 'lib/aws-sdk-paymentcryptography/client.rb', line 3519

def waiter_names
  []
end