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.IotTwinMaker.CreateScene

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a scene.

Synopsis

data CreateScene = CreateScene' {
- capabilities :: Maybe [Text]
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- workspaceId :: Text
- sceneId :: Text
- contentLocation :: Text
}
newCreateScene :: Text -> Text -> Text -> CreateScene
createScene_capabilities :: Lens' CreateScene (Maybe [Text])
createScene_description :: Lens' CreateScene (Maybe Text)
createScene_tags :: Lens' CreateScene (Maybe (HashMap Text Text))
createScene_workspaceId :: Lens' CreateScene Text
createScene_sceneId :: Lens' CreateScene Text
createScene_contentLocation :: Lens' CreateScene Text
data CreateSceneResponse = CreateSceneResponse' {
- httpStatus :: Int
- arn :: Text
- creationDateTime :: POSIX
}
newCreateSceneResponse :: Int -> Text -> UTCTime -> CreateSceneResponse
createSceneResponse_httpStatus :: Lens' CreateSceneResponse Int
createSceneResponse_arn :: Lens' CreateSceneResponse Text
createSceneResponse_creationDateTime :: Lens' CreateSceneResponse UTCTime

Creating a Request

data CreateScene Source #

See: newCreateScene smart constructor.

Constructors

CreateScene'

Fields

capabilities :: Maybe [Text]
A list of capabilities that the scene uses to render itself.
description :: Maybe Text
The description for this scene.
tags :: Maybe (HashMap Text Text)
Metadata that you can use to manage the scene.
workspaceId :: Text
The ID of the workspace that contains the scene.
sceneId :: Text
The ID of the scene.
contentLocation :: Text
The relative path that specifies the location of the content definition file.

Instances

Instances details

ToJSON CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods toJSON :: CreateScene -> Value # toEncoding :: CreateScene -> Encoding # toJSONList :: [CreateScene] -> Value # toEncodingList :: [CreateScene] -> Encoding #
ToHeaders CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods toHeaders :: CreateScene -> [Header] #
ToPath CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods toPath :: CreateScene -> ByteString #
ToQuery CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods toQuery :: CreateScene -> QueryString #
AWSRequest CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Associated Types type AWSResponse CreateScene # Methods request :: (Service -> Service) -> CreateScene -> Request CreateScene # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateScene -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateScene))) #
Generic CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Associated Types type Rep CreateScene :: Type -> Type # Methods from :: CreateScene -> Rep CreateScene x # to :: Rep CreateScene x -> CreateScene #
Read CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods readsPrec :: Int -> ReadS CreateScene # readList :: ReadS [CreateScene] # readPrec :: ReadPrec CreateScene # readListPrec :: ReadPrec [CreateScene] #
Show CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods showsPrec :: Int -> CreateScene -> ShowS # show :: CreateScene -> String # showList :: [CreateScene] -> ShowS #
NFData CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods rnf :: CreateScene -> () #
Eq CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods (==) :: CreateScene -> CreateScene -> Bool # (/=) :: CreateScene -> CreateScene -> Bool #
Hashable CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods hashWithSalt :: Int -> CreateScene -> Int # hash :: CreateScene -> Int #
type AWSResponse CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene type AWSResponse CreateScene = CreateSceneResponse
type Rep CreateScene Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene type Rep CreateScene = D1 ('MetaData "CreateScene" "Amazonka.IotTwinMaker.CreateScene" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "CreateScene'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sceneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "contentLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateScene Source #

Arguments

:: Text	`CreateScene`
-> Text	`CreateScene`
-> Text	`CreateScene`
-> CreateScene

Create a value of CreateScene 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:capabilities:CreateScene', createScene_capabilities - A list of capabilities that the scene uses to render itself.

CreateScene, createScene_description - The description for this scene.

$sel:tags:CreateScene', createScene_tags - Metadata that you can use to manage the scene.

CreateScene, createScene_workspaceId - The ID of the workspace that contains the scene.

CreateScene, createScene_sceneId - The ID of the scene.

CreateScene, createScene_contentLocation - The relative path that specifies the location of the content definition file.

Request Lenses

createScene_capabilities :: Lens' CreateScene (Maybe [Text]) Source #

A list of capabilities that the scene uses to render itself.

createScene_description :: Lens' CreateScene (Maybe Text) Source #

The description for this scene.

createScene_tags :: Lens' CreateScene (Maybe (HashMap Text Text)) Source #

Metadata that you can use to manage the scene.

createScene_workspaceId :: Lens' CreateScene Text Source #

The ID of the workspace that contains the scene.

createScene_sceneId :: Lens' CreateScene Text Source #

The ID of the scene.

createScene_contentLocation :: Lens' CreateScene Text Source #

The relative path that specifies the location of the content definition file.

Destructuring the Response

data CreateSceneResponse Source #

See: newCreateSceneResponse smart constructor.

Constructors

CreateSceneResponse'
Fields httpStatus :: Int The response's http status code. arn :: Text The ARN of the scene. creationDateTime :: POSIX The date and time when the scene was created.

Instances

Instances details

Generic CreateSceneResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Associated Types type Rep CreateSceneResponse :: Type -> Type # Methods from :: CreateSceneResponse -> Rep CreateSceneResponse x # to :: Rep CreateSceneResponse x -> CreateSceneResponse #
Read CreateSceneResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods readsPrec :: Int -> ReadS CreateSceneResponse # readList :: ReadS [CreateSceneResponse] # readPrec :: ReadPrec CreateSceneResponse # readListPrec :: ReadPrec [CreateSceneResponse] #
Show CreateSceneResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods showsPrec :: Int -> CreateSceneResponse -> ShowS # show :: CreateSceneResponse -> String # showList :: [CreateSceneResponse] -> ShowS #
NFData CreateSceneResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods rnf :: CreateSceneResponse -> () #
Eq CreateSceneResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene Methods (==) :: CreateSceneResponse -> CreateSceneResponse -> Bool # (/=) :: CreateSceneResponse -> CreateSceneResponse -> Bool #
type Rep CreateSceneResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateScene type Rep CreateSceneResponse = D1 ('MetaData "CreateSceneResponse" "Amazonka.IotTwinMaker.CreateScene" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "CreateSceneResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newCreateSceneResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateSceneResponse'`
-> Text	`CreateSceneResponse`
-> UTCTime	`CreateSceneResponse`
-> CreateSceneResponse

Create a value of CreateSceneResponse 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:httpStatus:CreateSceneResponse', createSceneResponse_httpStatus - The response's http status code.

CreateSceneResponse, createSceneResponse_arn - The ARN of the scene.

CreateSceneResponse, createSceneResponse_creationDateTime - The date and time when the scene was created.

Response Lenses

createSceneResponse_httpStatus :: Lens' CreateSceneResponse Int Source #

The response's http status code.

createSceneResponse_arn :: Lens' CreateSceneResponse Text Source #

The ARN of the scene.

createSceneResponse_creationDateTime :: Lens' CreateSceneResponse UTCTime Source #

The date and time when the scene was created.