Skip to content

describe_backup_access_point async

describe_backup_access_point(
    access_point_arn: AccessPointArn,
    *,
    config_overrides: Optional[AsyncBackupClientConfig] = None,
) -> DescribeBackupAccessPointResponse

Returns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point.

After a backup access point reaches the AVAILABLE status, use this operation to retrieve the Amazon S3 access point ARN and alias that you need to read the backup data.

Parameters:

  • access_point_arn (AccessPointArn) –

    The Amazon Resource Name (ARN) of the backup access point to describe.

Raises:

Source code in docs_src/capo_backup/_services/async_backup.py
async def describe_backup_access_point(
    self,
    access_point_arn: "capo_backup.types.access_point_arn.AccessPointArn",
    *,
    config_overrides: Optional[AsyncBackupClientConfig] = None,
) -> "capo_backup.types.describe_backup_access_point_response.DescribeBackupAccessPointResponse":
    """<p>Returns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point.</p> <p>After a backup access point reaches the <code>AVAILABLE</code> status, use this operation to retrieve the Amazon S3 access point ARN and alias that you need to read the backup data.</p>

    Args:
        access_point_arn: <p>The Amazon Resource Name (ARN) of the backup access point to describe.</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.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_backup.types.describe_backup_access_point_input.DescribeBackupAccessPointInput]",
    ) -> AsyncOperationResponse[
        "capo_backup.types.describe_backup_access_point_response.DescribeBackupAccessPointResponse"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.describe_backup_access_point

        (
            output,
            http_response,
        ) = await capo_backup._operations.cryo_controller_user_manager.describe_backup_access_point.async_describe_backup_access_point(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

        return capo_backup.types.describe_backup_access_point_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeBackupAccessPoint", redact_output=_redact_output),
    )
    input_: capo_backup.types.describe_backup_access_point_input.DescribeBackupAccessPointInput = {
        "access_point_arn": access_point_arn
    }

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