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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new backend API resource.

Synopsis

data CreateBackendAPI = CreateBackendAPI' {
- appId :: Text
- resourceName :: Text
- backendEnvironmentName :: Text
- resourceConfig :: BackendAPIResourceConfig
}
newCreateBackendAPI :: Text -> Text -> Text -> BackendAPIResourceConfig -> CreateBackendAPI
createBackendAPI_appId :: Lens' CreateBackendAPI Text
createBackendAPI_resourceName :: Lens' CreateBackendAPI Text
createBackendAPI_backendEnvironmentName :: Lens' CreateBackendAPI Text
createBackendAPI_resourceConfig :: Lens' CreateBackendAPI BackendAPIResourceConfig
data CreateBackendAPIResponse = CreateBackendAPIResponse' {
- status :: Maybe Text
- jobId :: Maybe Text
- operation :: Maybe Text
- error :: Maybe Text
- appId :: Maybe Text
- backendEnvironmentName :: Maybe Text
- httpStatus :: Int
}
newCreateBackendAPIResponse :: Int -> CreateBackendAPIResponse
createBackendAPIResponse_status :: Lens' CreateBackendAPIResponse (Maybe Text)
createBackendAPIResponse_jobId :: Lens' CreateBackendAPIResponse (Maybe Text)
createBackendAPIResponse_operation :: Lens' CreateBackendAPIResponse (Maybe Text)
createBackendAPIResponse_error :: Lens' CreateBackendAPIResponse (Maybe Text)
createBackendAPIResponse_appId :: Lens' CreateBackendAPIResponse (Maybe Text)
createBackendAPIResponse_backendEnvironmentName :: Lens' CreateBackendAPIResponse (Maybe Text)
createBackendAPIResponse_httpStatus :: Lens' CreateBackendAPIResponse Int

Creating a Request

data CreateBackendAPI Source #

The request body for CreateBackendAPI.

See: newCreateBackendAPI smart constructor.

Constructors

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

Instances

Instances details

Eq CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods (==) :: CreateBackendAPI -> CreateBackendAPI -> Bool # (/=) :: CreateBackendAPI -> CreateBackendAPI -> Bool #
Read CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods readsPrec :: Int -> ReadS CreateBackendAPI # readList :: ReadS [CreateBackendAPI] # readPrec :: ReadPrec CreateBackendAPI # readListPrec :: ReadPrec [CreateBackendAPI] #
Show CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods showsPrec :: Int -> CreateBackendAPI -> ShowS # show :: CreateBackendAPI -> String # showList :: [CreateBackendAPI] -> ShowS #
Generic CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Associated Types type Rep CreateBackendAPI :: Type -> Type # Methods from :: CreateBackendAPI -> Rep CreateBackendAPI x # to :: Rep CreateBackendAPI x -> CreateBackendAPI #
NFData CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods rnf :: CreateBackendAPI -> () #
Hashable CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods hashWithSalt :: Int -> CreateBackendAPI -> Int # hash :: CreateBackendAPI -> Int #
ToJSON CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods toJSON :: CreateBackendAPI -> Value # toEncoding :: CreateBackendAPI -> Encoding # toJSONList :: [CreateBackendAPI] -> Value # toEncodingList :: [CreateBackendAPI] -> Encoding #
AWSRequest CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Associated Types type AWSResponse CreateBackendAPI # Methods request :: CreateBackendAPI -> Request CreateBackendAPI # response :: MonadResource m => Logger -> Service -> Proxy CreateBackendAPI -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBackendAPI))) #
ToHeaders CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods toHeaders :: CreateBackendAPI -> [Header] #
ToPath CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods toPath :: CreateBackendAPI -> ByteString #
ToQuery CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI Methods toQuery :: CreateBackendAPI -> QueryString #
type Rep CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI type Rep CreateBackendAPI = D1 ('MetaData "CreateBackendAPI" "Amazonka.AmplifyBackend.CreateBackendAPI" "libZSservicesZSamazonka-amplifybackendZSamazonka-amplifybackend" 'False) (C1 ('MetaCons "CreateBackendAPI'" '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 BackendAPIResourceConfig))))
type AWSResponse CreateBackendAPI Source #
Instance details Defined in Amazonka.AmplifyBackend.CreateBackendAPI type AWSResponse CreateBackendAPI = CreateBackendAPIResponse

newCreateBackendAPI Source #

Arguments

:: Text	`$sel:appId:CreateBackendAPI'`
-> Text	`$sel:resourceName:CreateBackendAPI'`
-> Text	`$sel:backendEnvironmentName:CreateBackendAPI'`
-> BackendAPIResourceConfig	`$sel:resourceConfig:CreateBackendAPI'`
-> CreateBackendAPI

Create a value of CreateBackendAPI 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:appId:CreateBackendAPI', createBackendAPI_appId - The app ID.

$sel:resourceName:CreateBackendAPI', createBackendAPI_resourceName - The name of this resource.

$sel:backendEnvironmentName:CreateBackendAPI', createBackendAPI_backendEnvironmentName - The name of the backend environment.

$sel:resourceConfig:CreateBackendAPI', createBackendAPI_resourceConfig - The resource configuration for this request.

Request Lenses

createBackendAPI_appId :: Lens' CreateBackendAPI Text Source #

The app ID.

createBackendAPI_resourceName :: Lens' CreateBackendAPI Text Source #

The name of this resource.

createBackendAPI_backendEnvironmentName :: Lens' CreateBackendAPI Text Source #

The name of the backend environment.

createBackendAPI_resourceConfig :: Lens' CreateBackendAPI BackendAPIResourceConfig Source #

The resource configuration for this request.

Destructuring the Response

data CreateBackendAPIResponse Source #

See: newCreateBackendAPIResponse smart constructor.

Constructors

CreateBackendAPIResponse'
Fields status :: Maybe Text The current status of the request. jobId :: Maybe Text The ID for the job. operation :: Maybe Text The name of the operation. error :: Maybe Text If the request fails, this error is returned. appId :: Maybe Text The app ID. backendEnvironmentName :: Maybe Text The name of the backend environment. httpStatus :: Int The response's http status code.

Instances

Instances details

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