PaymentCryptographyControlPlane / Client / disable_default_key_replication_regions

disable_default_key_replication_regions¶

PaymentCryptographyControlPlane.Client.disable_default_key_replication_regions(**kwargs)¶

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

After disabling default 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:

Request Syntax

response = client.disable_default_key_replication_regions(
    ReplicationRegions=[
        'string',
    ]
)

Parameters:

ReplicationRegions (list) –

[REQUIRED]

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.

(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 disabling default key replication regions for the account.
- EnabledReplicationRegions (list) –
  
  The remaining list of regions where default key replication is still enabled for the account.
  
  This reflects the account’s default replication configuration after removing the specified regions.
  - (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