1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package robomaker
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/robomaker/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Describes a simulation job batch.
func (c *Client) DescribeSimulationJobBatch(ctx context.Context, params *DescribeSimulationJobBatchInput, optFns ...func(*Options)) (*DescribeSimulationJobBatchOutput, error) {
if params == nil {
params = &DescribeSimulationJobBatchInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeSimulationJobBatch", params, optFns, c.addOperationDescribeSimulationJobBatchMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeSimulationJobBatchOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeSimulationJobBatchInput struct {
// The id of the batch to describe.
//
// This member is required.
Batch *string
noSmithyDocumentSerde
}
type DescribeSimulationJobBatchOutput struct {
// The Amazon Resource Name (ARN) of the batch.
Arn *string
// The batch policy.
BatchPolicy *types.BatchPolicy
// Unique, case-sensitive identifier that you provide to ensure the idempotency of
// the request.
ClientRequestToken *string
// The time, in milliseconds since the epoch, when the simulation job batch was
// created.
CreatedAt *time.Time
// A list of created simulation job summaries.
CreatedRequests []types.SimulationJobSummary
// A list of failed create simulation job requests. The request failed to be
// created into a simulation job. Failed requests do not have a simulation job ID.
FailedRequests []types.FailedCreateSimulationJobRequest
// The failure code of the simulation job batch.
FailureCode types.SimulationJobBatchErrorCode
// The reason the simulation job batch failed.
FailureReason *string
// The time, in milliseconds since the epoch, when the simulation job batch was
// last updated.
LastUpdatedAt *time.Time
// A list of pending simulation job requests. These requests have not yet been
// created into simulation jobs.
PendingRequests []types.SimulationJobRequest
// The status of the batch. Pending The simulation job batch request is pending.
// InProgress The simulation job batch is in progress. Failed The simulation job
// batch failed. One or more simulation job requests could not be completed due to
// an internal failure (like InternalServiceError ). See failureCode and
// failureReason for more information. Completed The simulation batch job
// completed. A batch is complete when (1) there are no pending simulation job
// requests in the batch and none of the failed simulation job requests are due to
// InternalServiceError and (2) when all created simulation jobs have reached a
// terminal state (for example, Completed or Failed ). Canceled The simulation
// batch job was cancelled. Canceling The simulation batch job is being cancelled.
// Completing The simulation batch job is completing. TimingOut The simulation job
// batch is timing out. If a batch timing out, and there are pending requests that
// were failing due to an internal failure (like InternalServiceError ), the batch
// status will be Failed . If there are no such failing request, the batch status
// will be TimedOut . TimedOut The simulation batch job timed out.
Status types.SimulationJobBatchStatus
// A map that contains tag keys and tag values that are attached to the simulation
// job batch.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeSimulationJobBatchMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeSimulationJobBatch{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeSimulationJobBatch{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeSimulationJobBatch"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeSimulationJobBatchValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeSimulationJobBatch(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeSimulationJobBatch(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeSimulationJobBatch",
}
}
|
