File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 662,428 kB
  • sloc: java: 16,875; makefile: 432; sh: 175
file content (260 lines) | stat: -rw-r--r-- 6,695 bytes parent folder | download | duplicates (3)
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
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// An error that explains why an action did not succeed.
type ErrorReason struct {

	// Service Quotas returns the following error values:
	//
	//   - DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required
	//   permissions to complete the action. To resolve the error, you must have
	//   permission to access the Amazon Web Service or quota.
	//
	//   - DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling Service
	//   Quotas.
	//
	//   - DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available.
	//
	//   - SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.
	ErrorCode ErrorCode

	// The error message.
	ErrorMessage *string

	noSmithyDocumentSerde
}

// Information about the CloudWatch metric that reflects quota usage.
type MetricInfo struct {

	// The metric dimension. This is a name/value pair that is part of the identity of
	// a metric.
	MetricDimensions map[string]string

	// The name of the metric.
	MetricName *string

	// The namespace of the metric.
	MetricNamespace *string

	// The metric statistic that we recommend you use when determining quota usage.
	MetricStatisticRecommendation *string

	noSmithyDocumentSerde
}

// A structure that describes the context for a service quota. The context
// identifies what the quota applies to.
type QuotaContextInfo struct {

	// Specifies the Amazon Web Services account or resource to which the quota
	// applies. The value in this field depends on the context scope associated with
	// the specified service quota.
	ContextId *string

	// Specifies whether the quota applies to an Amazon Web Services account, or to a
	// resource.
	ContextScope QuotaContextScope

	// When the ContextScope is RESOURCE , then this specifies the resource type of the
	// specified resource.
	ContextScopeType *string

	noSmithyDocumentSerde
}

// Information about the quota period.
type QuotaPeriod struct {

	// The time unit.
	PeriodUnit PeriodUnit

	// The value associated with the reported PeriodUnit .
	PeriodValue *int32

	noSmithyDocumentSerde
}

// Information about a quota increase request.
type RequestedServiceQuotaChange struct {

	// The case ID.
	CaseId *string

	// The date and time when the quota increase request was received and the case ID
	// was created.
	Created *time.Time

	// The new, increased value for the quota.
	DesiredValue *float64

	// Indicates whether the quota is global.
	GlobalQuota bool

	// The unique identifier.
	Id *string

	// The date and time of the most recent change.
	LastUpdated *time.Time

	// The Amazon Resource Name (ARN) of the quota.
	QuotaArn *string

	// Specifies the quota identifier. To find the quota code for a specific quota,
	// use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the
	// quota you want.
	QuotaCode *string

	// The context for this service quota.
	QuotaContext *QuotaContextInfo

	// Specifies the quota name.
	QuotaName *string

	// Specifies at which level within the Amazon Web Services account the quota
	// request applies to.
	QuotaRequestedAtLevel AppliedLevelEnum

	// The IAM identity of the requester.
	Requester *string

	// Specifies the service identifier. To find the service code value for an Amazon
	// Web Services service, use the ListServicesoperation.
	ServiceCode *string

	// Specifies the service name.
	ServiceName *string

	// The state of the quota increase request.
	Status RequestStatus

	// The unit of measurement.
	Unit *string

	noSmithyDocumentSerde
}

// Information about an Amazon Web Service.
type ServiceInfo struct {

	// Specifies the service identifier. To find the service code value for an Amazon
	// Web Services service, use the ListServicesoperation.
	ServiceCode *string

	// Specifies the service name.
	ServiceName *string

	noSmithyDocumentSerde
}

// Information about a quota.
type ServiceQuota struct {

	// Indicates whether the quota value can be increased.
	Adjustable bool

	// The error code and error reason.
	ErrorReason *ErrorReason

	// Indicates whether the quota is global.
	GlobalQuota bool

	// The period of time.
	Period *QuotaPeriod

	// Specifies at which level of granularity that the quota value is applied.
	QuotaAppliedAtLevel AppliedLevelEnum

	// The Amazon Resource Name (ARN) of the quota.
	QuotaArn *string

	// Specifies the quota identifier. To find the quota code for a specific quota,
	// use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the
	// quota you want.
	QuotaCode *string

	// The context for this service quota.
	QuotaContext *QuotaContextInfo

	// Specifies the quota name.
	QuotaName *string

	// Specifies the service identifier. To find the service code value for an Amazon
	// Web Services service, use the ListServicesoperation.
	ServiceCode *string

	// Specifies the service name.
	ServiceName *string

	// The unit of measurement.
	Unit *string

	// Information about the measurement.
	UsageMetric *MetricInfo

	// The quota value.
	Value *float64

	noSmithyDocumentSerde
}

// Information about a quota increase request.
type ServiceQuotaIncreaseRequestInTemplate struct {

	// The Amazon Web Services Region.
	AwsRegion *string

	// The new, increased value of the quota.
	DesiredValue *float64

	// Indicates whether the quota is global.
	GlobalQuota bool

	// Specifies the quota identifier. To find the quota code for a specific quota,
	// use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the
	// quota you want.
	QuotaCode *string

	// Specifies the quota name.
	QuotaName *string

	// Specifies the service identifier. To find the service code value for an Amazon
	// Web Services service, use the ListServicesoperation.
	ServiceCode *string

	// Specifies the service name.
	ServiceName *string

	// The unit of measurement.
	Unit *string

	noSmithyDocumentSerde
}

// A complex data type that contains a tag key and tag value.
type Tag struct {

	// A string that contains a tag key. The string length should be between 1 and 128
	// characters. Valid characters include a-z, A-Z, 0-9, space, and the special
	// characters _ - . : / = + @.
	//
	// This member is required.
	Key *string

	// A string that contains an optional tag value. The string length should be
	// between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and
	// the special characters _ - . : / = + @.
	//
	// This member is required.
	Value *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde