Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RobOMaker.CreateWorldExportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a world export job.

Synopsis

data CreateWorldExportJob = CreateWorldExportJob' {
- clientRequestToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- worlds :: NonEmpty Text
- outputLocation :: OutputLocation
- iamRole :: Text
}
newCreateWorldExportJob :: NonEmpty Text -> OutputLocation -> Text -> CreateWorldExportJob
createWorldExportJob_clientRequestToken :: Lens' CreateWorldExportJob (Maybe Text)
createWorldExportJob_tags :: Lens' CreateWorldExportJob (Maybe (HashMap Text Text))
createWorldExportJob_worlds :: Lens' CreateWorldExportJob (NonEmpty Text)
createWorldExportJob_outputLocation :: Lens' CreateWorldExportJob OutputLocation
createWorldExportJob_iamRole :: Lens' CreateWorldExportJob Text
data CreateWorldExportJobResponse = CreateWorldExportJobResponse' {
- status :: Maybe WorldExportJobStatus
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- failureCode :: Maybe WorldExportJobErrorCode
- outputLocation :: Maybe OutputLocation
- clientRequestToken :: Maybe Text
- iamRole :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newCreateWorldExportJobResponse :: Int -> CreateWorldExportJobResponse
createWorldExportJobResponse_status :: Lens' CreateWorldExportJobResponse (Maybe WorldExportJobStatus)
createWorldExportJobResponse_arn :: Lens' CreateWorldExportJobResponse (Maybe Text)
createWorldExportJobResponse_createdAt :: Lens' CreateWorldExportJobResponse (Maybe UTCTime)
createWorldExportJobResponse_failureCode :: Lens' CreateWorldExportJobResponse (Maybe WorldExportJobErrorCode)
createWorldExportJobResponse_outputLocation :: Lens' CreateWorldExportJobResponse (Maybe OutputLocation)
createWorldExportJobResponse_clientRequestToken :: Lens' CreateWorldExportJobResponse (Maybe Text)
createWorldExportJobResponse_iamRole :: Lens' CreateWorldExportJobResponse (Maybe Text)
createWorldExportJobResponse_tags :: Lens' CreateWorldExportJobResponse (Maybe (HashMap Text Text))
createWorldExportJobResponse_httpStatus :: Lens' CreateWorldExportJobResponse Int

Creating a Request

data CreateWorldExportJob Source #

See: newCreateWorldExportJob smart constructor.

Constructors

CreateWorldExportJob'

Fields

clientRequestToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
tags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the world export job.
worlds :: NonEmpty Text
A list of Amazon Resource Names (arns) that correspond to worlds to export.
outputLocation :: OutputLocation
iamRole :: Text
The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

Instances

Instances details

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

newCreateWorldExportJob Source #

Arguments

:: NonEmpty Text	`$sel:worlds:CreateWorldExportJob'`
-> OutputLocation	`$sel:outputLocation:CreateWorldExportJob'`
-> Text	`$sel:iamRole:CreateWorldExportJob'`
-> CreateWorldExportJob

Create a value of CreateWorldExportJob 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:clientRequestToken:CreateWorldExportJob', createWorldExportJob_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:tags:CreateWorldExportJob', createWorldExportJob_tags - A map that contains tag keys and tag values that are attached to the world export job.

$sel:worlds:CreateWorldExportJob', createWorldExportJob_worlds - A list of Amazon Resource Names (arns) that correspond to worlds to export.

$sel:outputLocation:CreateWorldExportJob', createWorldExportJob_outputLocation - Undocumented member.

$sel:iamRole:CreateWorldExportJob', createWorldExportJob_iamRole - The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

Request Lenses

createWorldExportJob_clientRequestToken :: Lens' CreateWorldExportJob (Maybe Text) Source #

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

createWorldExportJob_tags :: Lens' CreateWorldExportJob (Maybe (HashMap Text Text)) Source #

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

createWorldExportJob_worlds :: Lens' CreateWorldExportJob (NonEmpty Text) Source #

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

createWorldExportJob_outputLocation :: Lens' CreateWorldExportJob OutputLocation Source #

Undocumented member.

createWorldExportJob_iamRole :: Lens' CreateWorldExportJob Text Source #

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

Destructuring the Response

data CreateWorldExportJobResponse Source #

See: newCreateWorldExportJobResponse smart constructor.

Constructors

CreateWorldExportJobResponse'

Fields

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 for more information.
Canceled
The world export job was cancelled.
Canceling
The world export job is being cancelled.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the world export job.
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.
AllWorldGenerationFailed
All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
outputLocation :: Maybe OutputLocation
clientRequestToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
iamRole :: Maybe Text
The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
tags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the world export job.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateWorldExportJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateWorldExportJob Methods (==) :: CreateWorldExportJobResponse -> CreateWorldExportJobResponse -> Bool # (/=) :: CreateWorldExportJobResponse -> CreateWorldExportJobResponse -> Bool #
Read CreateWorldExportJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateWorldExportJob Methods readsPrec :: Int -> ReadS CreateWorldExportJobResponse # readList :: ReadS [CreateWorldExportJobResponse] # readPrec :: ReadPrec CreateWorldExportJobResponse # readListPrec :: ReadPrec [CreateWorldExportJobResponse] #
Show CreateWorldExportJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateWorldExportJob Methods showsPrec :: Int -> CreateWorldExportJobResponse -> ShowS # show :: CreateWorldExportJobResponse -> String # showList :: [CreateWorldExportJobResponse] -> ShowS #
Generic CreateWorldExportJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateWorldExportJob Associated Types type Rep CreateWorldExportJobResponse :: Type -> Type # Methods from :: CreateWorldExportJobResponse -> Rep CreateWorldExportJobResponse x # to :: Rep CreateWorldExportJobResponse x -> CreateWorldExportJobResponse #
NFData CreateWorldExportJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateWorldExportJob Methods rnf :: CreateWorldExportJobResponse -> () #
type Rep CreateWorldExportJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateWorldExportJob type Rep CreateWorldExportJobResponse = D1 ('MetaData "CreateWorldExportJobResponse" "Amazonka.RobOMaker.CreateWorldExportJob" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "CreateWorldExportJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorldExportJobStatus)) :: S1 ('MetaSel ('Just "arn") '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 "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputLocation)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateWorldExportJobResponse Source #

Arguments

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

Create a value of CreateWorldExportJobResponse 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:status:CreateWorldExportJobResponse', createWorldExportJobResponse_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 for more information.
Canceled: The world export job was cancelled.
Canceling: The world export job is being cancelled.

$sel:arn:CreateWorldExportJobResponse', createWorldExportJobResponse_arn - The Amazon Resource Name (ARN) of the world export job.

$sel:createdAt:CreateWorldExportJobResponse', createWorldExportJobResponse_createdAt - The time, in milliseconds since the epoch, when the world export job was created.

$sel:failureCode:CreateWorldExportJobResponse', createWorldExportJobResponse_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.
AllWorldGenerationFailed: All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.

For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.

$sel:outputLocation:CreateWorldExportJob', createWorldExportJobResponse_outputLocation - Undocumented member.

$sel:clientRequestToken:CreateWorldExportJob', createWorldExportJobResponse_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:iamRole:CreateWorldExportJob', createWorldExportJobResponse_iamRole - The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

$sel:tags:CreateWorldExportJob', createWorldExportJobResponse_tags - A map that contains tag keys and tag values that are attached to the world export job.

$sel:httpStatus:CreateWorldExportJobResponse', createWorldExportJobResponse_httpStatus - The response's http status code.

Response Lenses

createWorldExportJobResponse_status :: Lens' CreateWorldExportJobResponse (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 for more information.
Canceled: The world export job was cancelled.
Canceling: The world export job is being cancelled.

createWorldExportJobResponse_arn :: Lens' CreateWorldExportJobResponse (Maybe Text) Source #

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

createWorldExportJobResponse_createdAt :: Lens' CreateWorldExportJobResponse (Maybe UTCTime) Source #

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

createWorldExportJobResponse_failureCode :: Lens' CreateWorldExportJobResponse (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.
AllWorldGenerationFailed: All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.

For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.

createWorldExportJobResponse_outputLocation :: Lens' CreateWorldExportJobResponse (Maybe OutputLocation) Source #

Undocumented member.

createWorldExportJobResponse_clientRequestToken :: Lens' CreateWorldExportJobResponse (Maybe Text) Source #

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

createWorldExportJobResponse_iamRole :: Lens' CreateWorldExportJobResponse (Maybe Text) Source #

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

createWorldExportJobResponse_tags :: Lens' CreateWorldExportJobResponse (Maybe (HashMap Text Text)) Source #

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

createWorldExportJobResponse_httpStatus :: Lens' CreateWorldExportJobResponse Int Source #

The response's http status code.