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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a model introspection schema for an existing backend API resource.

Synopsis

data GetBackendAPIModels = GetBackendAPIModels' {
- appId :: Text
- backendEnvironmentName :: Text
- resourceName :: Text
}
newGetBackendAPIModels :: Text -> Text -> Text -> GetBackendAPIModels
getBackendAPIModels_appId :: Lens' GetBackendAPIModels Text
getBackendAPIModels_backendEnvironmentName :: Lens' GetBackendAPIModels Text
getBackendAPIModels_resourceName :: Lens' GetBackendAPIModels Text
data GetBackendAPIModelsResponse = GetBackendAPIModelsResponse' {
- modelIntrospectionSchema :: Maybe Text
- models :: Maybe Text
- status :: Maybe Status
- httpStatus :: Int
}
newGetBackendAPIModelsResponse :: Int -> GetBackendAPIModelsResponse
getBackendAPIModelsResponse_modelIntrospectionSchema :: Lens' GetBackendAPIModelsResponse (Maybe Text)
getBackendAPIModelsResponse_models :: Lens' GetBackendAPIModelsResponse (Maybe Text)
getBackendAPIModelsResponse_status :: Lens' GetBackendAPIModelsResponse (Maybe Status)
getBackendAPIModelsResponse_httpStatus :: Lens' GetBackendAPIModelsResponse Int

Creating a Request

data GetBackendAPIModels Source #

The request body for GetBackendAPIModels.

See: newGetBackendAPIModels smart constructor.

Constructors

GetBackendAPIModels'
Fields appId :: Text The app ID. backendEnvironmentName :: Text The name of the backend environment. resourceName :: Text The name of this resource.

Instances

Instances details

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

newGetBackendAPIModels Source #

Arguments

:: Text	`GetBackendAPIModels`
-> Text	`GetBackendAPIModels`
-> Text	`$sel:resourceName:GetBackendAPIModels'`
-> GetBackendAPIModels

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

GetBackendAPIModels, getBackendAPIModels_appId - The app ID.

GetBackendAPIModels, getBackendAPIModels_backendEnvironmentName - The name of the backend environment.

$sel:resourceName:GetBackendAPIModels', getBackendAPIModels_resourceName - The name of this resource.

Request Lenses

getBackendAPIModels_appId :: Lens' GetBackendAPIModels Text Source #

The app ID.

getBackendAPIModels_backendEnvironmentName :: Lens' GetBackendAPIModels Text Source #

The name of the backend environment.

getBackendAPIModels_resourceName :: Lens' GetBackendAPIModels Text Source #

The name of this resource.

Destructuring the Response

data GetBackendAPIModelsResponse Source #

See: newGetBackendAPIModelsResponse smart constructor.

Constructors

GetBackendAPIModelsResponse'
Fields modelIntrospectionSchema :: Maybe Text Stringified JSON of the model introspection schema for an existing backend API resource. models :: Maybe Text Stringified JSON of the datastore model. status :: Maybe Status The current status of the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetBackendAPIModelsResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPIModels Associated Types type Rep GetBackendAPIModelsResponse :: Type -> Type # Methods from :: GetBackendAPIModelsResponse -> Rep GetBackendAPIModelsResponse x # to :: Rep GetBackendAPIModelsResponse x -> GetBackendAPIModelsResponse #
Read GetBackendAPIModelsResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPIModels Methods readsPrec :: Int -> ReadS GetBackendAPIModelsResponse # readList :: ReadS [GetBackendAPIModelsResponse] # readPrec :: ReadPrec GetBackendAPIModelsResponse # readListPrec :: ReadPrec [GetBackendAPIModelsResponse] #
Show GetBackendAPIModelsResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPIModels Methods showsPrec :: Int -> GetBackendAPIModelsResponse -> ShowS # show :: GetBackendAPIModelsResponse -> String # showList :: [GetBackendAPIModelsResponse] -> ShowS #
NFData GetBackendAPIModelsResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPIModels Methods rnf :: GetBackendAPIModelsResponse -> () #
Eq GetBackendAPIModelsResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPIModels Methods (==) :: GetBackendAPIModelsResponse -> GetBackendAPIModelsResponse -> Bool # (/=) :: GetBackendAPIModelsResponse -> GetBackendAPIModelsResponse -> Bool #
type Rep GetBackendAPIModelsResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendAPIModels type Rep GetBackendAPIModelsResponse = D1 ('MetaData "GetBackendAPIModelsResponse" "Amazonka.AmplifyBackend.GetBackendAPIModels" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "GetBackendAPIModelsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "modelIntrospectionSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "models") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Status)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBackendAPIModelsResponse Source #

Arguments

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

Create a value of GetBackendAPIModelsResponse 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:modelIntrospectionSchema:GetBackendAPIModelsResponse', getBackendAPIModelsResponse_modelIntrospectionSchema - Stringified JSON of the model introspection schema for an existing backend API resource.

$sel:models:GetBackendAPIModelsResponse', getBackendAPIModelsResponse_models - Stringified JSON of the datastore model.

GetBackendAPIModelsResponse, getBackendAPIModelsResponse_status - The current status of the request.

$sel:httpStatus:GetBackendAPIModelsResponse', getBackendAPIModelsResponse_httpStatus - The response's http status code.

Response Lenses

getBackendAPIModelsResponse_modelIntrospectionSchema :: Lens' GetBackendAPIModelsResponse (Maybe Text) Source #

Stringified JSON of the model introspection schema for an existing backend API resource.

getBackendAPIModelsResponse_models :: Lens' GetBackendAPIModelsResponse (Maybe Text) Source #

Stringified JSON of the datastore model.

getBackendAPIModelsResponse_status :: Lens' GetBackendAPIModelsResponse (Maybe Status) Source #

The current status of the request.

getBackendAPIModelsResponse_httpStatus :: Lens' GetBackendAPIModelsResponse Int Source #

The response's http status code.