Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AmplifyBackend.GetBackend

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides project-level details for your Amplify UI project.

Synopsis

data GetBackend = GetBackend' {
- backendEnvironmentName :: Maybe Text
- appId :: Text
}
newGetBackend :: Text -> GetBackend
getBackend_backendEnvironmentName :: Lens' GetBackend (Maybe Text)
getBackend_appId :: Lens' GetBackend Text
data GetBackendResponse = GetBackendResponse' {
- error :: Maybe Text
- appName :: Maybe Text
- amplifyMetaConfig :: Maybe Text
- appId :: Maybe Text
- amplifyFeatureFlags :: Maybe Text
- backendEnvironmentList :: Maybe [Text]
- backendEnvironmentName :: Maybe Text
- httpStatus :: Int
}
newGetBackendResponse :: Int -> GetBackendResponse
getBackendResponse_error :: Lens' GetBackendResponse (Maybe Text)
getBackendResponse_appName :: Lens' GetBackendResponse (Maybe Text)
getBackendResponse_amplifyMetaConfig :: Lens' GetBackendResponse (Maybe Text)
getBackendResponse_appId :: Lens' GetBackendResponse (Maybe Text)
getBackendResponse_amplifyFeatureFlags :: Lens' GetBackendResponse (Maybe Text)
getBackendResponse_backendEnvironmentList :: Lens' GetBackendResponse (Maybe [Text])
getBackendResponse_backendEnvironmentName :: Lens' GetBackendResponse (Maybe Text)
getBackendResponse_httpStatus :: Lens' GetBackendResponse Int

Creating a Request

data GetBackend Source #

The request body for GetBackend.

See: newGetBackend smart constructor.

Constructors

GetBackend'
Fields backendEnvironmentName :: Maybe Text The name of the backend environment. appId :: Text The app ID.

Instances

Instances details

Eq GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods (==) :: GetBackend -> GetBackend -> Bool # (/=) :: GetBackend -> GetBackend -> Bool #
Read GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods readsPrec :: Int -> ReadS GetBackend # readList :: ReadS [GetBackend] # readPrec :: ReadPrec GetBackend # readListPrec :: ReadPrec [GetBackend] #
Show GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods showsPrec :: Int -> GetBackend -> ShowS # show :: GetBackend -> String # showList :: [GetBackend] -> ShowS #
Generic GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Associated Types type Rep GetBackend :: Type -> Type # Methods from :: GetBackend -> Rep GetBackend x # to :: Rep GetBackend x -> GetBackend #
NFData GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods rnf :: GetBackend -> () #
Hashable GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods hashWithSalt :: Int -> GetBackend -> Int # hash :: GetBackend -> Int #
ToJSON GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods toJSON :: GetBackend -> Value # toEncoding :: GetBackend -> Encoding # toJSONList :: [GetBackend] -> Value # toEncodingList :: [GetBackend] -> Encoding #
AWSRequest GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Associated Types type AWSResponse GetBackend # Methods request :: GetBackend -> Request GetBackend # response :: MonadResource m => Logger -> Service -> Proxy GetBackend -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBackend))) #
ToHeaders GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods toHeaders :: GetBackend -> [Header] #
ToPath GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods toPath :: GetBackend -> ByteString #
ToQuery GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods toQuery :: GetBackend -> QueryString #
type Rep GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend type Rep GetBackend = D1 ('MetaData "GetBackend" "Amazonka.AmplifyBackend.GetBackend" "libZSservicesZSamazonka-amplifybackendZSamazonka-amplifybackend" 'False) (C1 ('MetaCons "GetBackend'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backendEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetBackend Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend type AWSResponse GetBackend = GetBackendResponse

newGetBackend Source #

Arguments

:: Text	`$sel:appId:GetBackend'`
-> GetBackend

Create a value of GetBackend 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:backendEnvironmentName:GetBackend', getBackend_backendEnvironmentName - The name of the backend environment.

$sel:appId:GetBackend', getBackend_appId - The app ID.

Request Lenses

getBackend_backendEnvironmentName :: Lens' GetBackend (Maybe Text) Source #

The name of the backend environment.

getBackend_appId :: Lens' GetBackend Text Source #

The app ID.

Destructuring the Response

data GetBackendResponse Source #

See: newGetBackendResponse smart constructor.

Constructors

GetBackendResponse'

Fields

error :: Maybe Text
If the request failed, this is the returned error.
appName :: Maybe Text
The name of the app.
amplifyMetaConfig :: Maybe Text
A stringified version of the current configs for your Amplify project.
appId :: Maybe Text
The app ID.
amplifyFeatureFlags :: Maybe Text
A stringified version of the cli.json file for your Amplify project.
backendEnvironmentList :: Maybe [Text]
A list of backend environments in an array.
backendEnvironmentName :: Maybe Text
The name of the backend environment.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods (==) :: GetBackendResponse -> GetBackendResponse -> Bool # (/=) :: GetBackendResponse -> GetBackendResponse -> Bool #
Read GetBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods readsPrec :: Int -> ReadS GetBackendResponse # readList :: ReadS [GetBackendResponse] # readPrec :: ReadPrec GetBackendResponse # readListPrec :: ReadPrec [GetBackendResponse] #
Show GetBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods showsPrec :: Int -> GetBackendResponse -> ShowS # show :: GetBackendResponse -> String # showList :: [GetBackendResponse] -> ShowS #
Generic GetBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Associated Types type Rep GetBackendResponse :: Type -> Type # Methods from :: GetBackendResponse -> Rep GetBackendResponse x # to :: Rep GetBackendResponse x -> GetBackendResponse #
NFData GetBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend Methods rnf :: GetBackendResponse -> () #
type Rep GetBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackend type Rep GetBackendResponse = D1 ('MetaData "GetBackendResponse" "Amazonka.AmplifyBackend.GetBackend" "libZSservicesZSamazonka-amplifybackendZSamazonka-amplifybackend" 'False) (C1 ('MetaCons "GetBackendResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "amplifyMetaConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "amplifyFeatureFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "backendEnvironmentList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "backendEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetBackendResponse Source #

Arguments

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

Create a value of GetBackendResponse 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:error:GetBackendResponse', getBackendResponse_error - If the request failed, this is the returned error.

$sel:appName:GetBackendResponse', getBackendResponse_appName - The name of the app.

$sel:amplifyMetaConfig:GetBackendResponse', getBackendResponse_amplifyMetaConfig - A stringified version of the current configs for your Amplify project.

$sel:appId:GetBackend', getBackendResponse_appId - The app ID.

$sel:amplifyFeatureFlags:GetBackendResponse', getBackendResponse_amplifyFeatureFlags - A stringified version of the cli.json file for your Amplify project.

$sel:backendEnvironmentList:GetBackendResponse', getBackendResponse_backendEnvironmentList - A list of backend environments in an array.

$sel:backendEnvironmentName:GetBackend', getBackendResponse_backendEnvironmentName - The name of the backend environment.

$sel:httpStatus:GetBackendResponse', getBackendResponse_httpStatus - The response's http status code.

Response Lenses

getBackendResponse_error :: Lens' GetBackendResponse (Maybe Text) Source #

If the request failed, this is the returned error.

getBackendResponse_appName :: Lens' GetBackendResponse (Maybe Text) Source #

The name of the app.

getBackendResponse_amplifyMetaConfig :: Lens' GetBackendResponse (Maybe Text) Source #

A stringified version of the current configs for your Amplify project.

getBackendResponse_appId :: Lens' GetBackendResponse (Maybe Text) Source #

The app ID.

getBackendResponse_amplifyFeatureFlags :: Lens' GetBackendResponse (Maybe Text) Source #

A stringified version of the cli.json file for your Amplify project.

getBackendResponse_backendEnvironmentList :: Lens' GetBackendResponse (Maybe [Text]) Source #

A list of backend environments in an array.

getBackendResponse_backendEnvironmentName :: Lens' GetBackendResponse (Maybe Text) Source #

The name of the backend environment.

getBackendResponse_httpStatus :: Lens' GetBackendResponse Int Source #

The response's http status code.