amazonka-redshift-2.0: Amazon Redshift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Redshift.DescribeSnapshotSchedules

Description

Returns a list of snapshot schedules.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeSnapshotSchedules Source #

See: newDescribeSnapshotSchedules smart constructor.

Constructors

DescribeSnapshotSchedules' 

Fields

  • clusterIdentifier :: Maybe Text

    The unique identifier for the cluster whose snapshot schedules you want to view.

  • marker :: Maybe Text

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

  • maxRecords :: Maybe Int

    The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  • scheduleIdentifier :: Maybe Text

    A unique identifier for a snapshot schedule.

  • tagKeys :: Maybe [Text]

    The key value for a snapshot schedule tag.

  • tagValues :: Maybe [Text]

    The value corresponding to the key of the snapshot schedule tag.

Instances

Instances details
ToHeaders DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

toHeaders :: DescribeSnapshotSchedules -> [Header] #

ToPath DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

toPath :: DescribeSnapshotSchedules -> ByteString #

ToQuery DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

toQuery :: DescribeSnapshotSchedules -> QueryString #

AWSPager DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

page :: DescribeSnapshotSchedules -> AWSResponse DescribeSnapshotSchedules -> Maybe DescribeSnapshotSchedules #

AWSRequest DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Associated Types

type AWSResponse DescribeSnapshotSchedules #

Methods

request :: (Service -> Service) -> DescribeSnapshotSchedules -> Request DescribeSnapshotSchedules #

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

Generic DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Associated Types

type Rep DescribeSnapshotSchedules :: Type -> Type #

Methods

from :: DescribeSnapshotSchedules -> Rep DescribeSnapshotSchedules x #

to :: Rep DescribeSnapshotSchedules x -> DescribeSnapshotSchedules #

Read DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

readsPrec :: Int -> ReadS DescribeSnapshotSchedules #

readList :: ReadS [DescribeSnapshotSchedules] #

readPrec :: ReadPrec DescribeSnapshotSchedules #

readListPrec :: ReadPrec [DescribeSnapshotSchedules] #

Show DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

showsPrec :: Int -> DescribeSnapshotSchedules -> ShowS #

show :: DescribeSnapshotSchedules -> String #

showList :: [DescribeSnapshotSchedules] -> ShowS #

NFData DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

rnf :: DescribeSnapshotSchedules -> () #

Eq DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

(==) :: DescribeSnapshotSchedules -> DescribeSnapshotSchedules -> Bool #

(/=) :: DescribeSnapshotSchedules -> DescribeSnapshotSchedules -> Bool #

Hashable DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

hashWithSalt :: Int -> DescribeSnapshotSchedules -> Int #

hash :: DescribeSnapshotSchedules -> Int #

type AWSResponse DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

type AWSResponse DescribeSnapshotSchedules = DescribeSnapshotSchedulesResponse
type Rep DescribeSnapshotSchedules Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

type Rep DescribeSnapshotSchedules = D1 ('MetaData "DescribeSnapshotSchedules" "Amazonka.Redshift.DescribeSnapshotSchedules" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeSnapshotSchedules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "scheduleIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeSnapshotSchedules :: DescribeSnapshotSchedules Source #

Create a value of DescribeSnapshotSchedules 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:

DescribeSnapshotSchedules, describeSnapshotSchedules_clusterIdentifier - The unique identifier for the cluster whose snapshot schedules you want to view.

DescribeSnapshotSchedules, describeSnapshotSchedules_marker - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

$sel:maxRecords:DescribeSnapshotSchedules', describeSnapshotSchedules_maxRecords - The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

DescribeSnapshotSchedules, describeSnapshotSchedules_scheduleIdentifier - A unique identifier for a snapshot schedule.

$sel:tagKeys:DescribeSnapshotSchedules', describeSnapshotSchedules_tagKeys - The key value for a snapshot schedule tag.

$sel:tagValues:DescribeSnapshotSchedules', describeSnapshotSchedules_tagValues - The value corresponding to the key of the snapshot schedule tag.

Request Lenses

describeSnapshotSchedules_clusterIdentifier :: Lens' DescribeSnapshotSchedules (Maybe Text) Source #

The unique identifier for the cluster whose snapshot schedules you want to view.

describeSnapshotSchedules_marker :: Lens' DescribeSnapshotSchedules (Maybe Text) Source #

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

describeSnapshotSchedules_maxRecords :: Lens' DescribeSnapshotSchedules (Maybe Int) Source #

The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

describeSnapshotSchedules_scheduleIdentifier :: Lens' DescribeSnapshotSchedules (Maybe Text) Source #

A unique identifier for a snapshot schedule.

describeSnapshotSchedules_tagKeys :: Lens' DescribeSnapshotSchedules (Maybe [Text]) Source #

The key value for a snapshot schedule tag.

describeSnapshotSchedules_tagValues :: Lens' DescribeSnapshotSchedules (Maybe [Text]) Source #

The value corresponding to the key of the snapshot schedule tag.

Destructuring the Response

data DescribeSnapshotSchedulesResponse Source #

See: newDescribeSnapshotSchedulesResponse smart constructor.

Constructors

DescribeSnapshotSchedulesResponse' 

Fields

  • marker :: Maybe Text

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

  • snapshotSchedules :: Maybe [SnapshotSchedule]

    A list of SnapshotSchedules.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeSnapshotSchedulesResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Associated Types

type Rep DescribeSnapshotSchedulesResponse :: Type -> Type #

Methods

from :: DescribeSnapshotSchedulesResponse -> Rep DescribeSnapshotSchedulesResponse x #

to :: Rep DescribeSnapshotSchedulesResponse x -> DescribeSnapshotSchedulesResponse #

Read DescribeSnapshotSchedulesResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

readsPrec :: Int -> ReadS DescribeSnapshotSchedulesResponse #

readList :: ReadS [DescribeSnapshotSchedulesResponse] #

readPrec :: ReadPrec DescribeSnapshotSchedulesResponse #

readListPrec :: ReadPrec [DescribeSnapshotSchedulesResponse] #

Show DescribeSnapshotSchedulesResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

showsPrec :: Int -> DescribeSnapshotSchedulesResponse -> ShowS #

show :: DescribeSnapshotSchedulesResponse -> String #

showList :: [DescribeSnapshotSchedulesResponse] -> ShowS #

NFData DescribeSnapshotSchedulesResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

rnf :: DescribeSnapshotSchedulesResponse -> () #

Eq DescribeSnapshotSchedulesResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

Methods

(==) :: DescribeSnapshotSchedulesResponse -> DescribeSnapshotSchedulesResponse -> Bool #

(/=) :: DescribeSnapshotSchedulesResponse -> DescribeSnapshotSchedulesResponse -> Bool #

type Rep DescribeSnapshotSchedulesResponse Source # 
Instance details

Defined in Amazonka.Redshift.DescribeSnapshotSchedules

type Rep DescribeSnapshotSchedulesResponse = D1 ('MetaData "DescribeSnapshotSchedulesResponse" "Amazonka.Redshift.DescribeSnapshotSchedules" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeSnapshotSchedulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "snapshotSchedules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SnapshotSchedule])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSnapshotSchedulesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeSnapshotSchedulesResponse'

-> DescribeSnapshotSchedulesResponse 

Create a value of DescribeSnapshotSchedulesResponse 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:

DescribeSnapshotSchedules, describeSnapshotSchedulesResponse_marker - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

$sel:snapshotSchedules:DescribeSnapshotSchedulesResponse', describeSnapshotSchedulesResponse_snapshotSchedules - A list of SnapshotSchedules.

$sel:httpStatus:DescribeSnapshotSchedulesResponse', describeSnapshotSchedulesResponse_httpStatus - The response's http status code.

Response Lenses

describeSnapshotSchedulesResponse_marker :: Lens' DescribeSnapshotSchedulesResponse (Maybe Text) Source #

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

describeSnapshotSchedulesResponse_snapshotSchedules :: Lens' DescribeSnapshotSchedulesResponse (Maybe [SnapshotSchedule]) Source #

A list of SnapshotSchedules.

describeSnapshotSchedulesResponse_httpStatus :: Lens' DescribeSnapshotSchedulesResponse Int Source #

The response's http status code.