describe_snapshot_schedule ¶

def describe_snapshot_schedule(
    self,
    volume_arn: "capo_storage_gateway.types.volume_arn.VolumeARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.describe_snapshot_schedule_output.DescribeSnapshotScheduleOutput":
    """<p>Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.</p>

    Args:
        volume_arn: <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe snapshot schedule for gateway volume
        Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.

        >>> client.describe_snapshot_schedule(volume_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB')
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.describe_snapshot_schedule_input.DescribeSnapshotScheduleInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.describe_snapshot_schedule_output.DescribeSnapshotScheduleOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_snapshot_schedule

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.describe_snapshot_schedule.describe_snapshot_schedule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSnapshotSchedule")
    )
    input_: capo_storage_gateway.types.describe_snapshot_schedule_input.DescribeSnapshotScheduleInput = {
        "volume_arn": volume_arn
    }

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