aws-sdk-cloudhsmv2 1.19.0 → 1.24.1

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 56fa60b034e577eab2fb8df2c76c05263ba8dde1
4
- data.tar.gz: 6d6770bfcd937c741b84143e658ad72730860a04
2
+ SHA256:
3
+ metadata.gz: ae87867a0d230f2535c5941cd03e216dc77f54d39600233f75c379441591ad73
4
+ data.tar.gz: bb6be937050a88d4d0a7cbb367f7ce01794c4bce7e9ef054b5e5549be64bb94a
5
5
  SHA512:
6
- metadata.gz: aad334ac32736545b8e02c5fb96390cdb0b336f744a2bd58b6077c897a8898ab2e41e48699567c1795df69dad3b1f6b0402efd73e530ce9e6333cff3d3dd5c1e
7
- data.tar.gz: a9e6764425fd5b2894f1bce42c041402153837a82d532805067aff06603128110ae08f60393f3628b1f59ff9c2f6ade1b2a3373d77748dec194140efab5a054b
6
+ metadata.gz: e2797f25c3abd94405d5bdeb105b5b4a73d78c8a7329cbb6f1eb1574d28d3a59217256690d1d1ea0c87610cc288f4a21763598beefe7c00737cedb2085dcb4af
7
+ data.tar.gz: 6c0853144c6016e30e27eed90eae5131b1a13e45b37f8696bbc69547fd8b76a8eb1bd9fe812589efaead1b497f222bf218942556736d764df1c93cf5c142a933
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-cloudhsmv2/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # cloud_hsmv2 = Aws::CloudHSMV2::Client.new
28
+ # resp = cloud_hsmv2.copy_backup_to_region(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS CloudHSM V2 all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS CloudHSM V2 are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::CloudHSMV2::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS CloudHSM V2 API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-cloudhsmv2/customizations'
42
45
  # @service
43
46
  module Aws::CloudHSMV2
44
47
 
45
- GEM_VERSION = '1.19.0'
48
+ GEM_VERSION = '1.24.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:cloudhsmv2)
31
32
 
32
33
  module Aws::CloudHSMV2
34
+ # An API client for CloudHSMV2. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::CloudHSMV2::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::CloudHSMV2
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::CloudHSMV2
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::CloudHSMV2
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::CloudHSMV2
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::CloudHSMV2
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::CloudHSMV2
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::CloudHSMV2
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::CloudHSMV2
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::CloudHSMV2
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::CloudHSMV2
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -272,6 +328,8 @@ module Aws::CloudHSMV2
272
328
  # @option params [required, String] :backup_id
273
329
  # The ID of the backup that will be copied to the destination region.
274
330
  #
331
+ # @option params [Array<Types::Tag>] :tag_list
332
+ #
275
333
  # @return [Types::CopyBackupToRegionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
276
334
  #
277
335
  # * {Types::CopyBackupToRegionResponse#destination_backup #destination_backup} => Types::DestinationBackup
@@ -281,6 +339,12 @@ module Aws::CloudHSMV2
281
339
  # resp = client.copy_backup_to_region({
282
340
  # destination_region: "Region", # required
283
341
  # backup_id: "BackupId", # required
342
+ # tag_list: [
343
+ # {
344
+ # key: "TagKey", # required
345
+ # value: "TagValue", # required
346
+ # },
347
+ # ],
284
348
  # })
285
349
  #
286
350
  # @example Response structure
@@ -319,6 +383,8 @@ module Aws::CloudHSMV2
319
383
  # to restore the cluster from a backup instead of creating a new
320
384
  # cluster. To find the backup ID, use DescribeBackups.
321
385
  #
386
+ # @option params [Array<Types::Tag>] :tag_list
387
+ #
322
388
  # @return [Types::CreateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
323
389
  #
324
390
  # * {Types::CreateClusterResponse#cluster #cluster} => Types::Cluster
@@ -329,6 +395,12 @@ module Aws::CloudHSMV2
329
395
  # subnet_ids: ["SubnetId"], # required
330
396
  # hsm_type: "HsmType", # required
331
397
  # source_backup_id: "BackupId",
398
+ # tag_list: [
399
+ # {
400
+ # key: "TagKey", # required
401
+ # value: "TagValue", # required
402
+ # },
403
+ # ],
332
404
  # })
333
405
  #
334
406
  # @example Response structure
@@ -359,6 +431,9 @@ module Aws::CloudHSMV2
359
431
  # resp.cluster.certificates.aws_hardware_certificate #=> String
360
432
  # resp.cluster.certificates.manufacturer_hardware_certificate #=> String
361
433
  # resp.cluster.certificates.cluster_certificate #=> String
434
+ # resp.cluster.tag_list #=> Array
435
+ # resp.cluster.tag_list[0].key #=> String
436
+ # resp.cluster.tag_list[0].value #=> String
362
437
  #
363
438
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateCluster AWS API Documentation
364
439
  #
@@ -419,8 +494,8 @@ module Aws::CloudHSMV2
419
494
  end
420
495
 
421
496
  # Deletes a specified AWS CloudHSM backup. A backup can be restored up
422
- # to 7 days after the DeleteBackup request. For more information on
423
- # restoring a backup, see RestoreBackup
497
+ # to 7 days after the DeleteBackup request is made. For more information
498
+ # on restoring a backup, see RestoreBackup.
424
499
  #
425
500
  # @option params [required, String] :backup_id
426
501
  # The ID of the backup to be deleted. To find the ID of a backup, use
@@ -447,6 +522,9 @@ module Aws::CloudHSMV2
447
522
  # resp.backup.source_backup #=> String
448
523
  # resp.backup.source_cluster #=> String
449
524
  # resp.backup.delete_timestamp #=> Time
525
+ # resp.backup.tag_list #=> Array
526
+ # resp.backup.tag_list[0].key #=> String
527
+ # resp.backup.tag_list[0].value #=> String
450
528
  #
451
529
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteBackup AWS API Documentation
452
530
  #
@@ -504,6 +582,9 @@ module Aws::CloudHSMV2
504
582
  # resp.cluster.certificates.aws_hardware_certificate #=> String
505
583
  # resp.cluster.certificates.manufacturer_hardware_certificate #=> String
506
584
  # resp.cluster.certificates.cluster_certificate #=> String
585
+ # resp.cluster.tag_list #=> Array
586
+ # resp.cluster.tag_list[0].key #=> String
587
+ # resp.cluster.tag_list[0].value #=> String
507
588
  #
508
589
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteCluster AWS API Documentation
509
590
  #
@@ -595,12 +676,16 @@ module Aws::CloudHSMV2
595
676
  # specified state.
596
677
  #
597
678
  # @option params [Boolean] :sort_ascending
679
+ # Designates whether or not to sort the return backups by ascending
680
+ # chronological order of generation.
598
681
  #
599
682
  # @return [Types::DescribeBackupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
600
683
  #
601
684
  # * {Types::DescribeBackupsResponse#backups #backups} => Array&lt;Types::Backup&gt;
602
685
  # * {Types::DescribeBackupsResponse#next_token #next_token} => String
603
686
  #
687
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
688
+ #
604
689
  # @example Request syntax with placeholder values
605
690
  #
606
691
  # resp = client.describe_backups({
@@ -624,6 +709,9 @@ module Aws::CloudHSMV2
624
709
  # resp.backups[0].source_backup #=> String
625
710
  # resp.backups[0].source_cluster #=> String
626
711
  # resp.backups[0].delete_timestamp #=> Time
712
+ # resp.backups[0].tag_list #=> Array
713
+ # resp.backups[0].tag_list[0].key #=> String
714
+ # resp.backups[0].tag_list[0].value #=> String
627
715
  # resp.next_token #=> String
628
716
  #
629
717
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackups AWS API Documentation
@@ -671,6 +759,8 @@ module Aws::CloudHSMV2
671
759
  # * {Types::DescribeClustersResponse#clusters #clusters} => Array&lt;Types::Cluster&gt;
672
760
  # * {Types::DescribeClustersResponse#next_token #next_token} => String
673
761
  #
762
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
763
+ #
674
764
  # @example Request syntax with placeholder values
675
765
  #
676
766
  # resp = client.describe_clusters({
@@ -710,6 +800,9 @@ module Aws::CloudHSMV2
710
800
  # resp.clusters[0].certificates.aws_hardware_certificate #=> String
711
801
  # resp.clusters[0].certificates.manufacturer_hardware_certificate #=> String
712
802
  # resp.clusters[0].certificates.cluster_certificate #=> String
803
+ # resp.clusters[0].tag_list #=> Array
804
+ # resp.clusters[0].tag_list[0].key #=> String
805
+ # resp.clusters[0].tag_list[0].value #=> String
713
806
  # resp.next_token #=> String
714
807
  #
715
808
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClusters AWS API Documentation
@@ -738,11 +831,10 @@ module Aws::CloudHSMV2
738
831
  #
739
832
  # @option params [required, String] :trust_anchor
740
833
  # The issuing certificate of the issuing certificate authority (CA) that
741
- # issued (signed) the cluster certificate. This can be a root
742
- # (self-signed) certificate or a certificate chain that begins with the
743
- # certificate that issued the cluster certificate and ends with a root
744
- # certificate. The certificate or certificate chain must be in PEM
745
- # format and can contain a maximum of 5000 characters.
834
+ # issued (signed) the cluster certificate. You must use a self-signed
835
+ # certificate. The certificate used to sign the HSM CSR must be directly
836
+ # available, and thus must be the root certificate. The certificate must
837
+ # be in PEM format and can contain a maximum of 5000 characters.
746
838
  #
747
839
  # @return [Types::InitializeClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
748
840
  #
@@ -798,10 +890,12 @@ module Aws::CloudHSMV2
798
890
  # * {Types::ListTagsResponse#tag_list #tag_list} => Array&lt;Types::Tag&gt;
799
891
  # * {Types::ListTagsResponse#next_token #next_token} => String
800
892
  #
893
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
894
+ #
801
895
  # @example Request syntax with placeholder values
802
896
  #
803
897
  # resp = client.list_tags({
804
- # resource_id: "ClusterId", # required
898
+ # resource_id: "ResourceId", # required
805
899
  # next_token: "NextToken",
806
900
  # max_results: 1,
807
901
  # })
@@ -823,7 +917,7 @@ module Aws::CloudHSMV2
823
917
  end
824
918
 
825
919
  # Restores a specified AWS CloudHSM backup that is in the
826
- # `PENDING_DELETION` state. For more information on deleting a backup,
920
+ # `PENDING_DELETION` state. For mor information on deleting a backup,
827
921
  # see DeleteBackup.
828
922
  #
829
923
  # @option params [required, String] :backup_id
@@ -851,6 +945,9 @@ module Aws::CloudHSMV2
851
945
  # resp.backup.source_backup #=> String
852
946
  # resp.backup.source_cluster #=> String
853
947
  # resp.backup.delete_timestamp #=> Time
948
+ # resp.backup.tag_list #=> Array
949
+ # resp.backup.tag_list[0].key #=> String
950
+ # resp.backup.tag_list[0].value #=> String
854
951
  #
855
952
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/RestoreBackup AWS API Documentation
856
953
  #
@@ -876,7 +973,7 @@ module Aws::CloudHSMV2
876
973
  # @example Request syntax with placeholder values
877
974
  #
878
975
  # resp = client.tag_resource({
879
- # resource_id: "ClusterId", # required
976
+ # resource_id: "ResourceId", # required
880
977
  # tag_list: [ # required
881
978
  # {
882
979
  # key: "TagKey", # required
@@ -910,7 +1007,7 @@ module Aws::CloudHSMV2
910
1007
  # @example Request syntax with placeholder values
911
1008
  #
912
1009
  # resp = client.untag_resource({
913
- # resource_id: "ClusterId", # required
1010
+ # resource_id: "ResourceId", # required
914
1011
  # tag_key_list: ["TagKey"], # required
915
1012
  # })
916
1013
  #
@@ -936,7 +1033,7 @@ module Aws::CloudHSMV2
936
1033
  params: params,
937
1034
  config: config)
938
1035
  context[:gem_name] = 'aws-sdk-cloudhsmv2'
939
- context[:gem_version] = '1.19.0'
1036
+ context[:gem_version] = '1.24.1'
940
1037
  Seahorse::Client::Request.new(handlers, context)
941
1038
  end
942
1039
 
@@ -24,6 +24,7 @@ module Aws::CloudHSMV2
24
24
  CloudHsmInvalidRequestException = Shapes::StructureShape.new(name: 'CloudHsmInvalidRequestException')
25
25
  CloudHsmResourceNotFoundException = Shapes::StructureShape.new(name: 'CloudHsmResourceNotFoundException')
26
26
  CloudHsmServiceException = Shapes::StructureShape.new(name: 'CloudHsmServiceException')
27
+ CloudHsmTagException = Shapes::StructureShape.new(name: 'CloudHsmTagException')
27
28
  Cluster = Shapes::StructureShape.new(name: 'Cluster')
28
29
  ClusterId = Shapes::StringShape.new(name: 'ClusterId')
29
30
  ClusterState = Shapes::StringShape.new(name: 'ClusterState')
@@ -64,6 +65,7 @@ module Aws::CloudHSMV2
64
65
  NextToken = Shapes::StringShape.new(name: 'NextToken')
65
66
  PreCoPassword = Shapes::StringShape.new(name: 'PreCoPassword')
66
67
  Region = Shapes::StringShape.new(name: 'Region')
68
+ ResourceId = Shapes::StringShape.new(name: 'ResourceId')
67
69
  RestoreBackupRequest = Shapes::StructureShape.new(name: 'RestoreBackupRequest')
68
70
  RestoreBackupResponse = Shapes::StructureShape.new(name: 'RestoreBackupResponse')
69
71
  SecurityGroup = Shapes::StringShape.new(name: 'SecurityGroup')
@@ -94,6 +96,7 @@ module Aws::CloudHSMV2
94
96
  Backup.add_member(:source_backup, Shapes::ShapeRef.new(shape: BackupId, location_name: "SourceBackup"))
95
97
  Backup.add_member(:source_cluster, Shapes::ShapeRef.new(shape: ClusterId, location_name: "SourceCluster"))
96
98
  Backup.add_member(:delete_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "DeleteTimestamp"))
99
+ Backup.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList"))
97
100
  Backup.struct_class = Types::Backup
98
101
 
99
102
  Backups.member = Shapes::ShapeRef.new(shape: Backup)
@@ -120,6 +123,9 @@ module Aws::CloudHSMV2
120
123
  CloudHsmServiceException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "Message"))
121
124
  CloudHsmServiceException.struct_class = Types::CloudHsmServiceException
122
125
 
126
+ CloudHsmTagException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "Message"))
127
+ CloudHsmTagException.struct_class = Types::CloudHsmTagException
128
+
123
129
  Cluster.add_member(:backup_policy, Shapes::ShapeRef.new(shape: BackupPolicy, location_name: "BackupPolicy"))
124
130
  Cluster.add_member(:cluster_id, Shapes::ShapeRef.new(shape: ClusterId, location_name: "ClusterId"))
125
131
  Cluster.add_member(:create_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreateTimestamp"))
@@ -133,12 +139,14 @@ module Aws::CloudHSMV2
133
139
  Cluster.add_member(:subnet_mapping, Shapes::ShapeRef.new(shape: ExternalSubnetMapping, location_name: "SubnetMapping"))
134
140
  Cluster.add_member(:vpc_id, Shapes::ShapeRef.new(shape: VpcId, location_name: "VpcId"))
135
141
  Cluster.add_member(:certificates, Shapes::ShapeRef.new(shape: Certificates, location_name: "Certificates"))
142
+ Cluster.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList"))
136
143
  Cluster.struct_class = Types::Cluster
137
144
 
138
145
  Clusters.member = Shapes::ShapeRef.new(shape: Cluster)
139
146
 
140
147
  CopyBackupToRegionRequest.add_member(:destination_region, Shapes::ShapeRef.new(shape: Region, required: true, location_name: "DestinationRegion"))
141
148
  CopyBackupToRegionRequest.add_member(:backup_id, Shapes::ShapeRef.new(shape: BackupId, required: true, location_name: "BackupId"))
149
+ CopyBackupToRegionRequest.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList"))
142
150
  CopyBackupToRegionRequest.struct_class = Types::CopyBackupToRegionRequest
143
151
 
144
152
  CopyBackupToRegionResponse.add_member(:destination_backup, Shapes::ShapeRef.new(shape: DestinationBackup, location_name: "DestinationBackup"))
@@ -147,6 +155,7 @@ module Aws::CloudHSMV2
147
155
  CreateClusterRequest.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, required: true, location_name: "SubnetIds"))
148
156
  CreateClusterRequest.add_member(:hsm_type, Shapes::ShapeRef.new(shape: HsmType, required: true, location_name: "HsmType"))
149
157
  CreateClusterRequest.add_member(:source_backup_id, Shapes::ShapeRef.new(shape: BackupId, location_name: "SourceBackupId"))
158
+ CreateClusterRequest.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList"))
150
159
  CreateClusterRequest.struct_class = Types::CreateClusterRequest
151
160
 
152
161
  CreateClusterResponse.add_member(:cluster, Shapes::ShapeRef.new(shape: Cluster, location_name: "Cluster"))
@@ -233,7 +242,7 @@ module Aws::CloudHSMV2
233
242
  InitializeClusterResponse.add_member(:state_message, Shapes::ShapeRef.new(shape: StateMessage, location_name: "StateMessage"))
234
243
  InitializeClusterResponse.struct_class = Types::InitializeClusterResponse
235
244
 
236
- ListTagsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ClusterId, required: true, location_name: "ResourceId"))
245
+ ListTagsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "ResourceId"))
237
246
  ListTagsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
238
247
  ListTagsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxSize, location_name: "MaxResults"))
239
248
  ListTagsRequest.struct_class = Types::ListTagsRequest
@@ -260,13 +269,13 @@ module Aws::CloudHSMV2
260
269
 
261
270
  TagList.member = Shapes::ShapeRef.new(shape: Tag)
262
271
 
263
- TagResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ClusterId, required: true, location_name: "ResourceId"))
272
+ TagResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "ResourceId"))
264
273
  TagResourceRequest.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, required: true, location_name: "TagList"))
265
274
  TagResourceRequest.struct_class = Types::TagResourceRequest
266
275
 
267
276
  TagResourceResponse.struct_class = Types::TagResourceResponse
268
277
 
269
- UntagResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ClusterId, required: true, location_name: "ResourceId"))
278
+ UntagResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "ResourceId"))
270
279
  UntagResourceRequest.add_member(:tag_key_list, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location_name: "TagKeyList"))
271
280
  UntagResourceRequest.struct_class = Types::UntagResourceRequest
272
281
 
@@ -298,11 +307,12 @@ module Aws::CloudHSMV2
298
307
  o.http_request_uri = "/"
299
308
  o.input = Shapes::ShapeRef.new(shape: CopyBackupToRegionRequest)
300
309
  o.output = Shapes::ShapeRef.new(shape: CopyBackupToRegionResponse)
310
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
301
311
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
302
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
303
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
304
312
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
305
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
313
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
314
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
315
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmTagException)
306
316
  end)
307
317
 
308
318
  api.add_operation(:create_cluster, Seahorse::Model::Operation.new.tap do |o|
@@ -311,11 +321,12 @@ module Aws::CloudHSMV2
311
321
  o.http_request_uri = "/"
312
322
  o.input = Shapes::ShapeRef.new(shape: CreateClusterRequest)
313
323
  o.output = Shapes::ShapeRef.new(shape: CreateClusterResponse)
324
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
314
325
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
315
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
316
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
317
326
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
318
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
327
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
328
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
329
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmTagException)
319
330
  end)
320
331
 
321
332
  api.add_operation(:create_hsm, Seahorse::Model::Operation.new.tap do |o|
@@ -337,11 +348,11 @@ module Aws::CloudHSMV2
337
348
  o.http_request_uri = "/"
338
349
  o.input = Shapes::ShapeRef.new(shape: DeleteBackupRequest)
339
350
  o.output = Shapes::ShapeRef.new(shape: DeleteBackupResponse)
351
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
340
352
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
341
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
342
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
343
353
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
344
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
354
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
355
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
345
356
  end)
346
357
 
347
358
  api.add_operation(:delete_cluster, Seahorse::Model::Operation.new.tap do |o|
@@ -350,11 +361,12 @@ module Aws::CloudHSMV2
350
361
  o.http_request_uri = "/"
351
362
  o.input = Shapes::ShapeRef.new(shape: DeleteClusterRequest)
352
363
  o.output = Shapes::ShapeRef.new(shape: DeleteClusterResponse)
364
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
353
365
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
354
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
355
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
356
366
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
357
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
367
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
368
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
369
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmTagException)
358
370
  end)
359
371
 
360
372
  api.add_operation(:delete_hsm, Seahorse::Model::Operation.new.tap do |o|
@@ -376,11 +388,12 @@ module Aws::CloudHSMV2
376
388
  o.http_request_uri = "/"
377
389
  o.input = Shapes::ShapeRef.new(shape: DescribeBackupsRequest)
378
390
  o.output = Shapes::ShapeRef.new(shape: DescribeBackupsResponse)
391
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
379
392
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
380
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
381
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
382
393
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
383
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
394
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
395
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
396
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmTagException)
384
397
  o[:pager] = Aws::Pager.new(
385
398
  limit_key: "max_results",
386
399
  tokens: {
@@ -395,10 +408,11 @@ module Aws::CloudHSMV2
395
408
  o.http_request_uri = "/"
396
409
  o.input = Shapes::ShapeRef.new(shape: DescribeClustersRequest)
397
410
  o.output = Shapes::ShapeRef.new(shape: DescribeClustersResponse)
411
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
398
412
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
399
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
400
413
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
401
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
414
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
415
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmTagException)
402
416
  o[:pager] = Aws::Pager.new(
403
417
  limit_key: "max_results",
404
418
  tokens: {
@@ -413,11 +427,11 @@ module Aws::CloudHSMV2
413
427
  o.http_request_uri = "/"
414
428
  o.input = Shapes::ShapeRef.new(shape: InitializeClusterRequest)
415
429
  o.output = Shapes::ShapeRef.new(shape: InitializeClusterResponse)
430
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
416
431
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
417
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
418
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
419
432
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
420
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
433
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
434
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
421
435
  end)
422
436
 
423
437
  api.add_operation(:list_tags, Seahorse::Model::Operation.new.tap do |o|
@@ -426,11 +440,12 @@ module Aws::CloudHSMV2
426
440
  o.http_request_uri = "/"
427
441
  o.input = Shapes::ShapeRef.new(shape: ListTagsRequest)
428
442
  o.output = Shapes::ShapeRef.new(shape: ListTagsResponse)
443
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
429
444
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
430
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
431
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
432
445
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
433
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
446
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
447
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
448
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmTagException)
434
449
  o[:pager] = Aws::Pager.new(
435
450
  limit_key: "max_results",
436
451
  tokens: {
@@ -445,11 +460,11 @@ module Aws::CloudHSMV2
445
460
  o.http_request_uri = "/"
446
461
  o.input = Shapes::ShapeRef.new(shape: RestoreBackupRequest)
447
462
  o.output = Shapes::ShapeRef.new(shape: RestoreBackupResponse)
463
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
448
464
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
449
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
450
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
451
465
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
452
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
466
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
467
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
453
468
  end)
454
469
 
455
470
  api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
@@ -458,11 +473,12 @@ module Aws::CloudHSMV2
458
473
  o.http_request_uri = "/"
459
474
  o.input = Shapes::ShapeRef.new(shape: TagResourceRequest)
460
475
  o.output = Shapes::ShapeRef.new(shape: TagResourceResponse)
476
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
461
477
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
462
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
463
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
464
478
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
465
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
479
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
480
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
481
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmTagException)
466
482
  end)
467
483
 
468
484
  api.add_operation(:untag_resource, Seahorse::Model::Operation.new.tap do |o|
@@ -471,11 +487,12 @@ module Aws::CloudHSMV2
471
487
  o.http_request_uri = "/"
472
488
  o.input = Shapes::ShapeRef.new(shape: UntagResourceRequest)
473
489
  o.output = Shapes::ShapeRef.new(shape: UntagResourceResponse)
490
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
474
491
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInternalFailureException)
475
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
476
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
477
492
  o.errors << Shapes::ShapeRef.new(shape: CloudHsmInvalidRequestException)
478
- o.errors << Shapes::ShapeRef.new(shape: CloudHsmAccessDeniedException)
493
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmResourceNotFoundException)
494
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmServiceException)
495
+ o.errors << Shapes::ShapeRef.new(shape: CloudHsmTagException)
479
496
  end)
480
497
  end
481
498
 
@@ -6,6 +6,34 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CloudHSMV2
9
+
10
+ # When CloudHSMV2 returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::CloudHSMV2::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all CloudHSMV2 errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::CloudHSMV2::Errors::ServiceError
18
+ # # rescues all CloudHSMV2 API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {CloudHsmAccessDeniedException}
29
+ # * {CloudHsmInternalFailureException}
30
+ # * {CloudHsmInvalidRequestException}
31
+ # * {CloudHsmResourceNotFoundException}
32
+ # * {CloudHsmServiceException}
33
+ # * {CloudHsmTagException}
34
+ #
35
+ # Additionally, error classes are dynamically generated for service errors based on the error code
36
+ # if they are not defined above.
9
37
  module Errors
10
38
 
11
39
  extend Aws::Errors::DynamicErrors
@@ -23,7 +51,6 @@ module Aws::CloudHSMV2
23
51
  def message
24
52
  @message || @data[:message]
25
53
  end
26
-
27
54
  end
28
55
 
29
56
  class CloudHsmInternalFailureException < ServiceError
@@ -39,7 +66,6 @@ module Aws::CloudHSMV2
39
66
  def message
40
67
  @message || @data[:message]
41
68
  end
42
-
43
69
  end
44
70
 
45
71
  class CloudHsmInvalidRequestException < ServiceError
@@ -55,7 +81,6 @@ module Aws::CloudHSMV2
55
81
  def message
56
82
  @message || @data[:message]
57
83
  end
58
-
59
84
  end
60
85
 
61
86
  class CloudHsmResourceNotFoundException < ServiceError
@@ -71,7 +96,6 @@ module Aws::CloudHSMV2
71
96
  def message
72
97
  @message || @data[:message]
73
98
  end
74
-
75
99
  end
76
100
 
77
101
  class CloudHsmServiceException < ServiceError
@@ -87,7 +111,21 @@ module Aws::CloudHSMV2
87
111
  def message
88
112
  @message || @data[:message]
89
113
  end
114
+ end
115
+
116
+ class CloudHsmTagException < ServiceError
90
117
 
118
+ # @param [Seahorse::Client::RequestContext] context
119
+ # @param [String] message
120
+ # @param [Aws::CloudHSMV2::Types::CloudHsmTagException] data
121
+ def initialize(context, message, data = Aws::EmptyStructure.new)
122
+ super(context, message, data)
123
+ end
124
+
125
+ # @return [String]
126
+ def message
127
+ @message || @data[:message]
128
+ end
91
129
  end
92
130
 
93
131
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CloudHSMV2
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -8,7 +8,12 @@
8
8
  module Aws::CloudHSMV2
9
9
  module Types
10
10
 
11
- # Contains information about a backup of an AWS CloudHSM cluster.
11
+ # Contains information about a backup of an AWS CloudHSM cluster. All
12
+ # backup objects contain the BackupId, BackupState, ClusterId, and
13
+ # CreateTimestamp parameters. Backups that were copied into a
14
+ # destination region additionally contain the CopyTimestamp,
15
+ # SourceBackup, SourceCluster, and SourceRegion paramters. A backup that
16
+ # is pending deletion will include the DeleteTimestamp parameter.
12
17
  #
13
18
  # @!attribute [rw] backup_id
14
19
  # The identifier (ID) of the backup.
@@ -27,21 +32,31 @@ module Aws::CloudHSMV2
27
32
  # @return [Time]
28
33
  #
29
34
  # @!attribute [rw] copy_timestamp
35
+ # The date and time when the backup was copied from a source backup.
30
36
  # @return [Time]
31
37
  #
32
38
  # @!attribute [rw] source_region
39
+ # The AWS region that contains the source backup from which the new
40
+ # backup was copied.
33
41
  # @return [String]
34
42
  #
35
43
  # @!attribute [rw] source_backup
44
+ # The identifier (ID) of the source backup from which the new backup
45
+ # was copied.
36
46
  # @return [String]
37
47
  #
38
48
  # @!attribute [rw] source_cluster
49
+ # The identifier (ID) of the cluster containing the source backup from
50
+ # which the new backup was copied. .
39
51
  # @return [String]
40
52
  #
41
53
  # @!attribute [rw] delete_timestamp
42
54
  # The date and time when the backup will be permanently deleted.
43
55
  # @return [Time]
44
56
  #
57
+ # @!attribute [rw] tag_list
58
+ # @return [Array<Types::Tag>]
59
+ #
45
60
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Backup AWS API Documentation
46
61
  #
47
62
  class Backup < Struct.new(
@@ -53,7 +68,8 @@ module Aws::CloudHSMV2
53
68
  :source_region,
54
69
  :source_backup,
55
70
  :source_cluster,
56
- :delete_timestamp)
71
+ :delete_timestamp,
72
+ :tag_list)
57
73
  include Aws::Structure
58
74
  end
59
75
 
@@ -157,6 +173,16 @@ module Aws::CloudHSMV2
157
173
  include Aws::Structure
158
174
  end
159
175
 
176
+ # @!attribute [rw] message
177
+ # @return [String]
178
+ #
179
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CloudHsmTagException AWS API Documentation
180
+ #
181
+ class CloudHsmTagException < Struct.new(
182
+ :message)
183
+ include Aws::Structure
184
+ end
185
+
160
186
  # Contains information about an AWS CloudHSM cluster.
161
187
  #
162
188
  # @!attribute [rw] backup_policy
@@ -202,8 +228,8 @@ module Aws::CloudHSMV2
202
228
  # @return [String]
203
229
  #
204
230
  # @!attribute [rw] subnet_mapping
205
- # A map of the cluster's subnets and their corresponding Availability
206
- # Zones.
231
+ # A map from availability zone to the clusters subnet in that
232
+ # availability zone.
207
233
  # @return [Hash<String,String>]
208
234
  #
209
235
  # @!attribute [rw] vpc_id
@@ -216,6 +242,9 @@ module Aws::CloudHSMV2
216
242
  # (CSR).
217
243
  # @return [Types::Certificates]
218
244
  #
245
+ # @!attribute [rw] tag_list
246
+ # @return [Array<Types::Tag>]
247
+ #
219
248
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Cluster AWS API Documentation
220
249
  #
221
250
  class Cluster < Struct.new(
@@ -231,7 +260,8 @@ module Aws::CloudHSMV2
231
260
  :state_message,
232
261
  :subnet_mapping,
233
262
  :vpc_id,
234
- :certificates)
263
+ :certificates,
264
+ :tag_list)
235
265
  include Aws::Structure
236
266
  end
237
267
 
@@ -241,6 +271,12 @@ module Aws::CloudHSMV2
241
271
  # {
242
272
  # destination_region: "Region", # required
243
273
  # backup_id: "BackupId", # required
274
+ # tag_list: [
275
+ # {
276
+ # key: "TagKey", # required
277
+ # value: "TagValue", # required
278
+ # },
279
+ # ],
244
280
  # }
245
281
  #
246
282
  # @!attribute [rw] destination_region
@@ -252,11 +288,15 @@ module Aws::CloudHSMV2
252
288
  # The ID of the backup that will be copied to the destination region.
253
289
  # @return [String]
254
290
  #
291
+ # @!attribute [rw] tag_list
292
+ # @return [Array<Types::Tag>]
293
+ #
255
294
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CopyBackupToRegionRequest AWS API Documentation
256
295
  #
257
296
  class CopyBackupToRegionRequest < Struct.new(
258
297
  :destination_region,
259
- :backup_id)
298
+ :backup_id,
299
+ :tag_list)
260
300
  include Aws::Structure
261
301
  end
262
302
 
@@ -285,6 +325,12 @@ module Aws::CloudHSMV2
285
325
  # subnet_ids: ["SubnetId"], # required
286
326
  # hsm_type: "HsmType", # required
287
327
  # source_backup_id: "BackupId",
328
+ # tag_list: [
329
+ # {
330
+ # key: "TagKey", # required
331
+ # value: "TagValue", # required
332
+ # },
333
+ # ],
288
334
  # }
289
335
  #
290
336
  # @!attribute [rw] subnet_ids
@@ -308,12 +354,16 @@ module Aws::CloudHSMV2
308
354
  # cluster. To find the backup ID, use DescribeBackups.
309
355
  # @return [String]
310
356
  #
357
+ # @!attribute [rw] tag_list
358
+ # @return [Array<Types::Tag>]
359
+ #
311
360
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateClusterRequest AWS API Documentation
312
361
  #
313
362
  class CreateClusterRequest < Struct.new(
314
363
  :subnet_ids,
315
364
  :hsm_type,
316
- :source_backup_id)
365
+ :source_backup_id,
366
+ :tag_list)
317
367
  include Aws::Structure
318
368
  end
319
369
 
@@ -526,6 +576,8 @@ module Aws::CloudHSMV2
526
576
  # @return [Hash<String,Array<String>>]
527
577
  #
528
578
  # @!attribute [rw] sort_ascending
579
+ # Designates whether or not to sort the return backups by ascending
580
+ # chronological order of generation.
529
581
  # @return [Boolean]
530
582
  #
531
583
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackupsRequest AWS API Documentation
@@ -619,16 +671,26 @@ module Aws::CloudHSMV2
619
671
  include Aws::Structure
620
672
  end
621
673
 
674
+ # Contains information about the backup that will be copied and created
675
+ # by the CopyBackupToRegion operation.
676
+ #
622
677
  # @!attribute [rw] create_timestamp
678
+ # The date and time when both the source backup was created.
623
679
  # @return [Time]
624
680
  #
625
681
  # @!attribute [rw] source_region
682
+ # The AWS region that contains the source backup from which the new
683
+ # backup was copied.
626
684
  # @return [String]
627
685
  #
628
686
  # @!attribute [rw] source_backup
687
+ # The identifier (ID) of the source backup from which the new backup
688
+ # was copied.
629
689
  # @return [String]
630
690
  #
631
691
  # @!attribute [rw] source_cluster
692
+ # The identifier (ID) of the cluster containing the source backup from
693
+ # which the new backup was copied.
632
694
  # @return [String]
633
695
  #
634
696
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DestinationBackup AWS API Documentation
@@ -712,11 +774,11 @@ module Aws::CloudHSMV2
712
774
  #
713
775
  # @!attribute [rw] trust_anchor
714
776
  # The issuing certificate of the issuing certificate authority (CA)
715
- # that issued (signed) the cluster certificate. This can be a root
716
- # (self-signed) certificate or a certificate chain that begins with
717
- # the certificate that issued the cluster certificate and ends with a
718
- # root certificate. The certificate or certificate chain must be in
719
- # PEM format and can contain a maximum of 5000 characters.
777
+ # that issued (signed) the cluster certificate. You must use a
778
+ # self-signed certificate. The certificate used to sign the HSM CSR
779
+ # must be directly available, and thus must be the root certificate.
780
+ # The certificate must be in PEM format and can contain a maximum of
781
+ # 5000 characters.
720
782
  # @return [String]
721
783
  #
722
784
  # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeClusterRequest AWS API Documentation
@@ -748,7 +810,7 @@ module Aws::CloudHSMV2
748
810
  # data as a hash:
749
811
  #
750
812
  # {
751
- # resource_id: "ClusterId", # required
813
+ # resource_id: "ResourceId", # required
752
814
  # next_token: "NextToken",
753
815
  # max_results: 1,
754
816
  # }
@@ -856,7 +918,7 @@ module Aws::CloudHSMV2
856
918
  # data as a hash:
857
919
  #
858
920
  # {
859
- # resource_id: "ClusterId", # required
921
+ # resource_id: "ResourceId", # required
860
922
  # tag_list: [ # required
861
923
  # {
862
924
  # key: "TagKey", # required
@@ -890,7 +952,7 @@ module Aws::CloudHSMV2
890
952
  # data as a hash:
891
953
  #
892
954
  # {
893
- # resource_id: "ClusterId", # required
955
+ # resource_id: "ResourceId", # required
894
956
  # tag_key_list: ["TagKey"], # required
895
957
  # }
896
958
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cloudhsmv2
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.19.0
4
+ version: 1.24.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-10-23 00:00:00.000000000 Z
11
+ date: 2020-06-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.71.0
22
+ version: 3.99.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.71.0
32
+ version: 3.99.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - CloudHSM V2