1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package robomaker
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/robomaker/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Describes a world generation job.
16func (c *Client) DescribeWorldGenerationJob(ctx context.Context, params *DescribeWorldGenerationJobInput, optFns ...func(*Options)) (*DescribeWorldGenerationJobOutput, error) {
17	if params == nil {
18		params = &DescribeWorldGenerationJobInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeWorldGenerationJob", params, optFns, addOperationDescribeWorldGenerationJobMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeWorldGenerationJobOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeWorldGenerationJobInput struct {
32
33	// The Amazon Resource Name (arn) of the world generation job to describe.
34	//
35	// This member is required.
36	Job *string
37}
38
39type DescribeWorldGenerationJobOutput struct {
40
41	// The Amazon Resource Name (ARN) of the world generation job.
42	Arn *string
43
44	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
45	// the request.
46	ClientRequestToken *string
47
48	// The time, in milliseconds since the epoch, when the world generation job was
49	// created.
50	CreatedAt *time.Time
51
52	// The failure code of the world generation job if it failed: InternalServiceError
53	// Internal service error. LimitExceeded The requested resource exceeds the maximum
54	// number allowed, or the number of concurrent stream requests exceeds the maximum
55	// number allowed. ResourceNotFound The specified resource could not be found.
56	// RequestThrottled The request was throttled. InvalidInput An input parameter in
57	// the request is not valid.
58	FailureCode types.WorldGenerationJobErrorCode
59
60	// The reason why the world generation job failed.
61	FailureReason *string
62
63	// Summary information about finished worlds.
64	FinishedWorldsSummary *types.FinishedWorldsSummary
65
66	// The status of the world generation job: Pending The world generation job request
67	// is pending. Running The world generation job is running. Completed The world
68	// generation job completed. Failed The world generation job failed. See
69	// failureCode for more information. PartialFailed Some worlds did not generate.
70	// Canceled The world generation job was cancelled. Canceling The world generation
71	// job is being cancelled.
72	Status types.WorldGenerationJobStatus
73
74	// A map that contains tag keys and tag values that are attached to the world
75	// generation job.
76	Tags map[string]string
77
78	// The Amazon Resource Name (arn) of the world template.
79	Template *string
80
81	// Information about the world count.
82	WorldCount *types.WorldCount
83
84	// A map that contains tag keys and tag values that are attached to the generated
85	// worlds.
86	WorldTags map[string]string
87
88	// Metadata pertaining to the operation's result.
89	ResultMetadata middleware.Metadata
90}
91
92func addOperationDescribeWorldGenerationJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
93	err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeWorldGenerationJob{}, middleware.After)
94	if err != nil {
95		return err
96	}
97	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeWorldGenerationJob{}, middleware.After)
98	if err != nil {
99		return err
100	}
101	if err = addSetLoggerMiddleware(stack, options); err != nil {
102		return err
103	}
104	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
105		return err
106	}
107	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
108		return err
109	}
110	if err = addResolveEndpointMiddleware(stack, options); err != nil {
111		return err
112	}
113	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
114		return err
115	}
116	if err = addRetryMiddlewares(stack, options); err != nil {
117		return err
118	}
119	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
120		return err
121	}
122	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
123		return err
124	}
125	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
126		return err
127	}
128	if err = addClientUserAgent(stack); err != nil {
129		return err
130	}
131	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
132		return err
133	}
134	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
135		return err
136	}
137	if err = addOpDescribeWorldGenerationJobValidationMiddleware(stack); err != nil {
138		return err
139	}
140	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeWorldGenerationJob(options.Region), middleware.Before); err != nil {
141		return err
142	}
143	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
144		return err
145	}
146	if err = addResponseErrorMiddleware(stack); err != nil {
147		return err
148	}
149	if err = addRequestResponseLogging(stack, options); err != nil {
150		return err
151	}
152	return nil
153}
154
155func newServiceMetadataMiddleware_opDescribeWorldGenerationJob(region string) *awsmiddleware.RegisterServiceMetadata {
156	return &awsmiddleware.RegisterServiceMetadata{
157		Region:        region,
158		ServiceID:     ServiceID,
159		SigningName:   "robomaker",
160		OperationName: "DescribeWorldGenerationJob",
161	}
162}
163