amazonka-amplify-2.0: Amazon Amplify 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.Amplify.ListBackendEnvironments

Description

Lists the backend environments for an Amplify app.

Synopsis

Creating a Request

data ListBackendEnvironments Source #

The request structure for the list backend environments request.

See: newListBackendEnvironments smart constructor.

Constructors

ListBackendEnvironments' 

Fields

  • environmentName :: Maybe Text

    The name of the backend environment

  • maxResults :: Maybe Natural

    The maximum number of records to list in a single response.

  • nextToken :: Maybe Text

    A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.

  • appId :: Text

    The unique ID for an Amplify app.

Instances

Instances details
ToHeaders ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

toHeaders :: ListBackendEnvironments -> [Header] #

ToPath ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

toPath :: ListBackendEnvironments -> ByteString #

ToQuery ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

toQuery :: ListBackendEnvironments -> QueryString #

AWSRequest ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Associated Types

type AWSResponse ListBackendEnvironments #

Methods

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

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

Generic ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Associated Types

type Rep ListBackendEnvironments :: Type -> Type #

Methods

from :: ListBackendEnvironments -> Rep ListBackendEnvironments x #

to :: Rep ListBackendEnvironments x -> ListBackendEnvironments #

Read ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

readsPrec :: Int -> ReadS ListBackendEnvironments #

readList :: ReadS [ListBackendEnvironments] #

readPrec :: ReadPrec ListBackendEnvironments #

readListPrec :: ReadPrec [ListBackendEnvironments] #

Show ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

showsPrec :: Int -> ListBackendEnvironments -> ShowS #

show :: ListBackendEnvironments -> String #

showList :: [ListBackendEnvironments] -> ShowS #

NFData ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

rnf :: ListBackendEnvironments -> () #

Eq ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

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

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

Hashable ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

hashWithSalt :: Int -> ListBackendEnvironments -> Int #

hash :: ListBackendEnvironments -> Int #

type AWSResponse ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

type AWSResponse ListBackendEnvironments = ListBackendEnvironmentsResponse
type Rep ListBackendEnvironments Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

type Rep ListBackendEnvironments = D1 ('MetaData "ListBackendEnvironments" "Amazonka.Amplify.ListBackendEnvironments" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "ListBackendEnvironments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListBackendEnvironments Source #

Arguments

:: Text

ListBackendEnvironments

-> ListBackendEnvironments 

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

ListBackendEnvironments, listBackendEnvironments_environmentName - The name of the backend environment

$sel:maxResults:ListBackendEnvironments', listBackendEnvironments_maxResults - The maximum number of records to list in a single response.

ListBackendEnvironments, listBackendEnvironments_nextToken - A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.

ListBackendEnvironments, listBackendEnvironments_appId - The unique ID for an Amplify app.

Request Lenses

listBackendEnvironments_environmentName :: Lens' ListBackendEnvironments (Maybe Text) Source #

The name of the backend environment

listBackendEnvironments_maxResults :: Lens' ListBackendEnvironments (Maybe Natural) Source #

The maximum number of records to list in a single response.

listBackendEnvironments_nextToken :: Lens' ListBackendEnvironments (Maybe Text) Source #

A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.

listBackendEnvironments_appId :: Lens' ListBackendEnvironments Text Source #

The unique ID for an Amplify app.

Destructuring the Response

data ListBackendEnvironmentsResponse Source #

The result structure for the list backend environments result.

See: newListBackendEnvironmentsResponse smart constructor.

Constructors

ListBackendEnvironmentsResponse' 

Fields

Instances

Instances details
Generic ListBackendEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Associated Types

type Rep ListBackendEnvironmentsResponse :: Type -> Type #

Methods

from :: ListBackendEnvironmentsResponse -> Rep ListBackendEnvironmentsResponse x #

to :: Rep ListBackendEnvironmentsResponse x -> ListBackendEnvironmentsResponse #

Read ListBackendEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

readsPrec :: Int -> ReadS ListBackendEnvironmentsResponse #

readList :: ReadS [ListBackendEnvironmentsResponse] #

readPrec :: ReadPrec ListBackendEnvironmentsResponse #

readListPrec :: ReadPrec [ListBackendEnvironmentsResponse] #

Show ListBackendEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

showsPrec :: Int -> ListBackendEnvironmentsResponse -> ShowS #

show :: ListBackendEnvironmentsResponse -> String #

showList :: [ListBackendEnvironmentsResponse] -> ShowS #

NFData ListBackendEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

rnf :: ListBackendEnvironmentsResponse -> () #

Eq ListBackendEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

Methods

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

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

type Rep ListBackendEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBackendEnvironments

type Rep ListBackendEnvironmentsResponse = D1 ('MetaData "ListBackendEnvironmentsResponse" "Amazonka.Amplify.ListBackendEnvironments" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "ListBackendEnvironmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "backendEnvironments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BackendEnvironment]))))

newListBackendEnvironmentsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListBackendEnvironmentsResponse'

-> ListBackendEnvironmentsResponse 

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

ListBackendEnvironments, listBackendEnvironmentsResponse_nextToken - A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

$sel:httpStatus:ListBackendEnvironmentsResponse', listBackendEnvironmentsResponse_httpStatus - The response's http status code.

$sel:backendEnvironments:ListBackendEnvironmentsResponse', listBackendEnvironmentsResponse_backendEnvironments - The list of backend environments for an Amplify app.

Response Lenses

listBackendEnvironmentsResponse_nextToken :: Lens' ListBackendEnvironmentsResponse (Maybe Text) Source #

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

listBackendEnvironmentsResponse_httpStatus :: Lens' ListBackendEnvironmentsResponse Int Source #

The response's http status code.

listBackendEnvironmentsResponse_backendEnvironments :: Lens' ListBackendEnvironmentsResponse [BackendEnvironment] Source #

The list of backend environments for an Amplify app.