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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

Synopsis

data CreateBackend = CreateBackend' {
- resourceConfig :: Maybe ResourceConfig
- resourceName :: Maybe Text
- appId :: Text
- backendEnvironmentName :: Text
- appName :: Text
}
newCreateBackend :: Text -> Text -> Text -> CreateBackend
createBackend_resourceConfig :: Lens' CreateBackend (Maybe ResourceConfig)
createBackend_resourceName :: Lens' CreateBackend (Maybe Text)
createBackend_appId :: Lens' CreateBackend Text
createBackend_backendEnvironmentName :: Lens' CreateBackend Text
createBackend_appName :: Lens' CreateBackend Text
data CreateBackendResponse = CreateBackendResponse' {
- appId :: Maybe Text
- backendEnvironmentName :: Maybe Text
- error :: Maybe Text
- jobId :: Maybe Text
- operation :: Maybe Text
- status :: Maybe Text
- httpStatus :: Int
}
newCreateBackendResponse :: Int -> CreateBackendResponse
createBackendResponse_appId :: Lens' CreateBackendResponse (Maybe Text)
createBackendResponse_backendEnvironmentName :: Lens' CreateBackendResponse (Maybe Text)
createBackendResponse_error :: Lens' CreateBackendResponse (Maybe Text)
createBackendResponse_jobId :: Lens' CreateBackendResponse (Maybe Text)
createBackendResponse_operation :: Lens' CreateBackendResponse (Maybe Text)
createBackendResponse_status :: Lens' CreateBackendResponse (Maybe Text)
createBackendResponse_httpStatus :: Lens' CreateBackendResponse Int

Creating a Request

data CreateBackend Source #

The request body for CreateBackend.

See: newCreateBackend smart constructor.

Constructors

CreateBackend'
Fields resourceConfig :: Maybe ResourceConfig The resource configuration for creating a backend. resourceName :: Maybe Text The name of the resource. appId :: Text The app ID. backendEnvironmentName :: Text The name of the backend environment. appName :: Text The name of the app.

Instances

Instances details

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

newCreateBackend Source #

Arguments

:: Text	`CreateBackend`
-> Text	`CreateBackend`
-> Text	`$sel:appName:CreateBackend'`
-> CreateBackend

Create a value of CreateBackend 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:resourceConfig:CreateBackend', createBackend_resourceConfig - The resource configuration for creating a backend.

$sel:resourceName:CreateBackend', createBackend_resourceName - The name of the resource.

CreateBackend, createBackend_appId - The app ID.

CreateBackend, createBackend_backendEnvironmentName - The name of the backend environment.

$sel:appName:CreateBackend', createBackend_appName - The name of the app.

Request Lenses

createBackend_resourceConfig :: Lens' CreateBackend (Maybe ResourceConfig) Source #

The resource configuration for creating a backend.

createBackend_resourceName :: Lens' CreateBackend (Maybe Text) Source #

The name of the resource.

createBackend_appId :: Lens' CreateBackend Text Source #

The app ID.

createBackend_backendEnvironmentName :: Lens' CreateBackend Text Source #

The name of the backend environment.

createBackend_appName :: Lens' CreateBackend Text Source #

The name of the app.

Destructuring the Response

data CreateBackendResponse Source #

See: newCreateBackendResponse smart constructor.

Constructors

CreateBackendResponse'
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 CreateBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackend Associated Types type Rep CreateBackendResponse :: Type -> Type # Methods from :: CreateBackendResponse -> Rep CreateBackendResponse x # to :: Rep CreateBackendResponse x -> CreateBackendResponse #
Read CreateBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackend Methods readsPrec :: Int -> ReadS CreateBackendResponse # readList :: ReadS [CreateBackendResponse] # readPrec :: ReadPrec CreateBackendResponse # readListPrec :: ReadPrec [CreateBackendResponse] #
Show CreateBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackend Methods showsPrec :: Int -> CreateBackendResponse -> ShowS # show :: CreateBackendResponse -> String # showList :: [CreateBackendResponse] -> ShowS #
NFData CreateBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackend Methods rnf :: CreateBackendResponse -> () #
Eq CreateBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackend Methods (==) :: CreateBackendResponse -> CreateBackendResponse -> Bool # (/=) :: CreateBackendResponse -> CreateBackendResponse -> Bool #
type Rep CreateBackendResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackend type Rep CreateBackendResponse = D1 ('MetaData "CreateBackendResponse" "Amazonka.AmplifyBackend.CreateBackend" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "CreateBackendResponse'" '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)))))

newCreateBackendResponse Source #

Arguments

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

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

CreateBackend, createBackendResponse_appId - The app ID.

CreateBackend, createBackendResponse_backendEnvironmentName - The name of the backend environment.

CreateBackendResponse, createBackendResponse_error - If the request fails, this error is returned.

CreateBackendResponse, createBackendResponse_jobId - The ID for the job.

CreateBackendResponse, createBackendResponse_operation - The name of the operation.

CreateBackendResponse, createBackendResponse_status - The current status of the request.

$sel:httpStatus:CreateBackendResponse', createBackendResponse_httpStatus - The response's http status code.

Response Lenses

createBackendResponse_appId :: Lens' CreateBackendResponse (Maybe Text) Source #

The app ID.

createBackendResponse_backendEnvironmentName :: Lens' CreateBackendResponse (Maybe Text) Source #

The name of the backend environment.

createBackendResponse_error :: Lens' CreateBackendResponse (Maybe Text) Source #

If the request fails, this error is returned.

createBackendResponse_jobId :: Lens' CreateBackendResponse (Maybe Text) Source #

The ID for the job.

createBackendResponse_operation :: Lens' CreateBackendResponse (Maybe Text) Source #

The name of the operation.

createBackendResponse_status :: Lens' CreateBackendResponse (Maybe Text) Source #

The current status of the request.

createBackendResponse_httpStatus :: Lens' CreateBackendResponse Int Source #

The response's http status code.