Skip to content

list_backup_access_points_by_resource

list_backup_access_points_by_resource(
    resource_arn: ResourceArn,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    max_results: Optional[
        ListBackupAccessPointsByResourceRequestMaxResultsInteger
    ] = None,
    next_token: Optional[str] = None,
) -> ListBackupAccessPointsByResourceResponse

Returns the backup access points associated with the specified resource, such as an Amazon S3 bucket.

Parameters:

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

    The maximum number of items to be returned.

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

    The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

  • resource_arn (ResourceArn) –

    The Amazon Resource Name (ARN) of the resource whose backup access points you want to list.

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def list_backup_access_points_by_resource(
    self,
    resource_arn: "capo_backup.types.resource_arn.ResourceArn",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    max_results: Optional[
        "capo_backup.types.list_backup_access_points_by_resource_request_max_results_integer.ListBackupAccessPointsByResourceRequestMaxResultsInteger"
    ] = None,
    next_token: Optional[str] = None,
) -> "capo_backup.types.list_backup_access_points_by_resource_response.ListBackupAccessPointsByResourceResponse":
    """<p>Returns the backup access points associated with the specified resource, such as an Amazon S3 bucket.</p>

    Args:
        max_results: <p>The maximum number of items to be returned.</p>
        next_token: <p>The next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
        resource_arn: <p>The Amazon Resource Name (ARN) of the resource whose backup access points you want to list.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.list_backup_access_points_by_resource_request.ListBackupAccessPointsByResourceRequest]",
    ) -> OperationResponse[
        "capo_backup.types.list_backup_access_points_by_resource_response.ListBackupAccessPointsByResourceResponse"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.list_backup_access_points_by_resource

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.list_backup_access_points_by_resource.list_backup_access_points_by_resource(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_backup.types.list_backup_access_points_by_resource_response.ListBackupAccessPointsByResourceResponse",
    ) -> dict[str, Any]:
        import capo_backup.types.list_backup_access_points_by_resource_response

        return capo_backup.types.list_backup_access_points_by_resource_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListBackupAccessPointsByResource", redact_output=_redact_output
        ),
    )
    input_: capo_backup.types.list_backup_access_points_by_resource_request.ListBackupAccessPointsByResourceRequest = {
        "resource_arn": resource_arn
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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