Amazonka.AmplifyBackend.GenerateBackendAPIModels

Generates a model schema for an existing backend API resource.

Creating a Request

data GenerateBackendAPIModels

The request body for GenerateBackendAPIModels.

See: newGenerateBackendAPIModels smart constructor.

Constructors

GenerateBackendAPIModels'

Fields

• appId :: Text

  The app ID.

• backendEnvironmentName :: Text

  The name of the backend environment.

• resourceName :: Text

  The name of this resource.

Instances

ToJSON GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

toJSON :: GenerateBackendAPIModels -> Value

toEncoding :: GenerateBackendAPIModels -> Encoding

toJSONList :: [GenerateBackendAPIModels] -> Value

toEncodingList :: [GenerateBackendAPIModels] -> Encoding

ToHeaders GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

toHeaders :: GenerateBackendAPIModels -> [Header]

ToPath GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

toPath :: GenerateBackendAPIModels -> ByteString

ToQuery GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

toQuery :: GenerateBackendAPIModels -> QueryString

AWSRequest GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Associated Types

type AWSResponse GenerateBackendAPIModels

Methods

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

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

Generic GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Associated Types

type Rep GenerateBackendAPIModels :: Type -> Type

Methods

from :: GenerateBackendAPIModels -> Rep GenerateBackendAPIModels x

to :: Rep GenerateBackendAPIModels x -> GenerateBackendAPIModels

Read GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

readsPrec :: Int -> ReadS GenerateBackendAPIModels

readList :: ReadS [GenerateBackendAPIModels]

readPrec :: ReadPrec GenerateBackendAPIModels

readListPrec :: ReadPrec [GenerateBackendAPIModels]

Show GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

showsPrec :: Int -> GenerateBackendAPIModels -> ShowS

show :: GenerateBackendAPIModels -> String

showList :: [GenerateBackendAPIModels] -> ShowS

NFData GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

rnf :: GenerateBackendAPIModels -> ()

Eq GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

(==) :: GenerateBackendAPIModels -> GenerateBackendAPIModels -> Bool

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

Hashable GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

hashWithSalt :: Int -> GenerateBackendAPIModels -> Int

hash :: GenerateBackendAPIModels -> Int

type AWSResponse GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

type AWSResponse GenerateBackendAPIModels = GenerateBackendAPIModelsResponse

type Rep GenerateBackendAPIModels

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

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

newGenerateBackendAPIModels

Arguments

:: Text

GenerateBackendAPIModels

-> Text

GenerateBackendAPIModels

-> Text

$sel:resourceName:GenerateBackendAPIModels'

-> GenerateBackendAPIModels

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

GenerateBackendAPIModels, generateBackendAPIModels_appId - The app ID.

GenerateBackendAPIModels, generateBackendAPIModels_backendEnvironmentName - The name of the backend environment.

$sel:resourceName:GenerateBackendAPIModels', generateBackendAPIModels_resourceName - The name of this resource.

Request Lenses

generateBackendAPIModels_appId :: Lens' GenerateBackendAPIModels Text

The app ID.

generateBackendAPIModels_backendEnvironmentName :: Lens' GenerateBackendAPIModels Text

The name of the backend environment.

generateBackendAPIModels_resourceName :: Lens' GenerateBackendAPIModels Text

The name of this resource.

Destructuring the Response

data GenerateBackendAPIModelsResponse

See: newGenerateBackendAPIModelsResponse smart constructor.

Constructors

GenerateBackendAPIModelsResponse'

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 GenerateBackendAPIModelsResponse

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Associated Types

type Rep GenerateBackendAPIModelsResponse :: Type -> Type

Methods

from :: GenerateBackendAPIModelsResponse -> Rep GenerateBackendAPIModelsResponse x

to :: Rep GenerateBackendAPIModelsResponse x -> GenerateBackendAPIModelsResponse

Read GenerateBackendAPIModelsResponse

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

readsPrec :: Int -> ReadS GenerateBackendAPIModelsResponse

readList :: ReadS [GenerateBackendAPIModelsResponse]

readPrec :: ReadPrec GenerateBackendAPIModelsResponse

readListPrec :: ReadPrec [GenerateBackendAPIModelsResponse]

Show GenerateBackendAPIModelsResponse

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

showsPrec :: Int -> GenerateBackendAPIModelsResponse -> ShowS

show :: GenerateBackendAPIModelsResponse -> String

showList :: [GenerateBackendAPIModelsResponse] -> ShowS

NFData GenerateBackendAPIModelsResponse

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

rnf :: GenerateBackendAPIModelsResponse -> ()

Eq GenerateBackendAPIModelsResponse

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

Methods

(==) :: GenerateBackendAPIModelsResponse -> GenerateBackendAPIModelsResponse -> Bool

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

type Rep GenerateBackendAPIModelsResponse

Defined in Amazonka.AmplifyBackend.GenerateBackendAPIModels

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

newGenerateBackendAPIModelsResponse

Arguments

:: Int

$sel:httpStatus:GenerateBackendAPIModelsResponse'

-> GenerateBackendAPIModelsResponse

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

GenerateBackendAPIModels, generateBackendAPIModelsResponse_appId - The app ID.

GenerateBackendAPIModels, generateBackendAPIModelsResponse_backendEnvironmentName - The name of the backend environment.

GenerateBackendAPIModelsResponse, generateBackendAPIModelsResponse_error - If the request fails, this error is returned.

GenerateBackendAPIModelsResponse, generateBackendAPIModelsResponse_jobId - The ID for the job.

GenerateBackendAPIModelsResponse, generateBackendAPIModelsResponse_operation - The name of the operation.

GenerateBackendAPIModelsResponse, generateBackendAPIModelsResponse_status - The current status of the request.

$sel:httpStatus:GenerateBackendAPIModelsResponse', generateBackendAPIModelsResponse_httpStatus - The response's http status code.

Response Lenses

generateBackendAPIModelsResponse_appId :: Lens' GenerateBackendAPIModelsResponse (Maybe Text)

The app ID.

generateBackendAPIModelsResponse_backendEnvironmentName :: Lens' GenerateBackendAPIModelsResponse (Maybe Text)

The name of the backend environment.

generateBackendAPIModelsResponse_error :: Lens' GenerateBackendAPIModelsResponse (Maybe Text)

If the request fails, this error is returned.

generateBackendAPIModelsResponse_jobId :: Lens' GenerateBackendAPIModelsResponse (Maybe Text)

The ID for the job.

generateBackendAPIModelsResponse_operation :: Lens' GenerateBackendAPIModelsResponse (Maybe Text)

The name of the operation.

generateBackendAPIModelsResponse_status :: Lens' GenerateBackendAPIModelsResponse (Maybe Text)

The current status of the request.

generateBackendAPIModelsResponse_httpStatus :: Lens' GenerateBackendAPIModelsResponse Int

The response's http status code.