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.RobOMaker.DescribeWorld

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a world.

Synopsis

data DescribeWorld = DescribeWorld' {
- world :: Text
}
newDescribeWorld :: Text -> DescribeWorld
describeWorld_world :: Lens' DescribeWorld Text
data DescribeWorldResponse = DescribeWorldResponse' {
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- generationJob :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- template :: Maybe Text
- worldDescriptionBody :: Maybe Text
- httpStatus :: Int
}
newDescribeWorldResponse :: Int -> DescribeWorldResponse
describeWorldResponse_arn :: Lens' DescribeWorldResponse (Maybe Text)
describeWorldResponse_createdAt :: Lens' DescribeWorldResponse (Maybe UTCTime)
describeWorldResponse_generationJob :: Lens' DescribeWorldResponse (Maybe Text)
describeWorldResponse_tags :: Lens' DescribeWorldResponse (Maybe (HashMap Text Text))
describeWorldResponse_template :: Lens' DescribeWorldResponse (Maybe Text)
describeWorldResponse_worldDescriptionBody :: Lens' DescribeWorldResponse (Maybe Text)
describeWorldResponse_httpStatus :: Lens' DescribeWorldResponse Int

Creating a Request

data DescribeWorld Source #

See: newDescribeWorld smart constructor.

Constructors

DescribeWorld'
Fields world :: Text The Amazon Resource Name (arn) of the world you want to describe.

Instances

Instances details

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

newDescribeWorld Source #

Arguments

:: Text	`DescribeWorld`
-> DescribeWorld

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

DescribeWorld, describeWorld_world - The Amazon Resource Name (arn) of the world you want to describe.

Request Lenses

describeWorld_world :: Lens' DescribeWorld Text Source #

The Amazon Resource Name (arn) of the world you want to describe.

Destructuring the Response

data DescribeWorldResponse Source #

See: newDescribeWorldResponse smart constructor.

Constructors

DescribeWorldResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (arn) of the world.
createdAt :: Maybe POSIX
The time, in milliseconds since the epoch, when the world was created.
generationJob :: Maybe Text
The Amazon Resource Name (arn) of the world generation job that generated the world.
tags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the world.
template :: Maybe Text
The world template.
worldDescriptionBody :: Maybe Text
Returns the JSON formatted string that describes the contents of your world.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeWorldResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorld Associated Types type Rep DescribeWorldResponse :: Type -> Type # Methods from :: DescribeWorldResponse -> Rep DescribeWorldResponse x # to :: Rep DescribeWorldResponse x -> DescribeWorldResponse #
Read DescribeWorldResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorld Methods readsPrec :: Int -> ReadS DescribeWorldResponse # readList :: ReadS [DescribeWorldResponse] # readPrec :: ReadPrec DescribeWorldResponse # readListPrec :: ReadPrec [DescribeWorldResponse] #
Show DescribeWorldResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorld Methods showsPrec :: Int -> DescribeWorldResponse -> ShowS # show :: DescribeWorldResponse -> String # showList :: [DescribeWorldResponse] -> ShowS #
NFData DescribeWorldResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorld Methods rnf :: DescribeWorldResponse -> () #
Eq DescribeWorldResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorld Methods (==) :: DescribeWorldResponse -> DescribeWorldResponse -> Bool # (/=) :: DescribeWorldResponse -> DescribeWorldResponse -> Bool #
type Rep DescribeWorldResponse Source #
Instance details Defined in Amazonka.RobOMaker.DescribeWorld type Rep DescribeWorldResponse = D1 ('MetaData "DescribeWorldResponse" "Amazonka.RobOMaker.DescribeWorld" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "DescribeWorldResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "generationJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "worldDescriptionBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeWorldResponse Source #

Arguments

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

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

DescribeWorldResponse, describeWorldResponse_arn - The Amazon Resource Name (arn) of the world.

DescribeWorldResponse, describeWorldResponse_createdAt - The time, in milliseconds since the epoch, when the world was created.

DescribeWorldResponse, describeWorldResponse_generationJob - The Amazon Resource Name (arn) of the world generation job that generated the world.

DescribeWorldResponse, describeWorldResponse_tags - A map that contains tag keys and tag values that are attached to the world.

DescribeWorldResponse, describeWorldResponse_template - The world template.

$sel:worldDescriptionBody:DescribeWorldResponse', describeWorldResponse_worldDescriptionBody - Returns the JSON formatted string that describes the contents of your world.

$sel:httpStatus:DescribeWorldResponse', describeWorldResponse_httpStatus - The response's http status code.

Response Lenses

describeWorldResponse_arn :: Lens' DescribeWorldResponse (Maybe Text) Source #

The Amazon Resource Name (arn) of the world.

describeWorldResponse_createdAt :: Lens' DescribeWorldResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world was created.

describeWorldResponse_generationJob :: Lens' DescribeWorldResponse (Maybe Text) Source #

The Amazon Resource Name (arn) of the world generation job that generated the world.

describeWorldResponse_tags :: Lens' DescribeWorldResponse (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the world.

describeWorldResponse_template :: Lens' DescribeWorldResponse (Maybe Text) Source #

The world template.

describeWorldResponse_worldDescriptionBody :: Lens' DescribeWorldResponse (Maybe Text) Source #

Returns the JSON formatted string that describes the contents of your world.

describeWorldResponse_httpStatus :: Lens' DescribeWorldResponse Int Source #

The response's http status code.