remove_regions_from_replication¶
Operation¶
remove_regions_from_replication
¶
remove_regions_from_replication(request: RemoveRegionsFromReplicationInput | RemoveRegionsFromReplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RemoveRegionsFromReplicationInputDict]) -> 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 |
|---|---|---|---|
request
|
RemoveRegionsFromReplicationInput | RemoveRegionsFromReplicationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[RemoveRegionsFromReplicationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RemoveRegionsFromReplicationOutput
|
An instance of |
remove_regions_from_replication
async
¶
remove_regions_from_replication(request: RemoveRegionsFromReplicationInput | RemoveRegionsFromReplicationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RemoveRegionsFromReplicationInputDict]) -> 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 |
|---|---|---|---|
request
|
RemoveRegionsFromReplicationInput | RemoveRegionsFromReplicationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[RemoveRegionsFromReplicationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RemoveRegionsFromReplicationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
RemoveRegionsFromReplicationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for RemoveRegionsFromReplicationOutput structure.
Attributes¶
replication_status
class-attribute
instance-attribute
¶
replication_status: list[ReplicationStatusType] | None = ...
The status of replicas for this secret after you remove Regions.
response_metadata
class-attribute
instance-attribute
¶
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.