Amazonka.AmplifyBackend.UpdateBackendAPI

Updates an existing backend API resource.

Creating a Request

data UpdateBackendAPI

The request body for UpdateBackendAPI.

See: newUpdateBackendAPI smart constructor.

Constructors

UpdateBackendAPI'

Fields

• resourceConfig :: Maybe BackendAPIResourceConfig

  Defines the resource configuration for the data model in your Amplify project.

• appId :: Text

  The app ID.

• backendEnvironmentName :: Text

  The name of the backend environment.

• resourceName :: Text

  The name of this resource.

Instances

ToJSON UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

toJSON :: UpdateBackendAPI -> Value

toEncoding :: UpdateBackendAPI -> Encoding

toJSONList :: [UpdateBackendAPI] -> Value

toEncodingList :: [UpdateBackendAPI] -> Encoding

ToHeaders UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

toHeaders :: UpdateBackendAPI -> [Header]

ToPath UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

toPath :: UpdateBackendAPI -> ByteString

ToQuery UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

toQuery :: UpdateBackendAPI -> QueryString

AWSRequest UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Associated Types

type AWSResponse UpdateBackendAPI

Methods

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

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

Generic UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Associated Types

type Rep UpdateBackendAPI :: Type -> Type

Methods

from :: UpdateBackendAPI -> Rep UpdateBackendAPI x

to :: Rep UpdateBackendAPI x -> UpdateBackendAPI

Read UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

readsPrec :: Int -> ReadS UpdateBackendAPI

readList :: ReadS [UpdateBackendAPI]

readPrec :: ReadPrec UpdateBackendAPI

readListPrec :: ReadPrec [UpdateBackendAPI]

Show UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

showsPrec :: Int -> UpdateBackendAPI -> ShowS

show :: UpdateBackendAPI -> String

showList :: [UpdateBackendAPI] -> ShowS

NFData UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

rnf :: UpdateBackendAPI -> ()

Eq UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

(==) :: UpdateBackendAPI -> UpdateBackendAPI -> Bool

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

Hashable UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

hashWithSalt :: Int -> UpdateBackendAPI -> Int

hash :: UpdateBackendAPI -> Int

type AWSResponse UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

type AWSResponse UpdateBackendAPI = UpdateBackendAPIResponse

type Rep UpdateBackendAPI

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

type Rep UpdateBackendAPI = D1 ('MetaData "UpdateBackendAPI" "Amazonka.AmplifyBackend.UpdateBackendAPI" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "UpdateBackendAPI'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackendAPIResourceConfig)) :*: 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))))

newUpdateBackendAPI

Arguments

:: Text

UpdateBackendAPI

-> Text

UpdateBackendAPI

-> Text

$sel:resourceName:UpdateBackendAPI'

-> UpdateBackendAPI

Create a value of UpdateBackendAPI 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:UpdateBackendAPI', updateBackendAPI_resourceConfig - Defines the resource configuration for the data model in your Amplify project.

UpdateBackendAPI, updateBackendAPI_appId - The app ID.

UpdateBackendAPI, updateBackendAPI_backendEnvironmentName - The name of the backend environment.

$sel:resourceName:UpdateBackendAPI', updateBackendAPI_resourceName - The name of this resource.

Request Lenses

updateBackendAPI_resourceConfig :: Lens' UpdateBackendAPI (Maybe BackendAPIResourceConfig)

Defines the resource configuration for the data model in your Amplify project.

updateBackendAPI_appId :: Lens' UpdateBackendAPI Text

The app ID.

updateBackendAPI_backendEnvironmentName :: Lens' UpdateBackendAPI Text

The name of the backend environment.

updateBackendAPI_resourceName :: Lens' UpdateBackendAPI Text

The name of this resource.

Destructuring the Response

data UpdateBackendAPIResponse

See: newUpdateBackendAPIResponse smart constructor.

Constructors

UpdateBackendAPIResponse'

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 UpdateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Associated Types

type Rep UpdateBackendAPIResponse :: Type -> Type

Methods

from :: UpdateBackendAPIResponse -> Rep UpdateBackendAPIResponse x

to :: Rep UpdateBackendAPIResponse x -> UpdateBackendAPIResponse

Read UpdateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

readsPrec :: Int -> ReadS UpdateBackendAPIResponse

readList :: ReadS [UpdateBackendAPIResponse]

readPrec :: ReadPrec UpdateBackendAPIResponse

readListPrec :: ReadPrec [UpdateBackendAPIResponse]

Show UpdateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

showsPrec :: Int -> UpdateBackendAPIResponse -> ShowS

show :: UpdateBackendAPIResponse -> String

showList :: [UpdateBackendAPIResponse] -> ShowS

NFData UpdateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

rnf :: UpdateBackendAPIResponse -> ()

Eq UpdateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

Methods

(==) :: UpdateBackendAPIResponse -> UpdateBackendAPIResponse -> Bool

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

type Rep UpdateBackendAPIResponse

Defined in Amazonka.AmplifyBackend.UpdateBackendAPI

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

newUpdateBackendAPIResponse

Arguments

:: Int

$sel:httpStatus:UpdateBackendAPIResponse'

-> UpdateBackendAPIResponse

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

UpdateBackendAPI, updateBackendAPIResponse_appId - The app ID.

UpdateBackendAPI, updateBackendAPIResponse_backendEnvironmentName - The name of the backend environment.

UpdateBackendAPIResponse, updateBackendAPIResponse_error - If the request fails, this error is returned.

UpdateBackendAPIResponse, updateBackendAPIResponse_jobId - The ID for the job.

UpdateBackendAPIResponse, updateBackendAPIResponse_operation - The name of the operation.

UpdateBackendAPIResponse, updateBackendAPIResponse_status - The current status of the request.

$sel:httpStatus:UpdateBackendAPIResponse', updateBackendAPIResponse_httpStatus - The response's http status code.

Response Lenses

updateBackendAPIResponse_appId :: Lens' UpdateBackendAPIResponse (Maybe Text)

The app ID.

updateBackendAPIResponse_backendEnvironmentName :: Lens' UpdateBackendAPIResponse (Maybe Text)

The name of the backend environment.

updateBackendAPIResponse_error :: Lens' UpdateBackendAPIResponse (Maybe Text)

If the request fails, this error is returned.

updateBackendAPIResponse_jobId :: Lens' UpdateBackendAPIResponse (Maybe Text)

The ID for the job.

updateBackendAPIResponse_operation :: Lens' UpdateBackendAPIResponse (Maybe Text)

The name of the operation.

updateBackendAPIResponse_status :: Lens' UpdateBackendAPIResponse (Maybe Text)

The current status of the request.

updateBackendAPIResponse_httpStatus :: Lens' UpdateBackendAPIResponse Int

The response's http status code.