Skip to content

remove_regions_from_replication async

remove_regions_from_replication(
    secret_id: SecretIdType,
    remove_replica_regions: RemoveReplicaRegionListType,
    *,
    config_overrides: Optional[AsyncSecretsManagerClientConfig] = None,
) -> RemoveRegionsFromReplicationResponse

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:

Raises:

Source code in docs_src/capo_secrets_manager/_services/async_secrets_manager.py
async def remove_regions_from_replication(
    self,
    secret_id: "capo_secrets_manager.types.secret_id_type.SecretIdType",
    remove_replica_regions: "capo_secrets_manager.types.remove_replica_region_list_type.RemoveReplicaRegionListType",
    *,
    config_overrides: Optional[AsyncSecretsManagerClientConfig] = None,
) -> "capo_secrets_manager.types.remove_regions_from_replication_response.RemoveRegionsFromReplicationResponse":
    """<p>For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.</p> <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p> <p> <b>Required permissions: </b> <code>secretsmanager:RemoveRegionsFromReplication</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions"> IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control in Secrets Manager</a>. </p>

    Args:
        secret_id: <p>The ARN or name of the secret.</p>
        remove_replica_regions: <p>The Regions of the replicas to remove.</p>

    Raises:
        capo_secrets_manager.errors.internal_service_error.InternalServiceError: <p>An error occurred on the server side.</p>
        capo_secrets_manager.errors.invalid_parameter_exception.InvalidParameterException: <p>The parameter name or value is invalid.</p>
        capo_secrets_manager.errors.invalid_request_exception.InvalidRequestException: <p>A parameter value is not valid for the current state of the resource.</p> <p>Possible causes:</p> <ul> <li> <p>The secret is scheduled for deletion.</p> </li> <li> <p>You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. </p> </li> <li> <p>The secret is managed by another service, and you must use that service to update it. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p> </li> </ul>
        capo_secrets_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Secrets Manager can't find the resource that you asked for.</p>
        capo_secrets_manager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_secrets_manager.types.remove_regions_from_replication_request.RemoveRegionsFromReplicationRequest]",
    ) -> AsyncOperationResponse[
        "capo_secrets_manager.types.remove_regions_from_replication_response.RemoveRegionsFromReplicationResponse"
    ]:
        import capo_secrets_manager._operations.secretsmanager.remove_regions_from_replication

        (
            output,
            http_response,
        ) = await capo_secrets_manager._operations.secretsmanager.remove_regions_from_replication.async_remove_regions_from_replication(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RemoveRegionsFromReplication")
    )
    input_: capo_secrets_manager.types.remove_regions_from_replication_request.RemoveRegionsFromReplicationRequest = {
        "secret_id": secret_id,
        "remove_replica_regions": remove_replica_regions,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output