amazonka-timestream-write-2.0: Amazon Timestream Write 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.TimeStreamWrite.ListDatabases

Description

Returns a list of your Timestream databases. Service quotas apply. See code sample for details.

Synopsis

Creating a Request

data ListDatabases Source #

See: newListDatabases smart constructor.

Constructors

ListDatabases' 

Fields

  • maxResults :: Maybe Natural

    The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as 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 ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

ToHeaders ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

ToPath ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

ToQuery ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

AWSRequest ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

Associated Types

type AWSResponse ListDatabases #

Generic ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

Associated Types

type Rep ListDatabases :: Type -> Type #

Read ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

Show ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

NFData ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

Methods

rnf :: ListDatabases -> () #

Eq ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

Hashable ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

type AWSResponse ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

type Rep ListDatabases Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

type Rep ListDatabases = D1 ('MetaData "ListDatabases" "Amazonka.TimeStreamWrite.ListDatabases" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "ListDatabases'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListDatabases :: ListDatabases Source #

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

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

Request Lenses

listDatabases_maxResults :: Lens' ListDatabases (Maybe Natural) Source #

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

listDatabases_nextToken :: Lens' ListDatabases (Maybe Text) Source #

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

Destructuring the Response

data ListDatabasesResponse Source #

See: newListDatabasesResponse smart constructor.

Constructors

ListDatabasesResponse' 

Fields

Instances

Instances details
Generic ListDatabasesResponse Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

Associated Types

type Rep ListDatabasesResponse :: Type -> Type #

Read ListDatabasesResponse Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

Show ListDatabasesResponse Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

NFData ListDatabasesResponse Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

Methods

rnf :: ListDatabasesResponse -> () #

Eq ListDatabasesResponse Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

type Rep ListDatabasesResponse Source # 
Instance details

Defined in Amazonka.TimeStreamWrite.ListDatabases

type Rep ListDatabasesResponse = D1 ('MetaData "ListDatabasesResponse" "Amazonka.TimeStreamWrite.ListDatabases" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "ListDatabasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "databases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Database])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDatabasesResponse Source #

Create a value of ListDatabasesResponse 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:databases:ListDatabasesResponse', listDatabasesResponse_databases - A list of database names.

ListDatabases, listDatabasesResponse_nextToken - The pagination token. This parameter is returned when the response is truncated.

$sel:httpStatus:ListDatabasesResponse', listDatabasesResponse_httpStatus - The response's http status code.

Response Lenses

listDatabasesResponse_nextToken :: Lens' ListDatabasesResponse (Maybe Text) Source #

The pagination token. This parameter is returned when the response is truncated.