Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RedshiftServerLess.ListSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of snapshots.

This operation returns paginated results.

Synopsis

data ListSnapshots = ListSnapshots' {
- endTime :: Maybe POSIX
- maxResults :: Maybe Natural
- namespaceArn :: Maybe Text
- namespaceName :: Maybe Text
- nextToken :: Maybe Text
- ownerAccount :: Maybe Text
- startTime :: Maybe POSIX
}
newListSnapshots :: ListSnapshots
listSnapshots_endTime :: Lens' ListSnapshots (Maybe UTCTime)
listSnapshots_maxResults :: Lens' ListSnapshots (Maybe Natural)
listSnapshots_namespaceArn :: Lens' ListSnapshots (Maybe Text)
listSnapshots_namespaceName :: Lens' ListSnapshots (Maybe Text)
listSnapshots_nextToken :: Lens' ListSnapshots (Maybe Text)
listSnapshots_ownerAccount :: Lens' ListSnapshots (Maybe Text)
listSnapshots_startTime :: Lens' ListSnapshots (Maybe UTCTime)
data ListSnapshotsResponse = ListSnapshotsResponse' {
- nextToken :: Maybe Text
- snapshots :: Maybe [Snapshot]
- httpStatus :: Int
}
newListSnapshotsResponse :: Int -> ListSnapshotsResponse
listSnapshotsResponse_nextToken :: Lens' ListSnapshotsResponse (Maybe Text)
listSnapshotsResponse_snapshots :: Lens' ListSnapshotsResponse (Maybe [Snapshot])
listSnapshotsResponse_httpStatus :: Lens' ListSnapshotsResponse Int

Creating a Request

data ListSnapshots Source #

See: newListSnapshots smart constructor.

Constructors

ListSnapshots'

Fields

endTime :: Maybe POSIX
The timestamp showing when the snapshot creation finished.
maxResults :: Maybe Natural
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
namespaceArn :: Maybe Text
The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
namespaceName :: Maybe Text
The namespace from which to list all snapshots.
nextToken :: Maybe Text
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
ownerAccount :: Maybe Text
The owner Amazon Web Services account of the snapshot.
startTime :: Maybe POSIX
The time when the creation of the snapshot was initiated.

Instances

Instances details

ToJSON ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods toJSON :: ListSnapshots -> Value # toEncoding :: ListSnapshots -> Encoding # toJSONList :: [ListSnapshots] -> Value # toEncodingList :: [ListSnapshots] -> Encoding #
ToHeaders ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods toHeaders :: ListSnapshots -> [Header] #
ToPath ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods toPath :: ListSnapshots -> ByteString #
ToQuery ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods toQuery :: ListSnapshots -> QueryString #
AWSPager ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods page :: ListSnapshots -> AWSResponse ListSnapshots -> Maybe ListSnapshots #
AWSRequest ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Associated Types type AWSResponse ListSnapshots # Methods request :: (Service -> Service) -> ListSnapshots -> Request ListSnapshots # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSnapshots))) #
Generic ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Associated Types type Rep ListSnapshots :: Type -> Type # Methods from :: ListSnapshots -> Rep ListSnapshots x # to :: Rep ListSnapshots x -> ListSnapshots #
Read ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods readsPrec :: Int -> ReadS ListSnapshots # readList :: ReadS [ListSnapshots] # readPrec :: ReadPrec ListSnapshots # readListPrec :: ReadPrec [ListSnapshots] #
Show ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods showsPrec :: Int -> ListSnapshots -> ShowS # show :: ListSnapshots -> String # showList :: [ListSnapshots] -> ShowS #
NFData ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods rnf :: ListSnapshots -> () #
Eq ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods (==) :: ListSnapshots -> ListSnapshots -> Bool # (/=) :: ListSnapshots -> ListSnapshots -> Bool #
Hashable ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods hashWithSalt :: Int -> ListSnapshots -> Int # hash :: ListSnapshots -> Int #
type AWSResponse ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots type AWSResponse ListSnapshots = ListSnapshotsResponse
type Rep ListSnapshots Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots type Rep ListSnapshots = D1 ('MetaData "ListSnapshots" "Amazonka.RedshiftServerLess.ListSnapshots" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "ListSnapshots'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "namespaceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "namespaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newListSnapshots :: ListSnapshots Source #

Create a value of ListSnapshots 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:endTime:ListSnapshots', listSnapshots_endTime - The timestamp showing when the snapshot creation finished.

$sel:maxResults:ListSnapshots', listSnapshots_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

ListSnapshots, listSnapshots_namespaceArn - The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

ListSnapshots, listSnapshots_namespaceName - The namespace from which to list all snapshots.

ListSnapshots, listSnapshots_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

ListSnapshots, listSnapshots_ownerAccount - The owner Amazon Web Services account of the snapshot.

$sel:startTime:ListSnapshots', listSnapshots_startTime - The time when the creation of the snapshot was initiated.

Request Lenses

listSnapshots_endTime :: Lens' ListSnapshots (Maybe UTCTime) Source #

The timestamp showing when the snapshot creation finished.

listSnapshots_maxResults :: Lens' ListSnapshots (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listSnapshots_namespaceArn :: Lens' ListSnapshots (Maybe Text) Source #

The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

listSnapshots_namespaceName :: Lens' ListSnapshots (Maybe Text) Source #

The namespace from which to list all snapshots.

listSnapshots_nextToken :: Lens' ListSnapshots (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

listSnapshots_ownerAccount :: Lens' ListSnapshots (Maybe Text) Source #

The owner Amazon Web Services account of the snapshot.

listSnapshots_startTime :: Lens' ListSnapshots (Maybe UTCTime) Source #

The time when the creation of the snapshot was initiated.

Destructuring the Response

data ListSnapshotsResponse Source #

See: newListSnapshotsResponse smart constructor.

Constructors

ListSnapshotsResponse'
Fields nextToken :: Maybe Text If `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. snapshots :: Maybe [Snapshot] All of the returned snapshot objects. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListSnapshotsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Associated Types type Rep ListSnapshotsResponse :: Type -> Type # Methods from :: ListSnapshotsResponse -> Rep ListSnapshotsResponse x # to :: Rep ListSnapshotsResponse x -> ListSnapshotsResponse #
Read ListSnapshotsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods readsPrec :: Int -> ReadS ListSnapshotsResponse # readList :: ReadS [ListSnapshotsResponse] # readPrec :: ReadPrec ListSnapshotsResponse # readListPrec :: ReadPrec [ListSnapshotsResponse] #
Show ListSnapshotsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods showsPrec :: Int -> ListSnapshotsResponse -> ShowS # show :: ListSnapshotsResponse -> String # showList :: [ListSnapshotsResponse] -> ShowS #
NFData ListSnapshotsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods rnf :: ListSnapshotsResponse -> () #
Eq ListSnapshotsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots Methods (==) :: ListSnapshotsResponse -> ListSnapshotsResponse -> Bool # (/=) :: ListSnapshotsResponse -> ListSnapshotsResponse -> Bool #
type Rep ListSnapshotsResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.ListSnapshots type Rep ListSnapshotsResponse = D1 ('MetaData "ListSnapshotsResponse" "Amazonka.RedshiftServerLess.ListSnapshots" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "ListSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "snapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Snapshot])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSnapshotsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListSnapshotsResponse'`
-> ListSnapshotsResponse

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

ListSnapshots, listSnapshotsResponse_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:snapshots:ListSnapshotsResponse', listSnapshotsResponse_snapshots - All of the returned snapshot objects.

$sel:httpStatus:ListSnapshotsResponse', listSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

listSnapshotsResponse_nextToken :: Lens' ListSnapshotsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

listSnapshotsResponse_snapshots :: Lens' ListSnapshotsResponse (Maybe [Snapshot]) Source #

All of the returned snapshot objects.

listSnapshotsResponse_httpStatus :: Lens' ListSnapshotsResponse Int Source #

The response's http status code.