Skip to content

list_multi_region_access_points

list_multi_region_access_points(
    account_id: AccountId,
    *,
    config_overrides: Optional[S3ControlClientConfig] = None,
    next_token: Optional[NonEmptyMaxLength1024String] = None,
    max_results: Optional[MaxResults] = None,
) -> ListMultiRegionAccessPointsResult

This operation is not supported by directory buckets.

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.

The following actions are related to ListMultiRegionAccessPoint:

Parameters:

  • account_id (AccountId) –

    The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

  • next_token (Optional[NonEmptyMaxLength1024String], default: None ) –

    Not currently used. Do not use this parameter.

  • max_results (Optional[MaxResults], default: None ) –

    Not currently used. Do not use this parameter.

Raises:

Source code in docs_src/capo_s3_control/_services/s3_control.py
def list_multi_region_access_points(
    self,
    account_id: "capo_s3_control.types.account_id.AccountId",
    *,
    config_overrides: Optional[S3ControlClientConfig] = None,
    next_token: Optional[
        "capo_s3_control.types.non_empty_max_length1024_string.NonEmptyMaxLength1024String"
    ] = None,
    max_results: Optional["capo_s3_control.types.max_results.MaxResults"] = None,
) -> "capo_s3_control.types.list_multi_region_access_points_result.ListMultiRegionAccessPointsResult":
    """<note> <p>This operation is not supported by directory buckets.</p> </note> <p>Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.</p> <p>This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p> <p>The following actions are related to <code>ListMultiRegionAccessPoint</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html">GetMultiRegionAccessPoint</a> </p> </li> </ul>

    Args:
        account_id: <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
        next_token: <p>Not currently used. Do not use this parameter.</p>
        max_results: <p>Not currently used. Do not use this parameter.</p>

    Raises:
        capo_s3_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_s3_control.types.list_multi_region_access_points_request.ListMultiRegionAccessPointsRequest]",
    ) -> OperationResponse[
        "capo_s3_control.types.list_multi_region_access_points_result.ListMultiRegionAccessPointsResult"
    ]:
        import capo_s3_control._operations.awss3_control_service_v20180820.list_multi_region_access_points

        output, http_response = (
            capo_s3_control._operations.awss3_control_service_v20180820.list_multi_region_access_points.list_multi_region_access_points(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMultiRegionAccessPoints")
    )
    input_: capo_s3_control.types.list_multi_region_access_points_request.ListMultiRegionAccessPointsRequest = {
        "account_id": account_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output