PaymentCryptographyControlPlane / Client / enable_default_key_replication_regions

enable_default_key_replication_regions

PaymentCryptographyControlPlane.Client.enable_default_key_replication_regions(**kwargs)

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

When default Replication Regions 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:

See also: AWS API Documentation

Request Syntax

response = client.enable_default_key_replication_regions(
    ReplicationRegions=[
        'string',
    ]
)
Parameters:

ReplicationRegions (list) –

[REQUIRED]

The list of Amazon Web Services Regions to enable as default replication regions for the account.

New keys created in this account will automatically be replicated to these regions unless explicitly overridden during key creation.

  • (string) –

    An Amazon Web Services Region identifier in the standard format (e.g., us-east-1, eu-west-1).

    Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.

Return type:

dict

Returns:

Response Syntax

{
    'EnabledReplicationRegions': [
        'string',
    ]
}

Response Structure

  • (dict) –

    Output from enabling default key replication regions for the account.

    • EnabledReplicationRegions (list) –

      The complete list of regions where default key replication is now enabled for the account.

      This includes both previously enabled regions and the newly added regions from this operation.

      • (string) –

        An Amazon Web Services Region identifier in the standard format (e.g., us-east-1, eu-west-1).

        Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.

Exceptions

  • PaymentCryptographyControlPlane.Client.exceptions.ServiceQuotaExceededException

  • PaymentCryptographyControlPlane.Client.exceptions.ValidationException

  • PaymentCryptographyControlPlane.Client.exceptions.ConflictException

  • PaymentCryptographyControlPlane.Client.exceptions.AccessDeniedException

  • PaymentCryptographyControlPlane.Client.exceptions.ResourceNotFoundException

  • PaymentCryptographyControlPlane.Client.exceptions.ThrottlingException

  • PaymentCryptographyControlPlane.Client.exceptions.InternalServerException