amazonka-keyspaces-2.0: Amazon Keyspaces 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.KeySpaces.ListKeyspaces

Description

Returns a list of keyspaces.

This operation returns paginated results.

Synopsis

Creating a Request

data ListKeyspaces Source #

See: newListKeyspaces smart constructor.

Constructors

ListKeyspaces' 

Fields

  • maxResults :: Maybe Natural

    The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

  • nextToken :: Maybe Text

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Instances

Instances details
ToJSON ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

toJSON :: ListKeyspaces -> Value #

toEncoding :: ListKeyspaces -> Encoding #

toJSONList :: [ListKeyspaces] -> Value #

toEncodingList :: [ListKeyspaces] -> Encoding #

ToHeaders ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

toHeaders :: ListKeyspaces -> [Header] #

ToPath ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

toPath :: ListKeyspaces -> ByteString #

ToQuery ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

toQuery :: ListKeyspaces -> QueryString #

AWSPager ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

page :: ListKeyspaces -> AWSResponse ListKeyspaces -> Maybe ListKeyspaces #

AWSRequest ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Associated Types

type AWSResponse ListKeyspaces #

Methods

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

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

Generic ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Associated Types

type Rep ListKeyspaces :: Type -> Type #

Methods

from :: ListKeyspaces -> Rep ListKeyspaces x #

to :: Rep ListKeyspaces x -> ListKeyspaces #

Read ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

readsPrec :: Int -> ReadS ListKeyspaces #

readList :: ReadS [ListKeyspaces] #

readPrec :: ReadPrec ListKeyspaces #

readListPrec :: ReadPrec [ListKeyspaces] #

Show ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

showsPrec :: Int -> ListKeyspaces -> ShowS #

show :: ListKeyspaces -> String #

showList :: [ListKeyspaces] -> ShowS #

NFData ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

rnf :: ListKeyspaces -> () #

Eq ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

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

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

Hashable ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

hashWithSalt :: Int -> ListKeyspaces -> Int #

hash :: ListKeyspaces -> Int #

type AWSResponse ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

type AWSResponse ListKeyspaces = ListKeyspacesResponse
type Rep ListKeyspaces Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

type Rep ListKeyspaces = D1 ('MetaData "ListKeyspaces" "Amazonka.KeySpaces.ListKeyspaces" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "ListKeyspaces'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListKeyspaces :: ListKeyspaces Source #

Create a value of ListKeyspaces 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:maxResults:ListKeyspaces', listKeyspaces_maxResults - The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

ListKeyspaces, listKeyspaces_nextToken - The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Request Lenses

listKeyspaces_maxResults :: Lens' ListKeyspaces (Maybe Natural) Source #

The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

listKeyspaces_nextToken :: Lens' ListKeyspaces (Maybe Text) Source #

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Destructuring the Response

data ListKeyspacesResponse Source #

See: newListKeyspacesResponse smart constructor.

Constructors

ListKeyspacesResponse' 

Fields

Instances

Instances details
Generic ListKeyspacesResponse Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Associated Types

type Rep ListKeyspacesResponse :: Type -> Type #

Methods

from :: ListKeyspacesResponse -> Rep ListKeyspacesResponse x #

to :: Rep ListKeyspacesResponse x -> ListKeyspacesResponse #

Read ListKeyspacesResponse Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

readsPrec :: Int -> ReadS ListKeyspacesResponse #

readList :: ReadS [ListKeyspacesResponse] #

readPrec :: ReadPrec ListKeyspacesResponse #

readListPrec :: ReadPrec [ListKeyspacesResponse] #

Show ListKeyspacesResponse Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

showsPrec :: Int -> ListKeyspacesResponse -> ShowS #

show :: ListKeyspacesResponse -> String #

showList :: [ListKeyspacesResponse] -> ShowS #

NFData ListKeyspacesResponse Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

rnf :: ListKeyspacesResponse -> () #

Eq ListKeyspacesResponse Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

Methods

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

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

type Rep ListKeyspacesResponse Source # 
Instance details

Defined in Amazonka.KeySpaces.ListKeyspaces

type Rep ListKeyspacesResponse = D1 ('MetaData "ListKeyspacesResponse" "Amazonka.KeySpaces.ListKeyspaces" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "ListKeyspacesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "keyspaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [KeyspaceSummary]))))

newListKeyspacesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListKeyspacesResponse'

-> ListKeyspacesResponse 

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

ListKeyspaces, listKeyspacesResponse_nextToken - A token to specify where to start paginating. This is the NextToken from a previously truncated response.

$sel:httpStatus:ListKeyspacesResponse', listKeyspacesResponse_httpStatus - The response's http status code.

$sel:keyspaces:ListKeyspacesResponse', listKeyspacesResponse_keyspaces - A list of keyspaces.

Response Lenses

listKeyspacesResponse_nextToken :: Lens' ListKeyspacesResponse (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listKeyspacesResponse_httpStatus :: Lens' ListKeyspacesResponse Int Source #

The response's http status code.

listKeyspacesResponse_keyspaces :: Lens' ListKeyspacesResponse [KeyspaceSummary] Source #

A list of keyspaces.