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.AmplifyBackend.GetBackendAuth

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a backend auth details.

Synopsis

data GetBackendAuth = GetBackendAuth' {
- appId :: Text
- backendEnvironmentName :: Text
- resourceName :: Text
}
newGetBackendAuth :: Text -> Text -> Text -> GetBackendAuth
getBackendAuth_appId :: Lens' GetBackendAuth Text
getBackendAuth_backendEnvironmentName :: Lens' GetBackendAuth Text
getBackendAuth_resourceName :: Lens' GetBackendAuth Text
data GetBackendAuthResponse = GetBackendAuthResponse' {
- appId :: Maybe Text
- backendEnvironmentName :: Maybe Text
- error :: Maybe Text
- resourceConfig :: Maybe CreateBackendAuthResourceConfig
- resourceName :: Maybe Text
- httpStatus :: Int
}
newGetBackendAuthResponse :: Int -> GetBackendAuthResponse
getBackendAuthResponse_appId :: Lens' GetBackendAuthResponse (Maybe Text)
getBackendAuthResponse_backendEnvironmentName :: Lens' GetBackendAuthResponse (Maybe Text)
getBackendAuthResponse_error :: Lens' GetBackendAuthResponse (Maybe Text)
getBackendAuthResponse_resourceConfig :: Lens' GetBackendAuthResponse (Maybe CreateBackendAuthResourceConfig)
getBackendAuthResponse_resourceName :: Lens' GetBackendAuthResponse (Maybe Text)
getBackendAuthResponse_httpStatus :: Lens' GetBackendAuthResponse Int

Creating a Request

data GetBackendAuth Source #

The request body for GetBackendAuth.

See: newGetBackendAuth smart constructor.

Constructors

GetBackendAuth'
Fields appId :: Text The app ID. backendEnvironmentName :: Text The name of the backend environment. resourceName :: Text The name of this resource.

Instances

Instances details

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

newGetBackendAuth Source #

Arguments

:: Text	`GetBackendAuth`
-> Text	`GetBackendAuth`
-> Text	`GetBackendAuth`
-> GetBackendAuth

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

GetBackendAuth, getBackendAuth_appId - The app ID.

GetBackendAuth, getBackendAuth_backendEnvironmentName - The name of the backend environment.

GetBackendAuth, getBackendAuth_resourceName - The name of this resource.

Request Lenses

getBackendAuth_appId :: Lens' GetBackendAuth Text Source #

The app ID.

getBackendAuth_backendEnvironmentName :: Lens' GetBackendAuth Text Source #

The name of the backend environment.

getBackendAuth_resourceName :: Lens' GetBackendAuth Text Source #

The name of this resource.

Destructuring the Response

data GetBackendAuthResponse Source #

See: newGetBackendAuthResponse smart constructor.

Constructors

GetBackendAuthResponse'

Fields

appId :: Maybe Text
The app ID.
backendEnvironmentName :: Maybe Text
The name of the backend environment.
error :: Maybe Text
If the request fails, this error is returned.
resourceConfig :: Maybe CreateBackendAuthResourceConfig
The resource configuration for authorization requests to the backend of your Amplify project.
resourceName :: Maybe Text
The name of this resource.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetBackendAuthResponse Source #

Arguments

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

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

GetBackendAuth, getBackendAuthResponse_appId - The app ID.

GetBackendAuth, getBackendAuthResponse_backendEnvironmentName - The name of the backend environment.

GetBackendAuthResponse, getBackendAuthResponse_error - If the request fails, this error is returned.

$sel:resourceConfig:GetBackendAuthResponse', getBackendAuthResponse_resourceConfig - The resource configuration for authorization requests to the backend of your Amplify project.

GetBackendAuth, getBackendAuthResponse_resourceName - The name of this resource.

$sel:httpStatus:GetBackendAuthResponse', getBackendAuthResponse_httpStatus - The response's http status code.

Response Lenses

getBackendAuthResponse_appId :: Lens' GetBackendAuthResponse (Maybe Text) Source #

The app ID.

getBackendAuthResponse_backendEnvironmentName :: Lens' GetBackendAuthResponse (Maybe Text) Source #

The name of the backend environment.

getBackendAuthResponse_error :: Lens' GetBackendAuthResponse (Maybe Text) Source #

If the request fails, this error is returned.

getBackendAuthResponse_resourceConfig :: Lens' GetBackendAuthResponse (Maybe CreateBackendAuthResourceConfig) Source #

The resource configuration for authorization requests to the backend of your Amplify project.

getBackendAuthResponse_resourceName :: Lens' GetBackendAuthResponse (Maybe Text) Source #

The name of this resource.

getBackendAuthResponse_httpStatus :: Lens' GetBackendAuthResponse Int Source #

The response's http status code.