Amazonka.StorageGateway.DescribeSnapshotSchedule

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.

Creating a Request

data DescribeSnapshotSchedule

A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

See: newDescribeSnapshotSchedule smart constructor.

Constructors

DescribeSnapshotSchedule'

Fields

• volumeARN :: Text

  The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Instances

ToJSON DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

toJSON :: DescribeSnapshotSchedule -> Value

toEncoding :: DescribeSnapshotSchedule -> Encoding

toJSONList :: [DescribeSnapshotSchedule] -> Value

toEncodingList :: [DescribeSnapshotSchedule] -> Encoding

ToHeaders DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

toHeaders :: DescribeSnapshotSchedule -> [Header]

ToPath DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

toPath :: DescribeSnapshotSchedule -> ByteString

ToQuery DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

toQuery :: DescribeSnapshotSchedule -> QueryString

AWSRequest DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Associated Types

type AWSResponse DescribeSnapshotSchedule

Methods

request :: (Service -> Service) -> DescribeSnapshotSchedule -> Request DescribeSnapshotSchedule

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSnapshotSchedule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSnapshotSchedule)))

Generic DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Associated Types

type Rep DescribeSnapshotSchedule :: Type -> Type

Methods

from :: DescribeSnapshotSchedule -> Rep DescribeSnapshotSchedule x

to :: Rep DescribeSnapshotSchedule x -> DescribeSnapshotSchedule

Read DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

readsPrec :: Int -> ReadS DescribeSnapshotSchedule

readList :: ReadS [DescribeSnapshotSchedule]

readPrec :: ReadPrec DescribeSnapshotSchedule

readListPrec :: ReadPrec [DescribeSnapshotSchedule]

Show DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

showsPrec :: Int -> DescribeSnapshotSchedule -> ShowS

show :: DescribeSnapshotSchedule -> String

showList :: [DescribeSnapshotSchedule] -> ShowS

NFData DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

rnf :: DescribeSnapshotSchedule -> ()

Eq DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

(==) :: DescribeSnapshotSchedule -> DescribeSnapshotSchedule -> Bool

(/=) :: DescribeSnapshotSchedule -> DescribeSnapshotSchedule -> Bool

Hashable DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

hashWithSalt :: Int -> DescribeSnapshotSchedule -> Int

hash :: DescribeSnapshotSchedule -> Int

type AWSResponse DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

type AWSResponse DescribeSnapshotSchedule = DescribeSnapshotScheduleResponse

type Rep DescribeSnapshotSchedule

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

type Rep DescribeSnapshotSchedule = D1 ('MetaData "DescribeSnapshotSchedule" "Amazonka.StorageGateway.DescribeSnapshotSchedule" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeSnapshotSchedule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeSnapshotSchedule

Arguments

:: Text

DescribeSnapshotSchedule

-> DescribeSnapshotSchedule

Create a value of DescribeSnapshotSchedule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSnapshotSchedule, describeSnapshotSchedule_volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Request Lenses

describeSnapshotSchedule_volumeARN :: Lens' DescribeSnapshotSchedule Text

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Destructuring the Response

data DescribeSnapshotScheduleResponse

See: newDescribeSnapshotScheduleResponse smart constructor.

Constructors

DescribeSnapshotScheduleResponse'

Fields

• description :: Maybe Text

  The snapshot description.

• recurrenceInHours :: Maybe Natural

  The number of hours between snapshots.

• startAt :: Maybe Natural

  The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

• tags :: Maybe [Tag]

  A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

• timezone :: Maybe Text

  A value that indicates the time zone of the gateway.

• volumeARN :: Maybe Text

  The Amazon Resource Name (ARN) of the volume that was specified in the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeSnapshotScheduleResponse

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Associated Types

type Rep DescribeSnapshotScheduleResponse :: Type -> Type

Methods

from :: DescribeSnapshotScheduleResponse -> Rep DescribeSnapshotScheduleResponse x

to :: Rep DescribeSnapshotScheduleResponse x -> DescribeSnapshotScheduleResponse

Read DescribeSnapshotScheduleResponse

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

readsPrec :: Int -> ReadS DescribeSnapshotScheduleResponse

readList :: ReadS [DescribeSnapshotScheduleResponse]

readPrec :: ReadPrec DescribeSnapshotScheduleResponse

readListPrec :: ReadPrec [DescribeSnapshotScheduleResponse]

Show DescribeSnapshotScheduleResponse

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

showsPrec :: Int -> DescribeSnapshotScheduleResponse -> ShowS

show :: DescribeSnapshotScheduleResponse -> String

showList :: [DescribeSnapshotScheduleResponse] -> ShowS

NFData DescribeSnapshotScheduleResponse

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

rnf :: DescribeSnapshotScheduleResponse -> ()

Eq DescribeSnapshotScheduleResponse

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

Methods

(==) :: DescribeSnapshotScheduleResponse -> DescribeSnapshotScheduleResponse -> Bool

(/=) :: DescribeSnapshotScheduleResponse -> DescribeSnapshotScheduleResponse -> Bool

type Rep DescribeSnapshotScheduleResponse

Defined in Amazonka.StorageGateway.DescribeSnapshotSchedule

type Rep DescribeSnapshotScheduleResponse = D1 ('MetaData "DescribeSnapshotScheduleResponse" "Amazonka.StorageGateway.DescribeSnapshotSchedule" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DescribeSnapshotScheduleResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "recurrenceInHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "startAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeSnapshotScheduleResponse

Arguments

:: Int

$sel:httpStatus:DescribeSnapshotScheduleResponse'

-> DescribeSnapshotScheduleResponse

Create a value of DescribeSnapshotScheduleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_description - The snapshot description.

$sel:recurrenceInHours:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_recurrenceInHours - The number of hours between snapshots.

$sel:startAt:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_startAt - The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

DescribeSnapshotScheduleResponse, describeSnapshotScheduleResponse_tags - A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

$sel:timezone:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_timezone - A value that indicates the time zone of the gateway.

DescribeSnapshotSchedule, describeSnapshotScheduleResponse_volumeARN - The Amazon Resource Name (ARN) of the volume that was specified in the request.

$sel:httpStatus:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_httpStatus - The response's http status code.

Response Lenses

describeSnapshotScheduleResponse_description :: Lens' DescribeSnapshotScheduleResponse (Maybe Text)

The snapshot description.

describeSnapshotScheduleResponse_recurrenceInHours :: Lens' DescribeSnapshotScheduleResponse (Maybe Natural)

The number of hours between snapshots.

describeSnapshotScheduleResponse_startAt :: Lens' DescribeSnapshotScheduleResponse (Maybe Natural)

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

describeSnapshotScheduleResponse_tags :: Lens' DescribeSnapshotScheduleResponse (Maybe [Tag])

A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

describeSnapshotScheduleResponse_timezone :: Lens' DescribeSnapshotScheduleResponse (Maybe Text)

A value that indicates the time zone of the gateway.

describeSnapshotScheduleResponse_volumeARN :: Lens' DescribeSnapshotScheduleResponse (Maybe Text)

The Amazon Resource Name (ARN) of the volume that was specified in the request.

describeSnapshotScheduleResponse_httpStatus :: Lens' DescribeSnapshotScheduleResponse Int

The response's http status code.