Skip to content

Secrets Manager  >  Operations  >  remove_regions_from_replication

remove_regions_from_replication

Operation

remove_regions_from_replication async 

remove_regions_from_replication(input: RemoveRegionsFromReplicationInput, plugins: list[Plugin] | None = None) -> RemoveRegionsFromReplicationOutput

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameters:

Name Type Description Default
input RemoveRegionsFromReplicationInput

An instance of RemoveRegionsFromReplicationInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
RemoveRegionsFromReplicationOutput

An instance of RemoveRegionsFromReplicationOutput.

Input

RemoveRegionsFromReplicationInput dataclass

Dataclass for RemoveRegionsFromReplicationInput structure.

Attributes

remove_replica_regions class-attribute instance-attribute 
remove_replica_regions: list[str] | None = None

The Regions of the replicas to remove.

secret_id class-attribute instance-attribute 
secret_id: str | None = None

The ARN or name of the secret.

Output

RemoveRegionsFromReplicationOutput dataclass

Dataclass for RemoveRegionsFromReplicationOutput structure.

Attributes

arn class-attribute instance-attribute 
arn: str | None = None

The ARN of the primary secret.

replication_status class-attribute instance-attribute 
replication_status: list[ReplicationStatusType] | None = None

The status of replicas for this secret after you remove Regions.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.