amazonka-kinesisanalyticsv2-2.0: Amazon Kinesis Analytics 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.KinesisAnalyticsV2.ListApplications

Description

Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.

If you want detailed information about a specific application, use DescribeApplication.

This operation returns paginated results.

Synopsis

Creating a Request

data ListApplications Source #

See: newListApplications smart constructor.

Constructors

ListApplications' 

Fields

Instances

Instances details
ToJSON ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

toJSON :: ListApplications -> Value #

toEncoding :: ListApplications -> Encoding #

toJSONList :: [ListApplications] -> Value #

toEncodingList :: [ListApplications] -> Encoding #

ToHeaders ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

toHeaders :: ListApplications -> [Header] #

ToPath ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

toPath :: ListApplications -> ByteString #

ToQuery ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

toQuery :: ListApplications -> QueryString #

AWSPager ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

page :: ListApplications -> AWSResponse ListApplications -> Maybe ListApplications #

AWSRequest ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Associated Types

type AWSResponse ListApplications #

Methods

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

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

Generic ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Associated Types

type Rep ListApplications :: Type -> Type #

Methods

from :: ListApplications -> Rep ListApplications x #

to :: Rep ListApplications x -> ListApplications #

Read ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

readsPrec :: Int -> ReadS ListApplications #

readList :: ReadS [ListApplications] #

readPrec :: ReadPrec ListApplications #

readListPrec :: ReadPrec [ListApplications] #

Show ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

showsPrec :: Int -> ListApplications -> ShowS #

show :: ListApplications -> String #

showList :: [ListApplications] -> ShowS #

NFData ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

rnf :: ListApplications -> () #

Eq ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

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

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

Hashable ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

hashWithSalt :: Int -> ListApplications -> Int #

hash :: ListApplications -> Int #

type AWSResponse ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

type AWSResponse ListApplications = ListApplicationsResponse
type Rep ListApplications Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

type Rep ListApplications = D1 ('MetaData "ListApplications" "Amazonka.KinesisAnalyticsV2.ListApplications" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "ListApplications'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListApplications :: ListApplications Source #

Create a value of ListApplications 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:limit:ListApplications', listApplications_limit - The maximum number of applications to list.

ListApplications, listApplications_nextToken - If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Request Lenses

listApplications_limit :: Lens' ListApplications (Maybe Natural) Source #

The maximum number of applications to list.

listApplications_nextToken :: Lens' ListApplications (Maybe Text) Source #

If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Destructuring the Response

data ListApplicationsResponse Source #

See: newListApplicationsResponse smart constructor.

Constructors

ListApplicationsResponse' 

Fields

Instances

Instances details
Generic ListApplicationsResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Associated Types

type Rep ListApplicationsResponse :: Type -> Type #

Methods

from :: ListApplicationsResponse -> Rep ListApplicationsResponse x #

to :: Rep ListApplicationsResponse x -> ListApplicationsResponse #

Read ListApplicationsResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

readsPrec :: Int -> ReadS ListApplicationsResponse #

readList :: ReadS [ListApplicationsResponse] #

readPrec :: ReadPrec ListApplicationsResponse #

readListPrec :: ReadPrec [ListApplicationsResponse] #

Show ListApplicationsResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

showsPrec :: Int -> ListApplicationsResponse -> ShowS #

show :: ListApplicationsResponse -> String #

showList :: [ListApplicationsResponse] -> ShowS #

NFData ListApplicationsResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

rnf :: ListApplicationsResponse -> () #

Eq ListApplicationsResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

Methods

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

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

type Rep ListApplicationsResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.ListApplications

type Rep ListApplicationsResponse = D1 ('MetaData "ListApplicationsResponse" "Amazonka.KinesisAnalyticsV2.ListApplications" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "ListApplicationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "applicationSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ApplicationSummary]))))

newListApplicationsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListApplicationsResponse'

-> ListApplicationsResponse 

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

ListApplications, listApplicationsResponse_nextToken - The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

$sel:httpStatus:ListApplicationsResponse', listApplicationsResponse_httpStatus - The response's http status code.

$sel:applicationSummaries:ListApplicationsResponse', listApplicationsResponse_applicationSummaries - A list of ApplicationSummary objects.

Response Lenses

listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text) Source #

The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

listApplicationsResponse_httpStatus :: Lens' ListApplicationsResponse Int Source #

The response's http status code.

listApplicationsResponse_applicationSummaries :: Lens' ListApplicationsResponse [ApplicationSummary] Source #

A list of ApplicationSummary objects.