-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_DescribeFleetCapacity.go
176 lines (151 loc) · 6.11 KB
/
api_op_DescribeFleetCapacity.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
// 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.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetCapacityInput
type DescribeFleetCapacityInput struct {
_ struct{} `type:"structure"`
// Unique identifier for a fleet(s) to retrieve capacity information for. To
// request capacity information for all fleets, leave this parameter empty.
FleetIds []string `min:"1" type:"list"`
// Maximum number of results to return. Use this parameter with NextToken to
// get results as a set of sequential pages. This parameter is ignored when
// the request specifies one or a list of fleet IDs.
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. This parameter
// is ignored when the request specifies one or a list of fleet IDs.
NextToken *string `min:"1" type:"string"`
}
// String returns the string representation
func (s DescribeFleetCapacityInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeFleetCapacityInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DescribeFleetCapacityInput"}
if s.FleetIds != nil && len(s.FleetIds) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("FleetIds", 1))
}
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.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetCapacityOutput
type DescribeFleetCapacityOutput struct {
_ struct{} `type:"structure"`
// Collection of objects containing capacity information for each requested
// fleet ID. Leave this parameter empty to retrieve capacity information for
// all fleets.
FleetCapacity []FleetCapacity `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 DescribeFleetCapacityOutput) String() string {
return awsutil.Prettify(s)
}
const opDescribeFleetCapacity = "DescribeFleetCapacity"
// DescribeFleetCapacityRequest returns a request value for making API operation for
// Amazon GameLift.
//
// Retrieves the current status of fleet capacity for one or more fleets. This
// information includes the number of instances that have been requested for
// the fleet and the number currently active. You can request capacity for all
// fleets, or specify a list of one or more fleet IDs. When requesting multiple
// fleets, use the pagination parameters to retrieve results as a set of sequential
// pages. If successful, a FleetCapacity object is returned for each requested
// fleet ID. When specifying a list of fleet IDs, attribute objects are returned
// only for fleets that currently exist.
//
// Some API actions may limit the number of fleet IDs allowed in one request.
// If a request exceeds this limit, the request fails and the error message
// includes the maximum allowed.
//
// Learn more
//
// Working with 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 DescribeFleetCapacityRequest.
// req := client.DescribeFleetCapacityRequest(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/DescribeFleetCapacity
func (c *Client) DescribeFleetCapacityRequest(input *DescribeFleetCapacityInput) DescribeFleetCapacityRequest {
op := &aws.Operation{
Name: opDescribeFleetCapacity,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeFleetCapacityInput{}
}
req := c.newRequest(op, input, &DescribeFleetCapacityOutput{})
return DescribeFleetCapacityRequest{Request: req, Input: input, Copy: c.DescribeFleetCapacityRequest}
}
// DescribeFleetCapacityRequest is the request type for the
// DescribeFleetCapacity API operation.
type DescribeFleetCapacityRequest struct {
*aws.Request
Input *DescribeFleetCapacityInput
Copy func(*DescribeFleetCapacityInput) DescribeFleetCapacityRequest
}
// Send marshals and sends the DescribeFleetCapacity API request.
func (r DescribeFleetCapacityRequest) Send(ctx context.Context) (*DescribeFleetCapacityResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &DescribeFleetCapacityResponse{
DescribeFleetCapacityOutput: r.Request.Data.(*DescribeFleetCapacityOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// DescribeFleetCapacityResponse is the response type for the
// DescribeFleetCapacity API operation.
type DescribeFleetCapacityResponse struct {
*DescribeFleetCapacityOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// DescribeFleetCapacity request.
func (r *DescribeFleetCapacityResponse) SDKResponseMetdata() *aws.Response {
return r.response
}