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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a world export job.

Synopsis

Creating a Request

data DescribeWorldExportJob Source #

See: newDescribeWorldExportJob smart constructor.

Constructors

DescribeWorldExportJob'
Fields job :: Text The Amazon Resource Name (arn) of the world export job to describe.

Instances

Instances details

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

newDescribeWorldExportJob Source #

Arguments

:: Text	`$sel:job:DescribeWorldExportJob'`
-> DescribeWorldExportJob

Create a value of DescribeWorldExportJob 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:job:DescribeWorldExportJob', describeWorldExportJob_job - The Amazon Resource Name (arn) of the world export job to describe.

Request Lenses

describeWorldExportJob_job :: Lens' DescribeWorldExportJob Text Source #

The Amazon Resource Name (arn) of the world export job to describe.

Destructuring the Response

data DescribeWorldExportJobResponse Source #

See: newDescribeWorldExportJobResponse smart constructor.

Constructors

DescribeWorldExportJobResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the world export job.
clientRequestToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
createdAt :: Maybe POSIX
The time, in milliseconds since the epoch, when the world export job was created.
failureCode :: Maybe WorldExportJobErrorCode
The failure code of the world export job if it failed:
InternalServiceError
Internal service error.
LimitExceeded
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound
The specified resource could not be found.
RequestThrottled
The request was throttled.
InvalidInput
An input parameter in the request is not valid.
failureReason :: Maybe Text
The reason why the world export job failed.
iamRole :: Maybe Text
The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
outputLocation :: Maybe OutputLocation
status :: Maybe WorldExportJobStatus
The status of the world export job.
Pending
The world export job request is pending.
Running
The world export job is running.
Completed
The world export job completed.
Failed
The world export job failed. See failureCode and failureReason for more information.
Canceled
The world export job was cancelled.
Canceling
The world export job is being cancelled.
tags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the world export job.
worlds :: Maybe (NonEmpty Text)
A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeWorldExportJobResponse Source #

Arguments

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

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

DescribeWorldExportJobResponse, describeWorldExportJobResponse_arn - The Amazon Resource Name (ARN) of the world export job.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_createdAt - The time, in milliseconds since the epoch, when the world export job was created.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_failureCode - The failure code of the world export job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_failureReason - The reason why the world export job failed.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_iamRole - The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_outputLocation - Undocumented member.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_status - The status of the world export job.

Pending: The world export job request is pending.
Running: The world export job is running.
Completed: The world export job completed.
Failed: The world export job failed. See failureCode and failureReason for more information.
Canceled: The world export job was cancelled.
Canceling: The world export job is being cancelled.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_tags - A map that contains tag keys and tag values that are attached to the world export job.

DescribeWorldExportJobResponse, describeWorldExportJobResponse_worlds - A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

$sel:httpStatus:DescribeWorldExportJobResponse', describeWorldExportJobResponse_httpStatus - The response's http status code.

Response Lenses

describeWorldExportJobResponse_arn :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world export job.

describeWorldExportJobResponse_clientRequestToken :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

describeWorldExportJobResponse_createdAt :: Lens' DescribeWorldExportJobResponse (Maybe UTCTime) Source #

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

describeWorldExportJobResponse_failureCode :: Lens' DescribeWorldExportJobResponse (Maybe WorldExportJobErrorCode) Source #

The failure code of the world export job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.

describeWorldExportJobResponse_failureReason :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

The reason why the world export job failed.

describeWorldExportJobResponse_iamRole :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

describeWorldExportJobResponse_outputLocation :: Lens' DescribeWorldExportJobResponse (Maybe OutputLocation) Source #

Undocumented member.

describeWorldExportJobResponse_status :: Lens' DescribeWorldExportJobResponse (Maybe WorldExportJobStatus) Source #

The status of the world export job.

Pending: The world export job request is pending.
Running: The world export job is running.
Completed: The world export job completed.
Failed: The world export job failed. See failureCode and failureReason for more information.
Canceled: The world export job was cancelled.
Canceling: The world export job is being cancelled.

describeWorldExportJobResponse_tags :: Lens' DescribeWorldExportJobResponse (Maybe (HashMap Text Text)) Source #

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

describeWorldExportJobResponse_worlds :: Lens' DescribeWorldExportJobResponse (Maybe (NonEmpty Text)) Source #

A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

describeWorldExportJobResponse_httpStatus :: Lens' DescribeWorldExportJobResponse Int Source #

The response's http status code.