Amazonka.AmplifyBackend.CreateBackendAPI

Creates a new backend API resource.

Creating a Request

data CreateBackendAPI

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

ToJSON CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

toJSON :: CreateBackendAPI -> Value

toEncoding :: CreateBackendAPI -> Encoding

toJSONList :: [CreateBackendAPI] -> Value

toEncodingList :: [CreateBackendAPI] -> Encoding

ToHeaders CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

toHeaders :: CreateBackendAPI -> [Header]

ToPath CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

toPath :: CreateBackendAPI -> ByteString

ToQuery CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

toQuery :: CreateBackendAPI -> QueryString

AWSRequest CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Associated Types

type AWSResponse CreateBackendAPI

Methods

request :: (Service -> Service) -> CreateBackendAPI -> Request CreateBackendAPI

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBackendAPI -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBackendAPI)))

Generic CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Associated Types

type Rep CreateBackendAPI :: Type -> Type

Methods

from :: CreateBackendAPI -> Rep CreateBackendAPI x

to :: Rep CreateBackendAPI x -> CreateBackendAPI

Read CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

readsPrec :: Int -> ReadS CreateBackendAPI

readList :: ReadS [CreateBackendAPI]

readPrec :: ReadPrec CreateBackendAPI

readListPrec :: ReadPrec [CreateBackendAPI]

Show CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

showsPrec :: Int -> CreateBackendAPI -> ShowS

show :: CreateBackendAPI -> String

showList :: [CreateBackendAPI] -> ShowS

NFData CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

rnf :: CreateBackendAPI -> ()

Eq CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

(==) :: CreateBackendAPI -> CreateBackendAPI -> Bool

(/=) :: CreateBackendAPI -> CreateBackendAPI -> Bool

Hashable CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

hashWithSalt :: Int -> CreateBackendAPI -> Int

hash :: CreateBackendAPI -> Int

type AWSResponse CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

type AWSResponse CreateBackendAPI = CreateBackendAPIResponse

type Rep CreateBackendAPI

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

type Rep CreateBackendAPI = D1 ('MetaData "CreateBackendAPI" "Amazonka.AmplifyBackend.CreateBackendAPI" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" '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))))

newCreateBackendAPI

Arguments

:: Text

CreateBackendAPI

-> Text

$sel:resourceName:CreateBackendAPI'

-> Text

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:

CreateBackendAPI, createBackendAPI_appId - The app ID.

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

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

The app ID.

createBackendAPI_resourceName :: Lens' CreateBackendAPI Text

The name of this resource.

createBackendAPI_backendEnvironmentName :: Lens' CreateBackendAPI Text

The name of the backend environment.

createBackendAPI_resourceConfig :: Lens' CreateBackendAPI BackendAPIResourceConfig

The resource configuration for this request.

Destructuring the Response

data CreateBackendAPIResponse

See: newCreateBackendAPIResponse smart constructor.

Constructors

CreateBackendAPIResponse'

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

Generic CreateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Associated Types

type Rep CreateBackendAPIResponse :: Type -> Type

Methods

from :: CreateBackendAPIResponse -> Rep CreateBackendAPIResponse x

to :: Rep CreateBackendAPIResponse x -> CreateBackendAPIResponse

Read CreateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

readsPrec :: Int -> ReadS CreateBackendAPIResponse

readList :: ReadS [CreateBackendAPIResponse]

readPrec :: ReadPrec CreateBackendAPIResponse

readListPrec :: ReadPrec [CreateBackendAPIResponse]

Show CreateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

showsPrec :: Int -> CreateBackendAPIResponse -> ShowS

show :: CreateBackendAPIResponse -> String

showList :: [CreateBackendAPIResponse] -> ShowS

NFData CreateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

rnf :: CreateBackendAPIResponse -> ()

Eq CreateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

Methods

(==) :: CreateBackendAPIResponse -> CreateBackendAPIResponse -> Bool

(/=) :: CreateBackendAPIResponse -> CreateBackendAPIResponse -> Bool

type Rep CreateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.CreateBackendAPI

type Rep CreateBackendAPIResponse = D1 ('MetaData "CreateBackendAPIResponse" "Amazonka.AmplifyBackend.CreateBackendAPI" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "CreateBackendAPIResponse'" '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)))))

newCreateBackendAPIResponse

Arguments

:: Int

$sel:httpStatus:CreateBackendAPIResponse'

-> CreateBackendAPIResponse

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

CreateBackendAPI, createBackendAPIResponse_appId - The app ID.

CreateBackendAPI, createBackendAPIResponse_backendEnvironmentName - The name of the backend environment.

CreateBackendAPIResponse, createBackendAPIResponse_error - If the request fails, this error is returned.

CreateBackendAPIResponse, createBackendAPIResponse_jobId - The ID for the job.

CreateBackendAPIResponse, createBackendAPIResponse_operation - The name of the operation.

CreateBackendAPIResponse, createBackendAPIResponse_status - The current status of the request.

$sel:httpStatus:CreateBackendAPIResponse', createBackendAPIResponse_httpStatus - The response's http status code.

Response Lenses

createBackendAPIResponse_appId :: Lens' CreateBackendAPIResponse (Maybe Text)

The app ID.

createBackendAPIResponse_backendEnvironmentName :: Lens' CreateBackendAPIResponse (Maybe Text)

The name of the backend environment.

createBackendAPIResponse_error :: Lens' CreateBackendAPIResponse (Maybe Text)

If the request fails, this error is returned.

createBackendAPIResponse_jobId :: Lens' CreateBackendAPIResponse (Maybe Text)

The ID for the job.

createBackendAPIResponse_operation :: Lens' CreateBackendAPIResponse (Maybe Text)

The name of the operation.

createBackendAPIResponse_status :: Lens' CreateBackendAPIResponse (Maybe Text)

The current status of the request.

createBackendAPIResponse_httpStatus :: Lens' CreateBackendAPIResponse Int

The response's http status code.