Amazonka.AmplifyBackend.DeleteBackendAPI

Deletes an existing backend API resource.

Creating a Request

data DeleteBackendAPI

The request body for DeleteBackendAPI.

See: newDeleteBackendAPI smart constructor.

Constructors

DeleteBackendAPI'

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 DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

toJSON :: DeleteBackendAPI -> Value

toEncoding :: DeleteBackendAPI -> Encoding

toJSONList :: [DeleteBackendAPI] -> Value

toEncodingList :: [DeleteBackendAPI] -> Encoding

ToHeaders DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

toHeaders :: DeleteBackendAPI -> [Header]

ToPath DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

toPath :: DeleteBackendAPI -> ByteString

ToQuery DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

toQuery :: DeleteBackendAPI -> QueryString

AWSRequest DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Associated Types

type AWSResponse DeleteBackendAPI

Methods

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

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

Generic DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Associated Types

type Rep DeleteBackendAPI :: Type -> Type

Methods

from :: DeleteBackendAPI -> Rep DeleteBackendAPI x

to :: Rep DeleteBackendAPI x -> DeleteBackendAPI

Read DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

readsPrec :: Int -> ReadS DeleteBackendAPI

readList :: ReadS [DeleteBackendAPI]

readPrec :: ReadPrec DeleteBackendAPI

readListPrec :: ReadPrec [DeleteBackendAPI]

Show DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

showsPrec :: Int -> DeleteBackendAPI -> ShowS

show :: DeleteBackendAPI -> String

showList :: [DeleteBackendAPI] -> ShowS

NFData DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

rnf :: DeleteBackendAPI -> ()

Eq DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

(==) :: DeleteBackendAPI -> DeleteBackendAPI -> Bool

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

Hashable DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

hashWithSalt :: Int -> DeleteBackendAPI -> Int

hash :: DeleteBackendAPI -> Int

type AWSResponse DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

type AWSResponse DeleteBackendAPI = DeleteBackendAPIResponse

type Rep DeleteBackendAPI

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

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

newDeleteBackendAPI

Arguments

:: Text

DeleteBackendAPI

-> Text

DeleteBackendAPI

-> Text

$sel:resourceName:DeleteBackendAPI'

-> DeleteBackendAPI

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

DeleteBackendAPI, deleteBackendAPI_appId - The app ID.

DeleteBackendAPI, deleteBackendAPI_backendEnvironmentName - The name of the backend environment.

$sel:resourceName:DeleteBackendAPI', deleteBackendAPI_resourceName - The name of this resource.

Request Lenses

deleteBackendAPI_resourceConfig :: Lens' DeleteBackendAPI (Maybe BackendAPIResourceConfig)

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

deleteBackendAPI_appId :: Lens' DeleteBackendAPI Text

The app ID.

deleteBackendAPI_backendEnvironmentName :: Lens' DeleteBackendAPI Text

The name of the backend environment.

deleteBackendAPI_resourceName :: Lens' DeleteBackendAPI Text

The name of this resource.

Destructuring the Response

data DeleteBackendAPIResponse

See: newDeleteBackendAPIResponse smart constructor.

Constructors

DeleteBackendAPIResponse'

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 DeleteBackendAPIResponse

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Associated Types

type Rep DeleteBackendAPIResponse :: Type -> Type

Methods

from :: DeleteBackendAPIResponse -> Rep DeleteBackendAPIResponse x

to :: Rep DeleteBackendAPIResponse x -> DeleteBackendAPIResponse

Read DeleteBackendAPIResponse

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

readsPrec :: Int -> ReadS DeleteBackendAPIResponse

readList :: ReadS [DeleteBackendAPIResponse]

readPrec :: ReadPrec DeleteBackendAPIResponse

readListPrec :: ReadPrec [DeleteBackendAPIResponse]

Show DeleteBackendAPIResponse

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

showsPrec :: Int -> DeleteBackendAPIResponse -> ShowS

show :: DeleteBackendAPIResponse -> String

showList :: [DeleteBackendAPIResponse] -> ShowS

NFData DeleteBackendAPIResponse

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

rnf :: DeleteBackendAPIResponse -> ()

Eq DeleteBackendAPIResponse

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

Methods

(==) :: DeleteBackendAPIResponse -> DeleteBackendAPIResponse -> Bool

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

type Rep DeleteBackendAPIResponse

Defined in Amazonka.AmplifyBackend.DeleteBackendAPI

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

newDeleteBackendAPIResponse

Arguments

:: Int

$sel:httpStatus:DeleteBackendAPIResponse'

-> DeleteBackendAPIResponse

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

DeleteBackendAPI, deleteBackendAPIResponse_appId - The app ID.

DeleteBackendAPI, deleteBackendAPIResponse_backendEnvironmentName - The name of the backend environment.

DeleteBackendAPIResponse, deleteBackendAPIResponse_error - If the request fails, this error is returned.

DeleteBackendAPIResponse, deleteBackendAPIResponse_jobId - The ID for the job.

DeleteBackendAPIResponse, deleteBackendAPIResponse_operation - The name of the operation.

DeleteBackendAPIResponse, deleteBackendAPIResponse_status - The current status of the request.

$sel:httpStatus:DeleteBackendAPIResponse', deleteBackendAPIResponse_httpStatus - The response's http status code.

Response Lenses

deleteBackendAPIResponse_appId :: Lens' DeleteBackendAPIResponse (Maybe Text)

The app ID.

deleteBackendAPIResponse_backendEnvironmentName :: Lens' DeleteBackendAPIResponse (Maybe Text)

The name of the backend environment.

deleteBackendAPIResponse_error :: Lens' DeleteBackendAPIResponse (Maybe Text)

If the request fails, this error is returned.

deleteBackendAPIResponse_jobId :: Lens' DeleteBackendAPIResponse (Maybe Text)

The ID for the job.

deleteBackendAPIResponse_operation :: Lens' DeleteBackendAPIResponse (Maybe Text)

The name of the operation.

deleteBackendAPIResponse_status :: Lens' DeleteBackendAPIResponse (Maybe Text)

The current status of the request.

deleteBackendAPIResponse_httpStatus :: Lens' DeleteBackendAPIResponse Int

The response's http status code.