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.ListEnvironments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the runtime environments.

This operation returns paginated results.

Synopsis

data ListEnvironments = ListEnvironments' {
- engineType :: Maybe EngineType
- maxResults :: Maybe Natural
- names :: Maybe (NonEmpty Text)
- nextToken :: Maybe Text
}
newListEnvironments :: ListEnvironments
listEnvironments_engineType :: Lens' ListEnvironments (Maybe EngineType)
listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural)
listEnvironments_names :: Lens' ListEnvironments (Maybe (NonEmpty Text))
listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text)
data ListEnvironmentsResponse = ListEnvironmentsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- environments :: [EnvironmentSummary]
}
newListEnvironmentsResponse :: Int -> ListEnvironmentsResponse
listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text)
listEnvironmentsResponse_httpStatus :: Lens' ListEnvironmentsResponse Int
listEnvironmentsResponse_environments :: Lens' ListEnvironmentsResponse [EnvironmentSummary]

Creating a Request

data ListEnvironments Source #

See: newListEnvironments smart constructor.

Constructors

ListEnvironments'
Fields engineType :: Maybe EngineType The engine type for the runtime environment. maxResults :: Maybe Natural The maximum number of runtime environments to return. names :: Maybe (NonEmpty Text) The names of the runtime environments. Must be unique within the account. nextToken :: Maybe Text A pagination token to control the number of runtime environments displayed in the list.

Instances

Instances details

ToHeaders ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods toHeaders :: ListEnvironments -> [Header] #
ToPath ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods toPath :: ListEnvironments -> ByteString #
ToQuery ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods toQuery :: ListEnvironments -> QueryString #
AWSPager ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods page :: ListEnvironments -> AWSResponse ListEnvironments -> Maybe ListEnvironments #
AWSRequest ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Associated Types type AWSResponse ListEnvironments # Methods request :: (Service -> Service) -> ListEnvironments -> Request ListEnvironments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListEnvironments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListEnvironments))) #
Generic ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Associated Types type Rep ListEnvironments :: Type -> Type # Methods from :: ListEnvironments -> Rep ListEnvironments x # to :: Rep ListEnvironments x -> ListEnvironments #
Read ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods readsPrec :: Int -> ReadS ListEnvironments # readList :: ReadS [ListEnvironments] # readPrec :: ReadPrec ListEnvironments # readListPrec :: ReadPrec [ListEnvironments] #
Show ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods showsPrec :: Int -> ListEnvironments -> ShowS # show :: ListEnvironments -> String # showList :: [ListEnvironments] -> ShowS #
NFData ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods rnf :: ListEnvironments -> () #
Eq ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods (==) :: ListEnvironments -> ListEnvironments -> Bool # (/=) :: ListEnvironments -> ListEnvironments -> Bool #
Hashable ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments Methods hashWithSalt :: Int -> ListEnvironments -> Int # hash :: ListEnvironments -> Int #
type AWSResponse ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments type AWSResponse ListEnvironments = ListEnvironmentsResponse
type Rep ListEnvironments Source #
Instance details Defined in Amazonka.M2.ListEnvironments type Rep ListEnvironments = D1 ('MetaData "ListEnvironments" "Amazonka.M2.ListEnvironments" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "ListEnvironments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineType)) :: 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)))))

newListEnvironments :: ListEnvironments Source #

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

ListEnvironments, listEnvironments_engineType - The engine type for the runtime environment.

$sel:maxResults:ListEnvironments', listEnvironments_maxResults - The maximum number of runtime environments to return.

$sel:names:ListEnvironments', listEnvironments_names - The names of the runtime environments. Must be unique within the account.

ListEnvironments, listEnvironments_nextToken - A pagination token to control the number of runtime environments displayed in the list.

Request Lenses

listEnvironments_engineType :: Lens' ListEnvironments (Maybe EngineType) Source #

The engine type for the runtime environment.

listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural) Source #

The maximum number of runtime environments to return.

listEnvironments_names :: Lens' ListEnvironments (Maybe (NonEmpty Text)) Source #

The names of the runtime environments. Must be unique within the account.

listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text) Source #

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

Destructuring the Response

data ListEnvironmentsResponse Source #

See: newListEnvironmentsResponse smart constructor.

Constructors

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

Instances

Instances details

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

newListEnvironmentsResponse Source #

Arguments

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

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

ListEnvironments, listEnvironmentsResponse_nextToken - A pagination token that's returned when the response doesn't contain all the runtime environments.

$sel:httpStatus:ListEnvironmentsResponse', listEnvironmentsResponse_httpStatus - The response's http status code.

$sel:environments:ListEnvironmentsResponse', listEnvironmentsResponse_environments - Returns a list of summary details for all the runtime environments in your account.

Response Lenses

listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text) Source #

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

listEnvironmentsResponse_httpStatus :: Lens' ListEnvironmentsResponse Int Source #

The response's http status code.

listEnvironmentsResponse_environments :: Lens' ListEnvironmentsResponse [EnvironmentSummary] Source #

Returns a list of summary details for all the runtime environments in your account.