describe_regions `async` ¶

describe_regions(
    directory_id: DirectoryId,
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    region_name: Optional[RegionName] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeRegionsResult

Provides information about the Regions that are configured for multi-Region replication.

Parameters:

directory_id (DirectoryId) –

The identifier of the directory.
region_name (Optional[RegionName], default: None ) –

The name of the Region. For example, us-east-1.
next_token (Optional[NextToken], default: None ) –

The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call.

Raises:

AccessDeniedException –

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

A client exception has occurred.
DirectoryDoesNotExistException –

The specified directory does not exist in the system.
InvalidNextTokenException –

The NextToken value is not valid.
InvalidParameterException –

One or more parameters are not valid.
ServiceException –

An exception has occurred in Directory Service.
UnsupportedOperationException –

The operation is not supported.
UnknownServiceError –

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

Source code in docs_src/capo_directory_service/_services/async_directory_service.py

async def describe_regions(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
    region_name: Optional[
        "capo_directory_service.types.region_name.RegionName"
    ] = None,
    next_token: Optional[
        "capo_directory_service.types.next_token.NextToken"
    ] = None,
) -> "capo_directory_service.types.describe_regions_result.DescribeRegionsResult":
    """<p>Provides information about the Regions that are configured for multi-Region replication.</p>

    Args:
        directory_id: <p>The identifier of the directory.</p>
        region_name: <p>The name of the Region. For example, <code>us-east-1</code>.</p>
        next_token: <p>The <code>DescribeRegionsResult.NextToken</code> value from a previous call to <a>DescribeRegions</a>. Pass null if this is the first call.</p>

    Raises:
        capo_directory_service.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_does_not_exist_exception.DirectoryDoesNotExistException: <p>The specified directory does not exist in the system.</p>
        capo_directory_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value is not valid.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_directory_service.types.describe_regions_request.DescribeRegionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.describe_regions_result.DescribeRegionsResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.describe_regions

        (
            output,
            http_response,
        ) = await capo_directory_service._operations.directory_service_20150416.describe_regions.async_describe_regions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRegions")
    )
    input_: capo_directory_service.types.describe_regions_request.DescribeRegionsRequest = {
        "directory_id": directory_id
    }
    if region_name is not None:
        input_["region_name"] = region_name
    if next_token is not None:
        input_["next_token"] = next_token

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

describe_regions async ¶

describe_regions `async` ¶