remove_region `async` ¶

remove_region(
    instance_arn: InstanceArn,
    region_name: RegionName,
    *,
    config_overrides: Optional[AsyncSSOAdminClientConfig] = None,
) -> RemoveRegionResponse

Removes an additional Region from an IAM Identity Center instance. This operation initiates an asynchronous workflow to clean up IAM Identity Center resources in the specified additional Region. The Region status is set to REMOVING and the Region record is deleted when the workflow completes. The request must be made from the primary Region. The target Region cannot be the primary Region, and no other add or remove Region workflows can be in progress.

The following actions are related to RemoveRegion:

Parameters:

instance_arn (InstanceArn) –

The Amazon Resource Name (ARN) of the IAM Identity Center instance.
region_name (RegionName) –

The name of the Amazon Web Services Region to remove from the IAM Identity Center instance. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1). The primary Region cannot be removed.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
InternalServerException –

The request processing has failed because of an unknown error, exception, or failure with an internal server.
ResourceNotFoundException –

Indicates that a requested resource is not found.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
ValidationException –

The request failed because it contains a syntax error.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sso_admin/_services/async_sso_admin.py

async def remove_region(
    self,
    instance_arn: "capo_sso_admin.types.instance_arn.InstanceArn",
    region_name: "capo_sso_admin.types.region_name.RegionName",
    *,
    config_overrides: Optional[AsyncSSOAdminClientConfig] = None,
) -> "capo_sso_admin.types.remove_region_response.RemoveRegionResponse":
    """<p>Removes an additional Region from an IAM Identity Center instance. This operation initiates an asynchronous workflow to clean up IAM Identity Center resources in the specified additional Region. The Region status is set to REMOVING and the Region record is deleted when the workflow completes. The request must be made from the primary Region. The target Region cannot be the primary Region, and no other add or remove Region workflows can be in progress.</p> <p>The following actions are related to <code>RemoveRegion</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_AddRegion.html"> AddRegion</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_DescribeRegion.html">DescribeRegion</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListRegions.html">ListRegions</a> </p> </li> </ul>

    Args:
        instance_arn: <p>The Amazon Resource Name (ARN) of the IAM Identity Center instance.</p>
        region_name: <p>The name of the Amazon Web Services Region to remove from the IAM Identity Center instance. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1). The primary Region cannot be removed.</p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_sso_admin.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_sso_admin.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sso_admin.types.remove_region_request.RemoveRegionRequest]",
    ) -> AsyncOperationResponse[
        "capo_sso_admin.types.remove_region_response.RemoveRegionResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.remove_region

        (
            output,
            http_response,
        ) = await capo_sso_admin._operations.swb_external_service.remove_region.async_remove_region(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RemoveRegion")
    )
    input_: capo_sso_admin.types.remove_region_request.RemoveRegionRequest = {
        "instance_arn": instance_arn,
        "region_name": region_name,
    }

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

remove_region async ¶

remove_region `async` ¶