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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new backend authentication resource.

Synopsis

data CreateBackendAuth = CreateBackendAuth' {
- appId :: Text
- resourceName :: Text
- backendEnvironmentName :: Text
- resourceConfig :: CreateBackendAuthResourceConfig
}
newCreateBackendAuth :: Text -> Text -> Text -> CreateBackendAuthResourceConfig -> CreateBackendAuth
createBackendAuth_appId :: Lens' CreateBackendAuth Text
createBackendAuth_resourceName :: Lens' CreateBackendAuth Text
createBackendAuth_backendEnvironmentName :: Lens' CreateBackendAuth Text
createBackendAuth_resourceConfig :: Lens' CreateBackendAuth CreateBackendAuthResourceConfig
data CreateBackendAuthResponse = CreateBackendAuthResponse' {
- appId :: Maybe Text
- backendEnvironmentName :: Maybe Text
- error :: Maybe Text
- jobId :: Maybe Text
- operation :: Maybe Text
- status :: Maybe Text
- httpStatus :: Int
}
newCreateBackendAuthResponse :: Int -> CreateBackendAuthResponse
createBackendAuthResponse_appId :: Lens' CreateBackendAuthResponse (Maybe Text)
createBackendAuthResponse_backendEnvironmentName :: Lens' CreateBackendAuthResponse (Maybe Text)
createBackendAuthResponse_error :: Lens' CreateBackendAuthResponse (Maybe Text)
createBackendAuthResponse_jobId :: Lens' CreateBackendAuthResponse (Maybe Text)
createBackendAuthResponse_operation :: Lens' CreateBackendAuthResponse (Maybe Text)
createBackendAuthResponse_status :: Lens' CreateBackendAuthResponse (Maybe Text)
createBackendAuthResponse_httpStatus :: Lens' CreateBackendAuthResponse Int

Creating a Request

data CreateBackendAuth Source #

The request body for CreateBackendAuth.

See: newCreateBackendAuth smart constructor.

Constructors

CreateBackendAuth'
Fields appId :: Text The app ID. resourceName :: Text The name of this resource. backendEnvironmentName :: Text The name of the backend environment. resourceConfig :: CreateBackendAuthResourceConfig The resource configuration for this request object.

Instances

Instances details

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

newCreateBackendAuth Source #

Arguments

:: Text	`CreateBackendAuth`
-> Text	`$sel:resourceName:CreateBackendAuth'`
-> Text	`CreateBackendAuth`
-> CreateBackendAuthResourceConfig	`$sel:resourceConfig:CreateBackendAuth'`
-> CreateBackendAuth

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

CreateBackendAuth, createBackendAuth_appId - The app ID.

$sel:resourceName:CreateBackendAuth', createBackendAuth_resourceName - The name of this resource.

CreateBackendAuth, createBackendAuth_backendEnvironmentName - The name of the backend environment.

$sel:resourceConfig:CreateBackendAuth', createBackendAuth_resourceConfig - The resource configuration for this request object.

Request Lenses

createBackendAuth_appId :: Lens' CreateBackendAuth Text Source #

The app ID.

createBackendAuth_resourceName :: Lens' CreateBackendAuth Text Source #

The name of this resource.

createBackendAuth_backendEnvironmentName :: Lens' CreateBackendAuth Text Source #

The name of the backend environment.

createBackendAuth_resourceConfig :: Lens' CreateBackendAuth CreateBackendAuthResourceConfig Source #

The resource configuration for this request object.

Destructuring the Response

data CreateBackendAuthResponse Source #

See: newCreateBackendAuthResponse smart constructor.

Constructors

CreateBackendAuthResponse'
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. jobId :: Maybe Text The ID for the job. operation :: Maybe Text The name of the operation. status :: Maybe Text The current status of the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateBackendAuthResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAuth Associated Types type Rep CreateBackendAuthResponse :: Type -> Type # Methods from :: CreateBackendAuthResponse -> Rep CreateBackendAuthResponse x # to :: Rep CreateBackendAuthResponse x -> CreateBackendAuthResponse #
Read CreateBackendAuthResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAuth Methods readsPrec :: Int -> ReadS CreateBackendAuthResponse # readList :: ReadS [CreateBackendAuthResponse] # readPrec :: ReadPrec CreateBackendAuthResponse # readListPrec :: ReadPrec [CreateBackendAuthResponse] #
Show CreateBackendAuthResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAuth Methods showsPrec :: Int -> CreateBackendAuthResponse -> ShowS # show :: CreateBackendAuthResponse -> String # showList :: [CreateBackendAuthResponse] -> ShowS #
NFData CreateBackendAuthResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAuth Methods rnf :: CreateBackendAuthResponse -> () #
Eq CreateBackendAuthResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAuth Methods (==) :: CreateBackendAuthResponse -> CreateBackendAuthResponse -> Bool # (/=) :: CreateBackendAuthResponse -> CreateBackendAuthResponse -> Bool #
type Rep CreateBackendAuthResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAuth type Rep CreateBackendAuthResponse = D1 ('MetaData "CreateBackendAuthResponse" "Amazonka.AmplifyBackend.CreateBackendAuth" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "CreateBackendAuthResponse'" '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 "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateBackendAuthResponse Source #

Arguments

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

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

CreateBackendAuth, createBackendAuthResponse_appId - The app ID.

CreateBackendAuth, createBackendAuthResponse_backendEnvironmentName - The name of the backend environment.

CreateBackendAuthResponse, createBackendAuthResponse_error - If the request fails, this error is returned.

CreateBackendAuthResponse, createBackendAuthResponse_jobId - The ID for the job.

CreateBackendAuthResponse, createBackendAuthResponse_operation - The name of the operation.

CreateBackendAuthResponse, createBackendAuthResponse_status - The current status of the request.

$sel:httpStatus:CreateBackendAuthResponse', createBackendAuthResponse_httpStatus - The response's http status code.

Response Lenses

createBackendAuthResponse_appId :: Lens' CreateBackendAuthResponse (Maybe Text) Source #

The app ID.

createBackendAuthResponse_backendEnvironmentName :: Lens' CreateBackendAuthResponse (Maybe Text) Source #

The name of the backend environment.

createBackendAuthResponse_error :: Lens' CreateBackendAuthResponse (Maybe Text) Source #

If the request fails, this error is returned.

createBackendAuthResponse_jobId :: Lens' CreateBackendAuthResponse (Maybe Text) Source #

The ID for the job.

createBackendAuthResponse_operation :: Lens' CreateBackendAuthResponse (Maybe Text) Source #

The name of the operation.

createBackendAuthResponse_status :: Lens' CreateBackendAuthResponse (Maybe Text) Source #

The current status of the request.

createBackendAuthResponse_httpStatus :: Lens' CreateBackendAuthResponse Int Source #

The response's http status code.