-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_ListDevices.go
286 lines (253 loc) · 8.58 KB
/
api_op_ListDevices.go
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
// Code generated by smithy-go-codegen DO NOT EDIT.
package devicefarm
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/devicefarm/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Gets information about unique device types.
func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optFns ...func(*Options)) (*ListDevicesOutput, error) {
if params == nil {
params = &ListDevicesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListDevices", params, optFns, c.addOperationListDevicesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListDevicesOutput)
out.ResultMetadata = metadata
return out, nil
}
// Represents the result of a list devices request.
type ListDevicesInput struct {
// The Amazon Resource Name (ARN) of the project.
Arn *string
// Used to select a set of devices. A filter is made up of an attribute, an
// operator, and one or more values.
//
// - Attribute: The aspect of a device such as platform or model used as the
// selection criteria in a device filter.
//
// Allowed values include:
//
// - ARN: The Amazon Resource Name (ARN) of the device (for example,
// arn:aws:devicefarm:us-west-2::device:12345Example ).
//
// - PLATFORM: The device platform. Valid values are ANDROID or IOS.
//
// - OS_VERSION: The operating system version (for example, 10.3.2).
//
// - MODEL: The device model (for example, iPad 5th Gen).
//
// - AVAILABILITY: The current availability of the device. Valid values are
// AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
//
// - FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
//
// - MANUFACTURER: The device manufacturer (for example, Apple).
//
// - REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
// Valid values are TRUE or FALSE.
//
// - REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
// Valid values are TRUE or FALSE. Because remote debugging is [no longer supported], this attribute
// is ignored.
//
// - INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
//
// - INSTANCE_LABELS: The label of the device instance.
//
// - FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
//
// - Operator: The filter operator.
//
// - The EQUALS operator is available for every attribute except INSTANCE_LABELS.
//
// - The CONTAINS operator is available for the INSTANCE_LABELS and MODEL
// attributes.
//
// - The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL,
// MANUFACTURER, and INSTANCE_ARN attributes.
//
// - The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and
// GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION
// attribute.
//
// - Values: An array of one or more filter values.
//
// - The IN and NOT_IN operators take a values array that has one or more
// elements.
//
// - The other operators require an array with a single element.
//
// - In a request, the AVAILABILITY attribute takes the following values:
// AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
//
// [no longer supported]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html
Filters []types.DeviceFilter
// An identifier that was returned from the previous call to this operation, which
// can be used to return the next set of items in the list.
NextToken *string
noSmithyDocumentSerde
}
// Represents the result of a list devices operation.
type ListDevicesOutput struct {
// Information about the devices.
Devices []types.Device
// If the number of items that are returned is significantly large, this is an
// identifier that is also returned. It can be used in a subsequent call to this
// operation to return the next set of items in the list.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListDevicesMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpListDevices{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListDevices{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ListDevices"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addOpListDevicesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListDevices(options.Region), middleware.Before); err != nil {
return err
}
if err = 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
}
// ListDevicesAPIClient is a client that implements the ListDevices operation.
type ListDevicesAPIClient interface {
ListDevices(context.Context, *ListDevicesInput, ...func(*Options)) (*ListDevicesOutput, error)
}
var _ ListDevicesAPIClient = (*Client)(nil)
// ListDevicesPaginatorOptions is the paginator options for ListDevices
type ListDevicesPaginatorOptions struct {
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListDevicesPaginator is a paginator for ListDevices
type ListDevicesPaginator struct {
options ListDevicesPaginatorOptions
client ListDevicesAPIClient
params *ListDevicesInput
nextToken *string
firstPage bool
}
// NewListDevicesPaginator returns a new ListDevicesPaginator
func NewListDevicesPaginator(client ListDevicesAPIClient, params *ListDevicesInput, optFns ...func(*ListDevicesPaginatorOptions)) *ListDevicesPaginator {
if params == nil {
params = &ListDevicesInput{}
}
options := ListDevicesPaginatorOptions{}
for _, fn := range optFns {
fn(&options)
}
return &ListDevicesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListDevicesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListDevices page.
func (p *ListDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDevicesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
result, err := p.client.ListDevices(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListDevices(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ListDevices",
}
}