-
Notifications
You must be signed in to change notification settings - Fork 604
/
api_op_ListFleets.go
169 lines (143 loc) · 5.04 KB
/
api_op_ListFleets.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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package gamelift
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// Represents the input for a request action.
type ListFleetsInput struct {
_ struct{} `type:"structure"`
// Unique identifier for a build to return fleets for. Use this parameter to
// return only fleets using the specified build. To retrieve all fleets, leave
// this parameter empty.
BuildId *string `type:"string"`
// Maximum number of results to return. Use this parameter with NextToken to
// get results as a set of sequential pages.
Limit *int64 `min:"1" type:"integer"`
// Token that indicates the start of the next sequential page of results. Use
// the token that is returned with a previous call to this action. To start
// at the beginning of the result set, do not specify a value.
NextToken *string `min:"1" type:"string"`
// Unique identifier for a Realtime script to return fleets for. Use this parameter
// to return only fleets using the specified script. To retrieve all fleets,
// leave this parameter empty.
ScriptId *string `type:"string"`
}
// String returns the string representation
func (s ListFleetsInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListFleetsInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "ListFleetsInput"}
if s.Limit != nil && *s.Limit < 1 {
invalidParams.Add(aws.NewErrParamMinValue("Limit", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("NextToken", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Represents the returned data in response to a request action.
type ListFleetsOutput struct {
_ struct{} `type:"structure"`
// Set of fleet IDs matching the list request. You can retrieve additional information
// about all returned fleets by passing this result set to a call to DescribeFleetAttributes,
// DescribeFleetCapacity, or DescribeFleetUtilization.
FleetIds []string `min:"1" type:"list"`
// Token that indicates where to resume retrieving results on the next call
// to this action. If no token is returned, these results represent the end
// of the list.
NextToken *string `min:"1" type:"string"`
}
// String returns the string representation
func (s ListFleetsOutput) String() string {
return awsutil.Prettify(s)
}
const opListFleets = "ListFleets"
// ListFleetsRequest returns a request value for making API operation for
// Amazon GameLift.
//
// Retrieves a collection of fleet records for this AWS account. You can filter
// the result set to find only those fleets that are deployed with a specific
// build or script. Use the pagination parameters to retrieve results in sequential
// pages.
//
// Fleet records are not listed in a particular order.
//
// Learn more
//
// Set Up Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html).
//
// Related operations
//
// * CreateFleet
//
// * ListFleets
//
// * DeleteFleet
//
// * Describe fleets: DescribeFleetAttributes DescribeFleetCapacity DescribeFleetPortSettings
// DescribeFleetUtilization DescribeRuntimeConfiguration DescribeEC2InstanceLimits
// DescribeFleetEvents
//
// * Update fleets: UpdateFleetAttributes UpdateFleetCapacity UpdateFleetPortSettings
// UpdateRuntimeConfiguration
//
// * Manage fleet actions: StartFleetActions StopFleetActions
//
// // Example sending a request using ListFleetsRequest.
// req := client.ListFleetsRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleets
func (c *Client) ListFleetsRequest(input *ListFleetsInput) ListFleetsRequest {
op := &aws.Operation{
Name: opListFleets,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ListFleetsInput{}
}
req := c.newRequest(op, input, &ListFleetsOutput{})
return ListFleetsRequest{Request: req, Input: input, Copy: c.ListFleetsRequest}
}
// ListFleetsRequest is the request type for the
// ListFleets API operation.
type ListFleetsRequest struct {
*aws.Request
Input *ListFleetsInput
Copy func(*ListFleetsInput) ListFleetsRequest
}
// Send marshals and sends the ListFleets API request.
func (r ListFleetsRequest) Send(ctx context.Context) (*ListFleetsResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &ListFleetsResponse{
ListFleetsOutput: r.Request.Data.(*ListFleetsOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// ListFleetsResponse is the response type for the
// ListFleets API operation.
type ListFleetsResponse struct {
*ListFleetsOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// ListFleets request.
func (r *ListFleetsResponse) SDKResponseMetdata() *aws.Response {
return r.response
}