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.M2.ListApplications

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.

This operation returns paginated results.

Synopsis

data ListApplications = ListApplications' {
- environmentId :: Maybe Text
- maxResults :: Maybe Natural
- names :: Maybe (NonEmpty Text)
- nextToken :: Maybe Text
}
newListApplications :: ListApplications
listApplications_environmentId :: Lens' ListApplications (Maybe Text)
listApplications_maxResults :: Lens' ListApplications (Maybe Natural)
listApplications_names :: Lens' ListApplications (Maybe (NonEmpty Text))
listApplications_nextToken :: Lens' ListApplications (Maybe Text)
data ListApplicationsResponse = ListApplicationsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- applications :: [ApplicationSummary]
}
newListApplicationsResponse :: Int -> ListApplicationsResponse
listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text)
listApplicationsResponse_httpStatus :: Lens' ListApplicationsResponse Int
listApplicationsResponse_applications :: Lens' ListApplicationsResponse [ApplicationSummary]

Creating a Request

data ListApplications Source #

See: newListApplications smart constructor.

Constructors

ListApplications'
Fields environmentId :: Maybe Text The unique identifier of the runtime environment where the applications are deployed. maxResults :: Maybe Natural The maximum number of applications to return. names :: Maybe (NonEmpty Text) The names of the applications. nextToken :: Maybe Text A pagination token to control the number of applications displayed in the list.

Instances

Instances details

ToHeaders ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications Methods toHeaders :: ListApplications -> [Header] #
ToPath ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications Methods toPath :: ListApplications -> ByteString #
ToQuery ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications Methods toQuery :: ListApplications -> QueryString #
AWSPager ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications Methods page :: ListApplications -> AWSResponse ListApplications -> Maybe ListApplications #
AWSRequest ListApplications Source #
Instance details Defined in Amazonka.M2.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.M2.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.M2.ListApplications Methods readsPrec :: Int -> ReadS ListApplications # readList :: ReadS [ListApplications] # readPrec :: ReadPrec ListApplications # readListPrec :: ReadPrec [ListApplications] #
Show ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications Methods showsPrec :: Int -> ListApplications -> ShowS # show :: ListApplications -> String # showList :: [ListApplications] -> ShowS #
NFData ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications Methods rnf :: ListApplications -> () #
Eq ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications Methods (==) :: ListApplications -> ListApplications -> Bool # (/=) :: ListApplications -> ListApplications -> Bool #
Hashable ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications Methods hashWithSalt :: Int -> ListApplications -> Int # hash :: ListApplications -> Int #
type AWSResponse ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications type AWSResponse ListApplications = ListApplicationsResponse
type Rep ListApplications Source #
Instance details Defined in Amazonka.M2.ListApplications type Rep ListApplications = D1 ('MetaData "ListApplications" "Amazonka.M2.ListApplications" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "ListApplications'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: 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:

ListApplications, listApplications_environmentId - The unique identifier of the runtime environment where the applications are deployed.

$sel:maxResults:ListApplications', listApplications_maxResults - The maximum number of applications to return.

$sel:names:ListApplications', listApplications_names - The names of the applications.

ListApplications, listApplications_nextToken - A pagination token to control the number of applications displayed in the list.

Request Lenses

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

The unique identifier of the runtime environment where the applications are deployed.

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

The maximum number of applications to return.

listApplications_names :: Lens' ListApplications (Maybe (NonEmpty Text)) Source #

The names of the applications.

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

A pagination token to control the number of applications displayed in the list.

Destructuring the Response

data ListApplicationsResponse Source #

See: newListApplicationsResponse smart constructor.

Constructors

ListApplicationsResponse'
Fields nextToken :: Maybe Text A pagination token that's returned when the response doesn't contain all applications. httpStatus :: Int The response's http status code. applications :: [ApplicationSummary] Returns a list of summary details for all the applications in a runtime environment.

Instances

Instances details

Generic ListApplicationsResponse Source #
Instance details Defined in Amazonka.M2.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.M2.ListApplications Methods readsPrec :: Int -> ReadS ListApplicationsResponse # readList :: ReadS [ListApplicationsResponse] # readPrec :: ReadPrec ListApplicationsResponse # readListPrec :: ReadPrec [ListApplicationsResponse] #
Show ListApplicationsResponse Source #
Instance details Defined in Amazonka.M2.ListApplications Methods showsPrec :: Int -> ListApplicationsResponse -> ShowS # show :: ListApplicationsResponse -> String # showList :: [ListApplicationsResponse] -> ShowS #
NFData ListApplicationsResponse Source #
Instance details Defined in Amazonka.M2.ListApplications Methods rnf :: ListApplicationsResponse -> () #
Eq ListApplicationsResponse Source #
Instance details Defined in Amazonka.M2.ListApplications Methods (==) :: ListApplicationsResponse -> ListApplicationsResponse -> Bool # (/=) :: ListApplicationsResponse -> ListApplicationsResponse -> Bool #
type Rep ListApplicationsResponse Source #
Instance details Defined in Amazonka.M2.ListApplications type Rep ListApplicationsResponse = D1 ('MetaData "ListApplicationsResponse" "Amazonka.M2.ListApplications" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" '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 "applications") '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 - A pagination token that's returned when the response doesn't contain all applications.

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

$sel:applications:ListApplicationsResponse', listApplicationsResponse_applications - Returns a list of summary details for all the applications in a runtime environment.

Response Lenses

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

A pagination token that's returned when the response doesn't contain all applications.

listApplicationsResponse_httpStatus :: Lens' ListApplicationsResponse Int Source #

The response's http status code.

listApplicationsResponse_applications :: Lens' ListApplicationsResponse [ApplicationSummary] Source #

Returns a list of summary details for all the applications in a runtime environment.