aws-sdk-efs 1.0.0.rc1 → 1.0.0.rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,23 +1,14 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module EFS
10
- module Errors
8
+ module Aws::EFS
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module EFS
10
- class Resource
8
+ module Aws::EFS
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,518 +1,551 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module EFS
10
- module Types
8
+ module Aws::EFS
9
+ module Types
11
10
 
12
- # @note When making an API call, pass CreateFileSystemRequest
13
- # data as a hash:
14
- #
15
- # {
16
- # creation_token: "CreationToken", # required
17
- # performance_mode: "generalPurpose", # accepts generalPurpose, maxIO
18
- # }
19
- # @!attribute [rw] creation_token
20
- # String of up to 64 ASCII characters. Amazon EFS uses this to ensure
21
- # idempotent creation.
22
- # @return [String]
23
- #
24
- # @!attribute [rw] performance_mode
25
- # The `PerformanceMode` of the file system. We recommend
26
- # `generalPurpose` performance mode for most file systems. File
27
- # systems using the `maxIO` performance mode can scale to higher
28
- # levels of aggregate throughput and operations per second with a
29
- # tradeoff of slightly higher latencies for most file operations. This
30
- # can't be changed after the file system has been created.
31
- # @return [String]
32
- class CreateFileSystemRequest < Struct.new(
33
- :creation_token,
34
- :performance_mode)
35
- include Aws::Structure
36
- end
37
-
38
- # @note When making an API call, pass CreateMountTargetRequest
39
- # data as a hash:
40
- #
41
- # {
42
- # file_system_id: "FileSystemId", # required
43
- # subnet_id: "SubnetId", # required
44
- # ip_address: "IpAddress",
45
- # security_groups: ["SecurityGroup"],
46
- # }
47
- # @!attribute [rw] file_system_id
48
- # ID of the file system for which to create the mount target.
49
- # @return [String]
50
- #
51
- # @!attribute [rw] subnet_id
52
- # ID of the subnet to add the mount target in.
53
- # @return [String]
54
- #
55
- # @!attribute [rw] ip_address
56
- # Valid IPv4 address within the address range of the specified subnet.
57
- # @return [String]
58
- #
59
- # @!attribute [rw] security_groups
60
- # Up to five VPC security group IDs, of the form `sg-xxxxxxxx`. These
61
- # must be for the same VPC as subnet specified.
62
- # @return [Array<String>]
63
- class CreateMountTargetRequest < Struct.new(
64
- :file_system_id,
65
- :subnet_id,
66
- :ip_address,
67
- :security_groups)
68
- include Aws::Structure
69
- end
11
+ # @note When making an API call, you may pass CreateFileSystemRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # creation_token: "CreationToken", # required
16
+ # performance_mode: "generalPurpose", # accepts generalPurpose, maxIO
17
+ # }
18
+ #
19
+ # @!attribute [rw] creation_token
20
+ # String of up to 64 ASCII characters. Amazon EFS uses this to ensure
21
+ # idempotent creation.
22
+ # @return [String]
23
+ #
24
+ # @!attribute [rw] performance_mode
25
+ # The `PerformanceMode` of the file system. We recommend
26
+ # `generalPurpose` performance mode for most file systems. File
27
+ # systems using the `maxIO` performance mode can scale to higher
28
+ # levels of aggregate throughput and operations per second with a
29
+ # tradeoff of slightly higher latencies for most file operations. This
30
+ # can't be changed after the file system has been created.
31
+ # @return [String]
32
+ #
33
+ class CreateFileSystemRequest < Struct.new(
34
+ :creation_token,
35
+ :performance_mode)
36
+ include Aws::Structure
37
+ end
70
38
 
71
- # @note When making an API call, pass CreateTagsRequest
72
- # data as a hash:
73
- #
74
- # {
75
- # file_system_id: "FileSystemId", # required
76
- # tags: [ # required
77
- # {
78
- # key: "TagKey", # required
79
- # value: "TagValue", # required
80
- # },
81
- # ],
82
- # }
83
- # @!attribute [rw] file_system_id
84
- # ID of the file system whose tags you want to modify (String). This
85
- # operation modifies the tags only, not the file system.
86
- # @return [String]
87
- #
88
- # @!attribute [rw] tags
89
- # Array of `Tag` objects to add. Each `Tag` object is a key-value
90
- # pair.
91
- # @return [Array<Types::Tag>]
92
- class CreateTagsRequest < Struct.new(
93
- :file_system_id,
94
- :tags)
95
- include Aws::Structure
96
- end
39
+ # @note When making an API call, you may pass CreateMountTargetRequest
40
+ # data as a hash:
41
+ #
42
+ # {
43
+ # file_system_id: "FileSystemId", # required
44
+ # subnet_id: "SubnetId", # required
45
+ # ip_address: "IpAddress",
46
+ # security_groups: ["SecurityGroup"],
47
+ # }
48
+ #
49
+ # @!attribute [rw] file_system_id
50
+ # ID of the file system for which to create the mount target.
51
+ # @return [String]
52
+ #
53
+ # @!attribute [rw] subnet_id
54
+ # ID of the subnet to add the mount target in.
55
+ # @return [String]
56
+ #
57
+ # @!attribute [rw] ip_address
58
+ # Valid IPv4 address within the address range of the specified subnet.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] security_groups
62
+ # Up to five VPC security group IDs, of the form `sg-xxxxxxxx`. These
63
+ # must be for the same VPC as subnet specified.
64
+ # @return [Array<String>]
65
+ #
66
+ class CreateMountTargetRequest < Struct.new(
67
+ :file_system_id,
68
+ :subnet_id,
69
+ :ip_address,
70
+ :security_groups)
71
+ include Aws::Structure
72
+ end
97
73
 
98
- # @note When making an API call, pass DeleteFileSystemRequest
99
- # data as a hash:
100
- #
101
- # {
102
- # file_system_id: "FileSystemId", # required
103
- # }
104
- # @!attribute [rw] file_system_id
105
- # ID of the file system you want to delete.
106
- # @return [String]
107
- class DeleteFileSystemRequest < Struct.new(
108
- :file_system_id)
109
- include Aws::Structure
110
- end
74
+ # @note When making an API call, you may pass CreateTagsRequest
75
+ # data as a hash:
76
+ #
77
+ # {
78
+ # file_system_id: "FileSystemId", # required
79
+ # tags: [ # required
80
+ # {
81
+ # key: "TagKey", # required
82
+ # value: "TagValue", # required
83
+ # },
84
+ # ],
85
+ # }
86
+ #
87
+ # @!attribute [rw] file_system_id
88
+ # ID of the file system whose tags you want to modify (String). This
89
+ # operation modifies the tags only, not the file system.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] tags
93
+ # Array of `Tag` objects to add. Each `Tag` object is a key-value
94
+ # pair.
95
+ # @return [Array<Types::Tag>]
96
+ #
97
+ class CreateTagsRequest < Struct.new(
98
+ :file_system_id,
99
+ :tags)
100
+ include Aws::Structure
101
+ end
111
102
 
112
- # @note When making an API call, pass DeleteMountTargetRequest
113
- # data as a hash:
114
- #
115
- # {
116
- # mount_target_id: "MountTargetId", # required
117
- # }
118
- # @!attribute [rw] mount_target_id
119
- # ID of the mount target to delete (String).
120
- # @return [String]
121
- class DeleteMountTargetRequest < Struct.new(
122
- :mount_target_id)
123
- include Aws::Structure
124
- end
103
+ # @note When making an API call, you may pass DeleteFileSystemRequest
104
+ # data as a hash:
105
+ #
106
+ # {
107
+ # file_system_id: "FileSystemId", # required
108
+ # }
109
+ #
110
+ # @!attribute [rw] file_system_id
111
+ # ID of the file system you want to delete.
112
+ # @return [String]
113
+ #
114
+ class DeleteFileSystemRequest < Struct.new(
115
+ :file_system_id)
116
+ include Aws::Structure
117
+ end
125
118
 
126
- # @note When making an API call, pass DeleteTagsRequest
127
- # data as a hash:
128
- #
129
- # {
130
- # file_system_id: "FileSystemId", # required
131
- # tag_keys: ["TagKey"], # required
132
- # }
133
- # @!attribute [rw] file_system_id
134
- # ID of the file system whose tags you want to delete (String).
135
- # @return [String]
136
- #
137
- # @!attribute [rw] tag_keys
138
- # List of tag keys to delete.
139
- # @return [Array<String>]
140
- class DeleteTagsRequest < Struct.new(
141
- :file_system_id,
142
- :tag_keys)
143
- include Aws::Structure
144
- end
119
+ # @note When making an API call, you may pass DeleteMountTargetRequest
120
+ # data as a hash:
121
+ #
122
+ # {
123
+ # mount_target_id: "MountTargetId", # required
124
+ # }
125
+ #
126
+ # @!attribute [rw] mount_target_id
127
+ # ID of the mount target to delete (String).
128
+ # @return [String]
129
+ #
130
+ class DeleteMountTargetRequest < Struct.new(
131
+ :mount_target_id)
132
+ include Aws::Structure
133
+ end
145
134
 
146
- # @note When making an API call, pass DescribeFileSystemsRequest
147
- # data as a hash:
148
- #
149
- # {
150
- # max_items: 1,
151
- # marker: "Marker",
152
- # creation_token: "CreationToken",
153
- # file_system_id: "FileSystemId",
154
- # }
155
- # @!attribute [rw] max_items
156
- # (Optional) Specifies the maximum number of file systems to return in
157
- # the response (integer). This parameter value must be greater than 0.
158
- # The number of items that Amazon EFS returns is the minimum of the
159
- # `MaxItems` parameter specified in the request and the service's
160
- # internal maximum number of items per page.
161
- # @return [Integer]
162
- #
163
- # @!attribute [rw] marker
164
- # (Optional) Opaque pagination token returned from a previous
165
- # `DescribeFileSystems` operation (String). If present, specifies to
166
- # continue the list from where the returning call had left off.
167
- # @return [String]
168
- #
169
- # @!attribute [rw] creation_token
170
- # (Optional) Restricts the list to the file system with this creation
171
- # token (String). You specify a creation token when you create an
172
- # Amazon EFS file system.
173
- # @return [String]
174
- #
175
- # @!attribute [rw] file_system_id
176
- # (Optional) ID of the file system whose description you want to
177
- # retrieve (String).
178
- # @return [String]
179
- class DescribeFileSystemsRequest < Struct.new(
180
- :max_items,
181
- :marker,
182
- :creation_token,
183
- :file_system_id)
184
- include Aws::Structure
185
- end
135
+ # @note When making an API call, you may pass DeleteTagsRequest
136
+ # data as a hash:
137
+ #
138
+ # {
139
+ # file_system_id: "FileSystemId", # required
140
+ # tag_keys: ["TagKey"], # required
141
+ # }
142
+ #
143
+ # @!attribute [rw] file_system_id
144
+ # ID of the file system whose tags you want to delete (String).
145
+ # @return [String]
146
+ #
147
+ # @!attribute [rw] tag_keys
148
+ # List of tag keys to delete.
149
+ # @return [Array<String>]
150
+ #
151
+ class DeleteTagsRequest < Struct.new(
152
+ :file_system_id,
153
+ :tag_keys)
154
+ include Aws::Structure
155
+ end
186
156
 
187
- # @!attribute [rw] marker
188
- # Present if provided by caller in the request (String).
189
- # @return [String]
190
- #
191
- # @!attribute [rw] file_systems
192
- # Array of file system descriptions.
193
- # @return [Array<Types::FileSystemDescription>]
194
- #
195
- # @!attribute [rw] next_marker
196
- # Present if there are more file systems than returned in the response
197
- # (String). You can use the `NextMarker` in the subsequent request to
198
- # fetch the descriptions.
199
- # @return [String]
200
- class DescribeFileSystemsResponse < Struct.new(
201
- :marker,
202
- :file_systems,
203
- :next_marker)
204
- include Aws::Structure
205
- end
157
+ # @note When making an API call, you may pass DescribeFileSystemsRequest
158
+ # data as a hash:
159
+ #
160
+ # {
161
+ # max_items: 1,
162
+ # marker: "Marker",
163
+ # creation_token: "CreationToken",
164
+ # file_system_id: "FileSystemId",
165
+ # }
166
+ #
167
+ # @!attribute [rw] max_items
168
+ # (Optional) Specifies the maximum number of file systems to return in
169
+ # the response (integer). This parameter value must be greater than 0.
170
+ # The number of items that Amazon EFS returns is the minimum of the
171
+ # `MaxItems` parameter specified in the request and the service's
172
+ # internal maximum number of items per page.
173
+ # @return [Integer]
174
+ #
175
+ # @!attribute [rw] marker
176
+ # (Optional) Opaque pagination token returned from a previous
177
+ # `DescribeFileSystems` operation (String). If present, specifies to
178
+ # continue the list from where the returning call had left off.
179
+ # @return [String]
180
+ #
181
+ # @!attribute [rw] creation_token
182
+ # (Optional) Restricts the list to the file system with this creation
183
+ # token (String). You specify a creation token when you create an
184
+ # Amazon EFS file system.
185
+ # @return [String]
186
+ #
187
+ # @!attribute [rw] file_system_id
188
+ # (Optional) ID of the file system whose description you want to
189
+ # retrieve (String).
190
+ # @return [String]
191
+ #
192
+ class DescribeFileSystemsRequest < Struct.new(
193
+ :max_items,
194
+ :marker,
195
+ :creation_token,
196
+ :file_system_id)
197
+ include Aws::Structure
198
+ end
206
199
 
207
- # @note When making an API call, pass DescribeMountTargetSecurityGroupsRequest
208
- # data as a hash:
209
- #
210
- # {
211
- # mount_target_id: "MountTargetId", # required
212
- # }
213
- # @!attribute [rw] mount_target_id
214
- # ID of the mount target whose security groups you want to retrieve.
215
- # @return [String]
216
- class DescribeMountTargetSecurityGroupsRequest < Struct.new(
217
- :mount_target_id)
218
- include Aws::Structure
219
- end
200
+ # @!attribute [rw] marker
201
+ # Present if provided by caller in the request (String).
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] file_systems
205
+ # Array of file system descriptions.
206
+ # @return [Array<Types::FileSystemDescription>]
207
+ #
208
+ # @!attribute [rw] next_marker
209
+ # Present if there are more file systems than returned in the response
210
+ # (String). You can use the `NextMarker` in the subsequent request to
211
+ # fetch the descriptions.
212
+ # @return [String]
213
+ #
214
+ class DescribeFileSystemsResponse < Struct.new(
215
+ :marker,
216
+ :file_systems,
217
+ :next_marker)
218
+ include Aws::Structure
219
+ end
220
220
 
221
- # @!attribute [rw] security_groups
222
- # Array of security groups.
223
- # @return [Array<String>]
224
- class DescribeMountTargetSecurityGroupsResponse < Struct.new(
225
- :security_groups)
226
- include Aws::Structure
227
- end
221
+ # @note When making an API call, you may pass DescribeMountTargetSecurityGroupsRequest
222
+ # data as a hash:
223
+ #
224
+ # {
225
+ # mount_target_id: "MountTargetId", # required
226
+ # }
227
+ #
228
+ # @!attribute [rw] mount_target_id
229
+ # ID of the mount target whose security groups you want to retrieve.
230
+ # @return [String]
231
+ #
232
+ class DescribeMountTargetSecurityGroupsRequest < Struct.new(
233
+ :mount_target_id)
234
+ include Aws::Structure
235
+ end
228
236
 
229
- # @note When making an API call, pass DescribeMountTargetsRequest
230
- # data as a hash:
231
- #
232
- # {
233
- # max_items: 1,
234
- # marker: "Marker",
235
- # file_system_id: "FileSystemId",
236
- # mount_target_id: "MountTargetId",
237
- # }
238
- # @!attribute [rw] max_items
239
- # (Optional) Maximum number of mount targets to return in the
240
- # response. It must be an integer with a value greater than zero.
241
- # @return [Integer]
242
- #
243
- # @!attribute [rw] marker
244
- # (Optional) Opaque pagination token returned from a previous
245
- # `DescribeMountTargets` operation (String). If present, it specifies
246
- # to continue the list from where the previous returning call left
247
- # off.
248
- # @return [String]
249
- #
250
- # @!attribute [rw] file_system_id
251
- # (Optional) ID of the file system whose mount targets you want to
252
- # list (String). It must be included in your request if
253
- # `MountTargetId` is not included.
254
- # @return [String]
255
- #
256
- # @!attribute [rw] mount_target_id
257
- # (Optional) ID of the mount target that you want to have described
258
- # (String). It must be included in your request if `FileSystemId` is
259
- # not included.
260
- # @return [String]
261
- class DescribeMountTargetsRequest < Struct.new(
262
- :max_items,
263
- :marker,
264
- :file_system_id,
265
- :mount_target_id)
266
- include Aws::Structure
267
- end
237
+ # @!attribute [rw] security_groups
238
+ # Array of security groups.
239
+ # @return [Array<String>]
240
+ #
241
+ class DescribeMountTargetSecurityGroupsResponse < Struct.new(
242
+ :security_groups)
243
+ include Aws::Structure
244
+ end
268
245
 
269
- # @!attribute [rw] marker
270
- # If the request included the `Marker`, the response returns that
271
- # value in this field.
272
- # @return [String]
273
- #
274
- # @!attribute [rw] mount_targets
275
- # Returns the file system's mount targets as an array of
276
- # `MountTargetDescription` objects.
277
- # @return [Array<Types::MountTargetDescription>]
278
- #
279
- # @!attribute [rw] next_marker
280
- # If a value is present, there are more mount targets to return. In a
281
- # subsequent request, you can provide `Marker` in your request with
282
- # this value to retrieve the next set of mount targets.
283
- # @return [String]
284
- class DescribeMountTargetsResponse < Struct.new(
285
- :marker,
286
- :mount_targets,
287
- :next_marker)
288
- include Aws::Structure
289
- end
246
+ # @note When making an API call, you may pass DescribeMountTargetsRequest
247
+ # data as a hash:
248
+ #
249
+ # {
250
+ # max_items: 1,
251
+ # marker: "Marker",
252
+ # file_system_id: "FileSystemId",
253
+ # mount_target_id: "MountTargetId",
254
+ # }
255
+ #
256
+ # @!attribute [rw] max_items
257
+ # (Optional) Maximum number of mount targets to return in the
258
+ # response. It must be an integer with a value greater than zero.
259
+ # @return [Integer]
260
+ #
261
+ # @!attribute [rw] marker
262
+ # (Optional) Opaque pagination token returned from a previous
263
+ # `DescribeMountTargets` operation (String). If present, it specifies
264
+ # to continue the list from where the previous returning call left
265
+ # off.
266
+ # @return [String]
267
+ #
268
+ # @!attribute [rw] file_system_id
269
+ # (Optional) ID of the file system whose mount targets you want to
270
+ # list (String). It must be included in your request if
271
+ # `MountTargetId` is not included.
272
+ # @return [String]
273
+ #
274
+ # @!attribute [rw] mount_target_id
275
+ # (Optional) ID of the mount target that you want to have described
276
+ # (String). It must be included in your request if `FileSystemId` is
277
+ # not included.
278
+ # @return [String]
279
+ #
280
+ class DescribeMountTargetsRequest < Struct.new(
281
+ :max_items,
282
+ :marker,
283
+ :file_system_id,
284
+ :mount_target_id)
285
+ include Aws::Structure
286
+ end
290
287
 
291
- # @note When making an API call, pass DescribeTagsRequest
292
- # data as a hash:
293
- #
294
- # {
295
- # max_items: 1,
296
- # marker: "Marker",
297
- # file_system_id: "FileSystemId", # required
298
- # }
299
- # @!attribute [rw] max_items
300
- # (Optional) Maximum number of file system tags to return in the
301
- # response. It must be an integer with a value greater than zero.
302
- # @return [Integer]
303
- #
304
- # @!attribute [rw] marker
305
- # (Optional) Opaque pagination token returned from a previous
306
- # `DescribeTags` operation (String). If present, it specifies to
307
- # continue the list from where the previous call left off.
308
- # @return [String]
309
- #
310
- # @!attribute [rw] file_system_id
311
- # ID of the file system whose tag set you want to retrieve.
312
- # @return [String]
313
- class DescribeTagsRequest < Struct.new(
314
- :max_items,
315
- :marker,
316
- :file_system_id)
317
- include Aws::Structure
318
- end
288
+ # @!attribute [rw] marker
289
+ # If the request included the `Marker`, the response returns that
290
+ # value in this field.
291
+ # @return [String]
292
+ #
293
+ # @!attribute [rw] mount_targets
294
+ # Returns the file system's mount targets as an array of
295
+ # `MountTargetDescription` objects.
296
+ # @return [Array<Types::MountTargetDescription>]
297
+ #
298
+ # @!attribute [rw] next_marker
299
+ # If a value is present, there are more mount targets to return. In a
300
+ # subsequent request, you can provide `Marker` in your request with
301
+ # this value to retrieve the next set of mount targets.
302
+ # @return [String]
303
+ #
304
+ class DescribeMountTargetsResponse < Struct.new(
305
+ :marker,
306
+ :mount_targets,
307
+ :next_marker)
308
+ include Aws::Structure
309
+ end
319
310
 
320
- # @!attribute [rw] marker
321
- # If the request included a `Marker`, the response returns that value
322
- # in this field.
323
- # @return [String]
324
- #
325
- # @!attribute [rw] tags
326
- # Returns tags associated with the file system as an array of `Tag`
327
- # objects.
328
- # @return [Array<Types::Tag>]
329
- #
330
- # @!attribute [rw] next_marker
331
- # If a value is present, there are more tags to return. In a
332
- # subsequent request, you can provide the value of `NextMarker` as the
333
- # value of the `Marker` parameter in your next request to retrieve the
334
- # next set of tags.
335
- # @return [String]
336
- class DescribeTagsResponse < Struct.new(
337
- :marker,
338
- :tags,
339
- :next_marker)
340
- include Aws::Structure
341
- end
311
+ # @note When making an API call, you may pass DescribeTagsRequest
312
+ # data as a hash:
313
+ #
314
+ # {
315
+ # max_items: 1,
316
+ # marker: "Marker",
317
+ # file_system_id: "FileSystemId", # required
318
+ # }
319
+ #
320
+ # @!attribute [rw] max_items
321
+ # (Optional) Maximum number of file system tags to return in the
322
+ # response. It must be an integer with a value greater than zero.
323
+ # @return [Integer]
324
+ #
325
+ # @!attribute [rw] marker
326
+ # (Optional) Opaque pagination token returned from a previous
327
+ # `DescribeTags` operation (String). If present, it specifies to
328
+ # continue the list from where the previous call left off.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] file_system_id
332
+ # ID of the file system whose tag set you want to retrieve.
333
+ # @return [String]
334
+ #
335
+ class DescribeTagsRequest < Struct.new(
336
+ :max_items,
337
+ :marker,
338
+ :file_system_id)
339
+ include Aws::Structure
340
+ end
342
341
 
343
- # Description of the file system.
344
- # @!attribute [rw] owner_id
345
- # AWS account that created the file system. If the file system was
346
- # created by an IAM user, the parent account to which the user belongs
347
- # is the owner.
348
- # @return [String]
349
- #
350
- # @!attribute [rw] creation_token
351
- # Opaque string specified in the request.
352
- # @return [String]
353
- #
354
- # @!attribute [rw] file_system_id
355
- # ID of the file system, assigned by Amazon EFS.
356
- # @return [String]
357
- #
358
- # @!attribute [rw] creation_time
359
- # Time that the file system was created, in seconds (since
360
- # 1970-01-01T00:00:00Z).
361
- # @return [Time]
362
- #
363
- # @!attribute [rw] life_cycle_state
364
- # Lifecycle phase of the file system.
365
- # @return [String]
366
- #
367
- # @!attribute [rw] name
368
- # You can add tags to a file system, including a `Name` tag. For more
369
- # information, see CreateTags. If the file system has a `Name` tag,
370
- # Amazon EFS returns the value in this field.
371
- # @return [String]
372
- #
373
- # @!attribute [rw] number_of_mount_targets
374
- # Current number of mount targets that the file system has. For more
375
- # information, see CreateMountTarget.
376
- # @return [Integer]
377
- #
378
- # @!attribute [rw] size_in_bytes
379
- # Latest known metered size (in bytes) of data stored in the file
380
- # system, in bytes, in its `Value` field, and the time at which that
381
- # size was determined in its `Timestamp` field. The `Timestamp` value
382
- # is the integer number of seconds since 1970-01-01T00:00:00Z. Note
383
- # that the value does not represent the size of a consistent snapshot
384
- # of the file system, but it is eventually consistent when there are
385
- # no writes to the file system. That is, the value will represent
386
- # actual size only if the file system is not modified for a period
387
- # longer than a couple of hours. Otherwise, the value is not the exact
388
- # size the file system was at any instant in time.
389
- # @return [Types::FileSystemSize]
390
- #
391
- # @!attribute [rw] performance_mode
392
- # The `PerformanceMode` of the file system.
393
- # @return [String]
394
- class FileSystemDescription < Struct.new(
395
- :owner_id,
396
- :creation_token,
397
- :file_system_id,
398
- :creation_time,
399
- :life_cycle_state,
400
- :name,
401
- :number_of_mount_targets,
402
- :size_in_bytes,
403
- :performance_mode)
404
- include Aws::Structure
405
- end
342
+ # @!attribute [rw] marker
343
+ # If the request included a `Marker`, the response returns that value
344
+ # in this field.
345
+ # @return [String]
346
+ #
347
+ # @!attribute [rw] tags
348
+ # Returns tags associated with the file system as an array of `Tag`
349
+ # objects.
350
+ # @return [Array<Types::Tag>]
351
+ #
352
+ # @!attribute [rw] next_marker
353
+ # If a value is present, there are more tags to return. In a
354
+ # subsequent request, you can provide the value of `NextMarker` as the
355
+ # value of the `Marker` parameter in your next request to retrieve the
356
+ # next set of tags.
357
+ # @return [String]
358
+ #
359
+ class DescribeTagsResponse < Struct.new(
360
+ :marker,
361
+ :tags,
362
+ :next_marker)
363
+ include Aws::Structure
364
+ end
406
365
 
407
- # Latest known metered size (in bytes) of data stored in the file
408
- # system, in its `Value` field, and the time at which that size was
409
- # determined in its `Timestamp` field. Note that the value does not
410
- # represent the size of a consistent snapshot of the file system, but it
411
- # is eventually consistent when there are no writes to the file system.
412
- # That is, the value will represent the actual size only if the file
413
- # system is not modified for a period longer than a couple of hours.
414
- # Otherwise, the value is not necessarily the exact size the file system
415
- # was at any instant in time.
416
- # @!attribute [rw] value
417
- # Latest known metered size (in bytes) of data stored in the file
418
- # system.
419
- # @return [Integer]
420
- #
421
- # @!attribute [rw] timestamp
422
- # Time at which the size of data, returned in the `Value` field, was
423
- # determined. The value is the integer number of seconds since
424
- # 1970-01-01T00:00:00Z.
425
- # @return [Time]
426
- class FileSystemSize < Struct.new(
427
- :value,
428
- :timestamp)
429
- include Aws::Structure
430
- end
366
+ # Description of the file system.
367
+ #
368
+ # @!attribute [rw] owner_id
369
+ # AWS account that created the file system. If the file system was
370
+ # created by an IAM user, the parent account to which the user belongs
371
+ # is the owner.
372
+ # @return [String]
373
+ #
374
+ # @!attribute [rw] creation_token
375
+ # Opaque string specified in the request.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] file_system_id
379
+ # ID of the file system, assigned by Amazon EFS.
380
+ # @return [String]
381
+ #
382
+ # @!attribute [rw] creation_time
383
+ # Time that the file system was created, in seconds (since
384
+ # 1970-01-01T00:00:00Z).
385
+ # @return [Time]
386
+ #
387
+ # @!attribute [rw] life_cycle_state
388
+ # Lifecycle phase of the file system.
389
+ # @return [String]
390
+ #
391
+ # @!attribute [rw] name
392
+ # You can add tags to a file system, including a `Name` tag. For more
393
+ # information, see CreateTags. If the file system has a `Name` tag,
394
+ # Amazon EFS returns the value in this field.
395
+ # @return [String]
396
+ #
397
+ # @!attribute [rw] number_of_mount_targets
398
+ # Current number of mount targets that the file system has. For more
399
+ # information, see CreateMountTarget.
400
+ # @return [Integer]
401
+ #
402
+ # @!attribute [rw] size_in_bytes
403
+ # Latest known metered size (in bytes) of data stored in the file
404
+ # system, in bytes, in its `Value` field, and the time at which that
405
+ # size was determined in its `Timestamp` field. The `Timestamp` value
406
+ # is the integer number of seconds since 1970-01-01T00:00:00Z. Note
407
+ # that the value does not represent the size of a consistent snapshot
408
+ # of the file system, but it is eventually consistent when there are
409
+ # no writes to the file system. That is, the value will represent
410
+ # actual size only if the file system is not modified for a period
411
+ # longer than a couple of hours. Otherwise, the value is not the exact
412
+ # size the file system was at any instant in time.
413
+ # @return [Types::FileSystemSize]
414
+ #
415
+ # @!attribute [rw] performance_mode
416
+ # The `PerformanceMode` of the file system.
417
+ # @return [String]
418
+ #
419
+ class FileSystemDescription < Struct.new(
420
+ :owner_id,
421
+ :creation_token,
422
+ :file_system_id,
423
+ :creation_time,
424
+ :life_cycle_state,
425
+ :name,
426
+ :number_of_mount_targets,
427
+ :size_in_bytes,
428
+ :performance_mode)
429
+ include Aws::Structure
430
+ end
431
431
 
432
- # @note When making an API call, pass ModifyMountTargetSecurityGroupsRequest
433
- # data as a hash:
434
- #
435
- # {
436
- # mount_target_id: "MountTargetId", # required
437
- # security_groups: ["SecurityGroup"],
438
- # }
439
- # @!attribute [rw] mount_target_id
440
- # ID of the mount target whose security groups you want to modify.
441
- # @return [String]
442
- #
443
- # @!attribute [rw] security_groups
444
- # Array of up to five VPC security group IDs.
445
- # @return [Array<String>]
446
- class ModifyMountTargetSecurityGroupsRequest < Struct.new(
447
- :mount_target_id,
448
- :security_groups)
449
- include Aws::Structure
450
- end
432
+ # Latest known metered size (in bytes) of data stored in the file
433
+ # system, in its `Value` field, and the time at which that size was
434
+ # determined in its `Timestamp` field. Note that the value does not
435
+ # represent the size of a consistent snapshot of the file system, but it
436
+ # is eventually consistent when there are no writes to the file system.
437
+ # That is, the value will represent the actual size only if the file
438
+ # system is not modified for a period longer than a couple of hours.
439
+ # Otherwise, the value is not necessarily the exact size the file system
440
+ # was at any instant in time.
441
+ #
442
+ # @!attribute [rw] value
443
+ # Latest known metered size (in bytes) of data stored in the file
444
+ # system.
445
+ # @return [Integer]
446
+ #
447
+ # @!attribute [rw] timestamp
448
+ # Time at which the size of data, returned in the `Value` field, was
449
+ # determined. The value is the integer number of seconds since
450
+ # 1970-01-01T00:00:00Z.
451
+ # @return [Time]
452
+ #
453
+ class FileSystemSize < Struct.new(
454
+ :value,
455
+ :timestamp)
456
+ include Aws::Structure
457
+ end
451
458
 
452
- # Provides a description of a mount target.
453
- # @!attribute [rw] owner_id
454
- # AWS account ID that owns the resource.
455
- # @return [String]
456
- #
457
- # @!attribute [rw] mount_target_id
458
- # System-assigned mount target ID.
459
- # @return [String]
460
- #
461
- # @!attribute [rw] file_system_id
462
- # ID of the file system for which the mount target is intended.
463
- # @return [String]
464
- #
465
- # @!attribute [rw] subnet_id
466
- # ID of the mount target's subnet.
467
- # @return [String]
468
- #
469
- # @!attribute [rw] life_cycle_state
470
- # Lifecycle state of the mount target.
471
- # @return [String]
472
- #
473
- # @!attribute [rw] ip_address
474
- # Address at which the file system may be mounted via the mount
475
- # target.
476
- # @return [String]
477
- #
478
- # @!attribute [rw] network_interface_id
479
- # ID of the network interface that Amazon EFS created when it created
480
- # the mount target.
481
- # @return [String]
482
- class MountTargetDescription < Struct.new(
483
- :owner_id,
484
- :mount_target_id,
485
- :file_system_id,
486
- :subnet_id,
487
- :life_cycle_state,
488
- :ip_address,
489
- :network_interface_id)
490
- include Aws::Structure
491
- end
459
+ # @note When making an API call, you may pass ModifyMountTargetSecurityGroupsRequest
460
+ # data as a hash:
461
+ #
462
+ # {
463
+ # mount_target_id: "MountTargetId", # required
464
+ # security_groups: ["SecurityGroup"],
465
+ # }
466
+ #
467
+ # @!attribute [rw] mount_target_id
468
+ # ID of the mount target whose security groups you want to modify.
469
+ # @return [String]
470
+ #
471
+ # @!attribute [rw] security_groups
472
+ # Array of up to five VPC security group IDs.
473
+ # @return [Array<String>]
474
+ #
475
+ class ModifyMountTargetSecurityGroupsRequest < Struct.new(
476
+ :mount_target_id,
477
+ :security_groups)
478
+ include Aws::Structure
479
+ end
492
480
 
493
- # A tag is a key-value pair. Allowed characters: letters, whitespace,
494
- # and numbers, representable in UTF-8, and the following characters:` +
495
- # - = . _ : /`
496
- # @note When making an API call, pass Tag
497
- # data as a hash:
498
- #
499
- # {
500
- # key: "TagKey", # required
501
- # value: "TagValue", # required
502
- # }
503
- # @!attribute [rw] key
504
- # Tag key (String). The key can't start with `aws:`.
505
- # @return [String]
506
- #
507
- # @!attribute [rw] value
508
- # Value of the tag key.
509
- # @return [String]
510
- class Tag < Struct.new(
511
- :key,
512
- :value)
513
- include Aws::Structure
514
- end
481
+ # Provides a description of a mount target.
482
+ #
483
+ # @!attribute [rw] owner_id
484
+ # AWS account ID that owns the resource.
485
+ # @return [String]
486
+ #
487
+ # @!attribute [rw] mount_target_id
488
+ # System-assigned mount target ID.
489
+ # @return [String]
490
+ #
491
+ # @!attribute [rw] file_system_id
492
+ # ID of the file system for which the mount target is intended.
493
+ # @return [String]
494
+ #
495
+ # @!attribute [rw] subnet_id
496
+ # ID of the mount target's subnet.
497
+ # @return [String]
498
+ #
499
+ # @!attribute [rw] life_cycle_state
500
+ # Lifecycle state of the mount target.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] ip_address
504
+ # Address at which the file system may be mounted via the mount
505
+ # target.
506
+ # @return [String]
507
+ #
508
+ # @!attribute [rw] network_interface_id
509
+ # ID of the network interface that Amazon EFS created when it created
510
+ # the mount target.
511
+ # @return [String]
512
+ #
513
+ class MountTargetDescription < Struct.new(
514
+ :owner_id,
515
+ :mount_target_id,
516
+ :file_system_id,
517
+ :subnet_id,
518
+ :life_cycle_state,
519
+ :ip_address,
520
+ :network_interface_id)
521
+ include Aws::Structure
522
+ end
515
523
 
524
+ # A tag is a key-value pair. Allowed characters: letters, whitespace,
525
+ # and numbers, representable in UTF-8, and the following characters:` +
526
+ # - = . _ : /`
527
+ #
528
+ # @note When making an API call, you may pass Tag
529
+ # data as a hash:
530
+ #
531
+ # {
532
+ # key: "TagKey", # required
533
+ # value: "TagValue", # required
534
+ # }
535
+ #
536
+ # @!attribute [rw] key
537
+ # Tag key (String). The key can't start with `aws:`.
538
+ # @return [String]
539
+ #
540
+ # @!attribute [rw] value
541
+ # Value of the tag key.
542
+ # @return [String]
543
+ #
544
+ class Tag < Struct.new(
545
+ :key,
546
+ :value)
547
+ include Aws::Structure
516
548
  end
549
+
517
550
  end
518
551
  end