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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an existing backend API resource.

Synopsis

data DeleteBackendAPI = DeleteBackendAPI' {
- resourceConfig :: Maybe BackendAPIResourceConfig
- appId :: Text
- backendEnvironmentName :: Text
- resourceName :: Text
}
newDeleteBackendAPI :: Text -> Text -> Text -> DeleteBackendAPI
deleteBackendAPI_resourceConfig :: Lens' DeleteBackendAPI (Maybe BackendAPIResourceConfig)
deleteBackendAPI_appId :: Lens' DeleteBackendAPI Text
deleteBackendAPI_backendEnvironmentName :: Lens' DeleteBackendAPI Text
deleteBackendAPI_resourceName :: Lens' DeleteBackendAPI Text
data DeleteBackendAPIResponse = DeleteBackendAPIResponse' {
- status :: Maybe Text
- jobId :: Maybe Text
- operation :: Maybe Text
- error :: Maybe Text
- appId :: Maybe Text
- backendEnvironmentName :: Maybe Text
- httpStatus :: Int
}
newDeleteBackendAPIResponse :: Int -> DeleteBackendAPIResponse
deleteBackendAPIResponse_status :: Lens' DeleteBackendAPIResponse (Maybe Text)
deleteBackendAPIResponse_jobId :: Lens' DeleteBackendAPIResponse (Maybe Text)
deleteBackendAPIResponse_operation :: Lens' DeleteBackendAPIResponse (Maybe Text)
deleteBackendAPIResponse_error :: Lens' DeleteBackendAPIResponse (Maybe Text)
deleteBackendAPIResponse_appId :: Lens' DeleteBackendAPIResponse (Maybe Text)
deleteBackendAPIResponse_backendEnvironmentName :: Lens' DeleteBackendAPIResponse (Maybe Text)
deleteBackendAPIResponse_httpStatus :: Lens' DeleteBackendAPIResponse Int

Creating a Request

data DeleteBackendAPI Source #

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

Instances details

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

newDeleteBackendAPI Source #

Arguments

:: Text	`$sel:appId:DeleteBackendAPI'`
-> Text	`$sel:backendEnvironmentName: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.

$sel:appId:DeleteBackendAPI', deleteBackendAPI_appId - The app ID.

$sel:backendEnvironmentName: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) Source #

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

deleteBackendAPI_appId :: Lens' DeleteBackendAPI Text Source #

The app ID.

deleteBackendAPI_backendEnvironmentName :: Lens' DeleteBackendAPI Text Source #

The name of the backend environment.

deleteBackendAPI_resourceName :: Lens' DeleteBackendAPI Text Source #

The name of this resource.

Destructuring the Response

data DeleteBackendAPIResponse Source #

See: newDeleteBackendAPIResponse smart constructor.

Constructors

DeleteBackendAPIResponse'
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 DeleteBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.DeleteBackendAPI Methods (==) :: DeleteBackendAPIResponse -> DeleteBackendAPIResponse -> Bool # (/=) :: DeleteBackendAPIResponse -> DeleteBackendAPIResponse -> Bool #
Read DeleteBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.DeleteBackendAPI Methods readsPrec :: Int -> ReadS DeleteBackendAPIResponse # readList :: ReadS [DeleteBackendAPIResponse] # readPrec :: ReadPrec DeleteBackendAPIResponse # readListPrec :: ReadPrec [DeleteBackendAPIResponse] #
Show DeleteBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.DeleteBackendAPI Methods showsPrec :: Int -> DeleteBackendAPIResponse -> ShowS # show :: DeleteBackendAPIResponse -> String # showList :: [DeleteBackendAPIResponse] -> ShowS #
Generic DeleteBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.DeleteBackendAPI Associated Types type Rep DeleteBackendAPIResponse :: Type -> Type # Methods from :: DeleteBackendAPIResponse -> Rep DeleteBackendAPIResponse x # to :: Rep DeleteBackendAPIResponse x -> DeleteBackendAPIResponse #
NFData DeleteBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.DeleteBackendAPI Methods rnf :: DeleteBackendAPIResponse -> () #
type Rep DeleteBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.DeleteBackendAPI type Rep DeleteBackendAPIResponse = D1 ('MetaData "DeleteBackendAPIResponse" "Amazonka.AmplifyBackend.DeleteBackendAPI" "libZSservicesZSamazonka-amplifybackendZSamazonka-amplifybackend" 'False) (C1 ('MetaCons "DeleteBackendAPIResponse'" '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)))))