Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AmplifyBackend.GetBackendAPI

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the details for a backend API.

Synopsis

data GetBackendAPI = GetBackendAPI' {
- resourceConfig :: Maybe BackendAPIResourceConfig
- appId :: Text
- backendEnvironmentName :: Text
- resourceName :: Text
}
newGetBackendAPI :: Text -> Text -> Text -> GetBackendAPI
getBackendAPI_resourceConfig :: Lens' GetBackendAPI (Maybe BackendAPIResourceConfig)
getBackendAPI_appId :: Lens' GetBackendAPI Text
getBackendAPI_backendEnvironmentName :: Lens' GetBackendAPI Text
getBackendAPI_resourceName :: Lens' GetBackendAPI Text
data GetBackendAPIResponse = GetBackendAPIResponse' {
- appId :: Maybe Text
- backendEnvironmentName :: Maybe Text
- error :: Maybe Text
- resourceConfig :: Maybe BackendAPIResourceConfig
- resourceName :: Maybe Text
- httpStatus :: Int
}
newGetBackendAPIResponse :: Int -> GetBackendAPIResponse
getBackendAPIResponse_appId :: Lens' GetBackendAPIResponse (Maybe Text)
getBackendAPIResponse_backendEnvironmentName :: Lens' GetBackendAPIResponse (Maybe Text)
getBackendAPIResponse_error :: Lens' GetBackendAPIResponse (Maybe Text)
getBackendAPIResponse_resourceConfig :: Lens' GetBackendAPIResponse (Maybe BackendAPIResourceConfig)
getBackendAPIResponse_resourceName :: Lens' GetBackendAPIResponse (Maybe Text)
getBackendAPIResponse_httpStatus :: Lens' GetBackendAPIResponse Int

Creating a Request

data GetBackendAPI Source #

The request body for GetBackendAPI.

See: newGetBackendAPI smart constructor.

Constructors

GetBackendAPI'
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

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

newGetBackendAPI Source #

Arguments

:: Text	`GetBackendAPI`
-> Text	`GetBackendAPI`
-> Text	`GetBackendAPI`
-> GetBackendAPI

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

GetBackendAPI, getBackendAPI_resourceConfig - Defines the resource configuration for the data model in your Amplify project.

GetBackendAPI, getBackendAPI_appId - The app ID.

GetBackendAPI, getBackendAPI_backendEnvironmentName - The name of the backend environment.

GetBackendAPI, getBackendAPI_resourceName - The name of this resource.

Request Lenses

getBackendAPI_resourceConfig :: Lens' GetBackendAPI (Maybe BackendAPIResourceConfig) Source #

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

getBackendAPI_appId :: Lens' GetBackendAPI Text Source #

The app ID.

getBackendAPI_backendEnvironmentName :: Lens' GetBackendAPI Text Source #

The name of the backend environment.

getBackendAPI_resourceName :: Lens' GetBackendAPI Text Source #

The name of this resource.

Destructuring the Response

data GetBackendAPIResponse Source #

See: newGetBackendAPIResponse smart constructor.

Constructors

GetBackendAPIResponse'
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. resourceConfig :: Maybe BackendAPIResourceConfig The resource configuration for this response object. resourceName :: Maybe Text The name of this resource. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPI Associated Types type Rep GetBackendAPIResponse :: Type -> Type # Methods from :: GetBackendAPIResponse -> Rep GetBackendAPIResponse x # to :: Rep GetBackendAPIResponse x -> GetBackendAPIResponse #
Read GetBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPI Methods readsPrec :: Int -> ReadS GetBackendAPIResponse # readList :: ReadS [GetBackendAPIResponse] # readPrec :: ReadPrec GetBackendAPIResponse # readListPrec :: ReadPrec [GetBackendAPIResponse] #
Show GetBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPI Methods showsPrec :: Int -> GetBackendAPIResponse -> ShowS # show :: GetBackendAPIResponse -> String # showList :: [GetBackendAPIResponse] -> ShowS #
NFData GetBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPI Methods rnf :: GetBackendAPIResponse -> () #
Eq GetBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPI Methods (==) :: GetBackendAPIResponse -> GetBackendAPIResponse -> Bool # (/=) :: GetBackendAPIResponse -> GetBackendAPIResponse -> Bool #
type Rep GetBackendAPIResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPI type Rep GetBackendAPIResponse = D1 ('MetaData "GetBackendAPIResponse" "Amazonka.AmplifyBackend.GetBackendAPI" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "GetBackendAPIResponse'" '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 "resourceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackendAPIResourceConfig)) :: (S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetBackendAPIResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetBackendAPIResponse'`
-> GetBackendAPIResponse

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

GetBackendAPI, getBackendAPIResponse_appId - The app ID.

GetBackendAPI, getBackendAPIResponse_backendEnvironmentName - The name of the backend environment.

GetBackendAPIResponse, getBackendAPIResponse_error - If the request fails, this error is returned.

GetBackendAPI, getBackendAPIResponse_resourceConfig - The resource configuration for this response object.

GetBackendAPI, getBackendAPIResponse_resourceName - The name of this resource.

$sel:httpStatus:GetBackendAPIResponse', getBackendAPIResponse_httpStatus - The response's http status code.

Response Lenses

getBackendAPIResponse_appId :: Lens' GetBackendAPIResponse (Maybe Text) Source #

The app ID.

getBackendAPIResponse_backendEnvironmentName :: Lens' GetBackendAPIResponse (Maybe Text) Source #

The name of the backend environment.

getBackendAPIResponse_error :: Lens' GetBackendAPIResponse (Maybe Text) Source #

If the request fails, this error is returned.

getBackendAPIResponse_resourceConfig :: Lens' GetBackendAPIResponse (Maybe BackendAPIResourceConfig) Source #

The resource configuration for this response object.

getBackendAPIResponse_resourceName :: Lens' GetBackendAPIResponse (Maybe Text) Source #

The name of this resource.

getBackendAPIResponse_httpStatus :: Lens' GetBackendAPIResponse Int Source #

The response's http status code.