Skip to content

get_multi_region_access_point_policy_status

get_multi_region_access_point_policy_status(
    account_id: AccountId,
    name: MultiRegionAccessPointName,
    *,
    config_overrides: Optional[S3ControlClientConfig] = None,
) -> GetMultiRegionAccessPointPolicyStatusResult

This operation is not supported by directory buckets.

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.

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 GetMultiRegionAccessPointPolicyStatus:

Parameters:

  • account_id (AccountId) –

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

  • name (MultiRegionAccessPointName) –

    Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the Amazon S3 User Guide.

Raises:

Source code in docs_src/capo_s3_control/_services/s3_control.py
def get_multi_region_access_point_policy_status(
    self,
    account_id: "capo_s3_control.types.account_id.AccountId",
    name: "capo_s3_control.types.multi_region_access_point_name.MultiRegionAccessPointName",
    *,
    config_overrides: Optional[S3ControlClientConfig] = None,
) -> "capo_s3_control.types.get_multi_region_access_point_policy_status_result.GetMultiRegionAccessPointPolicyStatusResult":
    """<note> <p>This operation is not supported by directory buckets.</p> </note> <p>Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.</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>GetMultiRegionAccessPointPolicyStatus</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html">GetMultiRegionAccessPointPolicy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html">PutMultiRegionAccessPointPolicy</a> </p> </li> </ul>

    Args:
        account_id: <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
        name: <p>Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming">Rules for naming Amazon S3 Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</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.get_multi_region_access_point_policy_status_request.GetMultiRegionAccessPointPolicyStatusRequest]",
    ) -> OperationResponse[
        "capo_s3_control.types.get_multi_region_access_point_policy_status_result.GetMultiRegionAccessPointPolicyStatusResult"
    ]:
        import capo_s3_control._operations.awss3_control_service_v20180820.get_multi_region_access_point_policy_status

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetMultiRegionAccessPointPolicyStatus")
    )
    input_: capo_s3_control.types.get_multi_region_access_point_policy_status_request.GetMultiRegionAccessPointPolicyStatusRequest = {
        "account_id": account_id,
        "name": name,
    }

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