aws-sdk-rekognition 1.35.0 → 1.36.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 514bc86c1903620e2d258dffacb5941df5161419
4
- data.tar.gz: c31c7c73c983110607191ded3b24d42aa0f836ab
3
+ metadata.gz: 3e311d97087916fcd329fbcee66c473a75e1d6d9
4
+ data.tar.gz: 2095897d4be2505cc607369e18661df59bcc41b2
5
5
  SHA512:
6
- metadata.gz: 61594bbf3f3f369ae31d5b02edd99135ebe2ba510646c5bbfd72e49a9e5022ddce2cac777e285368e02aef64829cba3407bf49ed88493ca863ec13767f479f78
7
- data.tar.gz: 0a5762441557512743ab9eb93b3953743db65aedafd908d5936ccf6376f568d59849ceda6cb567ac5b91a10feaeb6e52cb1b4957ac0fbad7ac21bf71d8162317
6
+ metadata.gz: 9b056c8b75499af12dc4463c9aa77ef490946b99a979af2a3590140543b79a457e935b8593be1fc997daee2341ead51ea2c07d3121df655595926104ca40f4d6
7
+ data.tar.gz: 40911f91e76fd4ee8dfcadce8e31862e80151e9ab69445fc66b6c70c1692b5a5cf70d45925717a70dc86d42d4c90fc660834b20013190f138555efe85953b48f
@@ -46,6 +46,6 @@ require_relative 'aws-sdk-rekognition/customizations'
46
46
  # @service
47
47
  module Aws::Rekognition
48
48
 
49
- GEM_VERSION = '1.35.0'
49
+ GEM_VERSION = '1.36.0'
50
50
 
51
51
  end
@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:rekognition)
32
32
  module Aws::Rekognition
33
33
  # An API client for Rekognition. To construct a client, you need to configure a `:region` and `:credentials`.
34
34
  #
35
- # client = Aws::Rekognition::Client.new(
36
- # region: region_name,
37
- # credentials: credentials,
38
- # # ...
39
- # )
35
+ # client = Aws::Rekognition::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
40
  #
41
41
  # For details on configuring region and credentials see
42
42
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -229,15 +229,19 @@ module Aws::Rekognition
229
229
  #
230
230
  # @option options [String] :retry_mode ("legacy")
231
231
  # Specifies which retry algorithm to use. Values are:
232
- # * `legacy` - The pre-existing retry behavior. This is default value if
233
- # no retry mode is provided.
234
- # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
- # This includes support for retry quotas, which limit the number of
236
- # unsuccessful retries a client can make.
237
- # * `adaptive` - An experimental retry mode that includes all the
238
- # functionality of `standard` mode along with automatic client side
239
- # throttling. This is a provisional mode that may change behavior
240
- # in the future.
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
241
245
  #
242
246
  # @option options [String] :secret_access_key
243
247
  #
@@ -275,8 +279,7 @@ module Aws::Rekognition
275
279
  #
276
280
  # @option options [Integer] :http_read_timeout (60) The default
277
281
  # number of seconds to wait for response data. This value can
278
- # safely be set
279
- # per-request on the session yielded by {#session_for}.
282
+ # safely be set per-request on the session.
280
283
  #
281
284
  # @option options [Float] :http_idle_timeout (5) The number of
282
285
  # seconds a connection is allowed to sit idle before it is
@@ -288,7 +291,7 @@ module Aws::Rekognition
288
291
  # request body. This option has no effect unless the request has
289
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
290
293
  # disables this behaviour. This value can safely be set per
291
- # request on the session yielded by {#session_for}.
294
+ # request on the session.
292
295
  #
293
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
294
297
  # HTTP debug output will be sent to the `:logger`.
@@ -905,6 +908,73 @@ module Aws::Rekognition
905
908
  req.send_request(options)
906
909
  end
907
910
 
911
+ # Deletes an Amazon Rekognition Custom Labels project. To delete a
912
+ # project you must first delete all versions of the model associated
913
+ # with the project. To delete a version of a model, see
914
+ # DeleteProjectVersion.
915
+ #
916
+ # This operation requires permissions to perform the
917
+ # `rekognition:DeleteProject` action.
918
+ #
919
+ # @option params [required, String] :project_arn
920
+ # The Amazon Resource Name (ARN) of the project that you want to delete.
921
+ #
922
+ # @return [Types::DeleteProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
923
+ #
924
+ # * {Types::DeleteProjectResponse#status #status} => String
925
+ #
926
+ # @example Request syntax with placeholder values
927
+ #
928
+ # resp = client.delete_project({
929
+ # project_arn: "ProjectArn", # required
930
+ # })
931
+ #
932
+ # @example Response structure
933
+ #
934
+ # resp.status #=> String, one of "CREATING", "CREATED", "DELETING"
935
+ #
936
+ # @overload delete_project(params = {})
937
+ # @param [Hash] params ({})
938
+ def delete_project(params = {}, options = {})
939
+ req = build_request(:delete_project, params)
940
+ req.send_request(options)
941
+ end
942
+
943
+ # Deletes a version of a model.
944
+ #
945
+ # You must first stop the model before you can delete it. To check if a
946
+ # model is running, use the `Status` field returned from
947
+ # DescribeProjectVersions. To stop a running model call
948
+ # StopProjectVersion.
949
+ #
950
+ # This operation requires permissions to perform the
951
+ # `rekognition:DeleteProjectVersion` action.
952
+ #
953
+ # @option params [required, String] :project_version_arn
954
+ # The Amazon Resource Name (ARN) of the model version that you want to
955
+ # delete.
956
+ #
957
+ # @return [Types::DeleteProjectVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
958
+ #
959
+ # * {Types::DeleteProjectVersionResponse#status #status} => String
960
+ #
961
+ # @example Request syntax with placeholder values
962
+ #
963
+ # resp = client.delete_project_version({
964
+ # project_version_arn: "ProjectVersionArn", # required
965
+ # })
966
+ #
967
+ # @example Response structure
968
+ #
969
+ # resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING"
970
+ #
971
+ # @overload delete_project_version(params = {})
972
+ # @param [Hash] params ({})
973
+ def delete_project_version(params = {}, options = {})
974
+ req = build_request(:delete_project_version, params)
975
+ req.send_request(options)
976
+ end
977
+
908
978
  # Deletes the stream processor identified by `Name`. You assign the
909
979
  # value for `Name` when you create the stream processor with
910
980
  # CreateStreamProcessor. You might not be able to use the same name for
@@ -1001,6 +1071,8 @@ module Aws::Rekognition
1001
1071
  # * {Types::DescribeProjectVersionsResponse#project_version_descriptions #project_version_descriptions} => Array<Types::ProjectVersionDescription>
1002
1072
  # * {Types::DescribeProjectVersionsResponse#next_token #next_token} => String
1003
1073
  #
1074
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1075
+ #
1004
1076
  # @example Request syntax with placeholder values
1005
1077
  #
1006
1078
  # resp = client.describe_project_versions({
@@ -1046,6 +1118,12 @@ module Aws::Rekognition
1046
1118
  # resp.project_version_descriptions[0].evaluation_result.summary.s3_object.version #=> String
1047
1119
  # resp.next_token #=> String
1048
1120
  #
1121
+ #
1122
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
1123
+ #
1124
+ # * project_version_running
1125
+ # * project_version_training_completed
1126
+ #
1049
1127
  # @overload describe_project_versions(params = {})
1050
1128
  # @param [Hash] params ({})
1051
1129
  def describe_project_versions(params = {}, options = {})
@@ -1076,6 +1154,8 @@ module Aws::Rekognition
1076
1154
  # * {Types::DescribeProjectsResponse#project_descriptions #project_descriptions} => Array<Types::ProjectDescription>
1077
1155
  # * {Types::DescribeProjectsResponse#next_token #next_token} => String
1078
1156
  #
1157
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1158
+ #
1079
1159
  # @example Request syntax with placeholder values
1080
1160
  #
1081
1161
  # resp = client.describe_projects({
@@ -1937,6 +2017,8 @@ module Aws::Rekognition
1937
2017
  # * {Types::GetCelebrityRecognitionResponse#next_token #next_token} => String
1938
2018
  # * {Types::GetCelebrityRecognitionResponse#celebrities #celebrities} => Array<Types::CelebrityRecognition>
1939
2019
  #
2020
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2021
+ #
1940
2022
  # @example Request syntax with placeholder values
1941
2023
  #
1942
2024
  # resp = client.get_celebrity_recognition({
@@ -2080,6 +2162,8 @@ module Aws::Rekognition
2080
2162
  # * {Types::GetContentModerationResponse#next_token #next_token} => String
2081
2163
  # * {Types::GetContentModerationResponse#moderation_model_version #moderation_model_version} => String
2082
2164
  #
2165
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2166
+ #
2083
2167
  # @example Request syntax with placeholder values
2084
2168
  #
2085
2169
  # resp = client.get_content_moderation({
@@ -2162,6 +2246,8 @@ module Aws::Rekognition
2162
2246
  # * {Types::GetFaceDetectionResponse#next_token #next_token} => String
2163
2247
  # * {Types::GetFaceDetectionResponse#faces #faces} => Array<Types::FaceDetection>
2164
2248
  #
2249
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2250
+ #
2165
2251
  # @example Request syntax with placeholder values
2166
2252
  #
2167
2253
  # resp = client.get_face_detection({
@@ -2291,6 +2377,8 @@ module Aws::Rekognition
2291
2377
  # * {Types::GetFaceSearchResponse#video_metadata #video_metadata} => Types::VideoMetadata
2292
2378
  # * {Types::GetFaceSearchResponse#persons #persons} => Array<Types::PersonMatch>
2293
2379
  #
2380
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2381
+ #
2294
2382
  # @example Request syntax with placeholder values
2295
2383
  #
2296
2384
  # resp = client.get_face_search({
@@ -2437,6 +2525,8 @@ module Aws::Rekognition
2437
2525
  # * {Types::GetLabelDetectionResponse#labels #labels} => Array<Types::LabelDetection>
2438
2526
  # * {Types::GetLabelDetectionResponse#label_model_version #label_model_version} => String
2439
2527
  #
2528
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2529
+ #
2440
2530
  # @example Request syntax with placeholder values
2441
2531
  #
2442
2532
  # resp = client.get_label_detection({
@@ -2548,6 +2638,8 @@ module Aws::Rekognition
2548
2638
  # * {Types::GetPersonTrackingResponse#next_token #next_token} => String
2549
2639
  # * {Types::GetPersonTrackingResponse#persons #persons} => Array<Types::PersonDetection>
2550
2640
  #
2641
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2642
+ #
2551
2643
  # @example Request syntax with placeholder values
2552
2644
  #
2553
2645
  # resp = client.get_person_tracking({
@@ -2673,6 +2765,8 @@ module Aws::Rekognition
2673
2765
  # * {Types::GetTextDetectionResponse#next_token #next_token} => String
2674
2766
  # * {Types::GetTextDetectionResponse#text_model_version #text_model_version} => String
2675
2767
  #
2768
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2769
+ #
2676
2770
  # @example Request syntax with placeholder values
2677
2771
  #
2678
2772
  # resp = client.get_text_detection({
@@ -3167,6 +3261,8 @@ module Aws::Rekognition
3167
3261
  # * {Types::ListCollectionsResponse#next_token #next_token} => String
3168
3262
  # * {Types::ListCollectionsResponse#face_model_versions #face_model_versions} => Array<String>
3169
3263
  #
3264
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3265
+ #
3170
3266
  #
3171
3267
  # @example Example: To list the collections
3172
3268
  #
@@ -3231,6 +3327,8 @@ module Aws::Rekognition
3231
3327
  # * {Types::ListFacesResponse#next_token #next_token} => String
3232
3328
  # * {Types::ListFacesResponse#face_model_version #face_model_version} => String
3233
3329
  #
3330
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3331
+ #
3234
3332
  #
3235
3333
  # @example Example: To list the faces in a collection
3236
3334
  #
@@ -3415,6 +3513,8 @@ module Aws::Rekognition
3415
3513
  # * {Types::ListStreamProcessorsResponse#next_token #next_token} => String
3416
3514
  # * {Types::ListStreamProcessorsResponse#stream_processors #stream_processors} => Array<Types::StreamProcessor>
3417
3515
  #
3516
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3517
+ #
3418
3518
  # @example Request syntax with placeholder values
3419
3519
  #
3420
3520
  # resp = client.list_stream_processors({
@@ -4556,7 +4656,7 @@ module Aws::Rekognition
4556
4656
  params: params,
4557
4657
  config: config)
4558
4658
  context[:gem_name] = 'aws-sdk-rekognition'
4559
- context[:gem_version] = '1.35.0'
4659
+ context[:gem_version] = '1.36.0'
4560
4660
  Seahorse::Client::Request.new(handlers, context)
4561
4661
  end
4562
4662
 
@@ -4622,10 +4722,10 @@ module Aws::Rekognition
4622
4722
  # The following table lists the valid waiter names, the operations they call,
4623
4723
  # and the default `:delay` and `:max_attempts` values.
4624
4724
  #
4625
- # | waiter_name | params | :delay | :max_attempts |
4626
- # | ---------------------------------- | ---------------------------- | -------- | ------------- |
4627
- # | project_version_running | {#describe_project_versions} | 30 | 40 |
4628
- # | project_version_training_completed | {#describe_project_versions} | 120 | 360 |
4725
+ # | waiter_name | params | :delay | :max_attempts |
4726
+ # | ---------------------------------- | ---------------------------------- | -------- | ------------- |
4727
+ # | project_version_running | {Client#describe_project_versions} | 30 | 40 |
4728
+ # | project_version_training_completed | {Client#describe_project_versions} | 120 | 360 |
4629
4729
  #
4630
4730
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
4631
4731
  # because the waiter has entered a state that it will not transition
@@ -60,6 +60,10 @@ module Aws::Rekognition
60
60
  DeleteCollectionResponse = Shapes::StructureShape.new(name: 'DeleteCollectionResponse')
61
61
  DeleteFacesRequest = Shapes::StructureShape.new(name: 'DeleteFacesRequest')
62
62
  DeleteFacesResponse = Shapes::StructureShape.new(name: 'DeleteFacesResponse')
63
+ DeleteProjectRequest = Shapes::StructureShape.new(name: 'DeleteProjectRequest')
64
+ DeleteProjectResponse = Shapes::StructureShape.new(name: 'DeleteProjectResponse')
65
+ DeleteProjectVersionRequest = Shapes::StructureShape.new(name: 'DeleteProjectVersionRequest')
66
+ DeleteProjectVersionResponse = Shapes::StructureShape.new(name: 'DeleteProjectVersionResponse')
63
67
  DeleteStreamProcessorRequest = Shapes::StructureShape.new(name: 'DeleteStreamProcessorRequest')
64
68
  DeleteStreamProcessorResponse = Shapes::StructureShape.new(name: 'DeleteStreamProcessorResponse')
65
69
  DescribeCollectionRequest = Shapes::StructureShape.new(name: 'DescribeCollectionRequest')
@@ -438,6 +442,18 @@ module Aws::Rekognition
438
442
  DeleteFacesResponse.add_member(:deleted_faces, Shapes::ShapeRef.new(shape: FaceIdList, location_name: "DeletedFaces"))
439
443
  DeleteFacesResponse.struct_class = Types::DeleteFacesResponse
440
444
 
445
+ DeleteProjectRequest.add_member(:project_arn, Shapes::ShapeRef.new(shape: ProjectArn, required: true, location_name: "ProjectArn"))
446
+ DeleteProjectRequest.struct_class = Types::DeleteProjectRequest
447
+
448
+ DeleteProjectResponse.add_member(:status, Shapes::ShapeRef.new(shape: ProjectStatus, location_name: "Status"))
449
+ DeleteProjectResponse.struct_class = Types::DeleteProjectResponse
450
+
451
+ DeleteProjectVersionRequest.add_member(:project_version_arn, Shapes::ShapeRef.new(shape: ProjectVersionArn, required: true, location_name: "ProjectVersionArn"))
452
+ DeleteProjectVersionRequest.struct_class = Types::DeleteProjectVersionRequest
453
+
454
+ DeleteProjectVersionResponse.add_member(:status, Shapes::ShapeRef.new(shape: ProjectVersionStatus, location_name: "Status"))
455
+ DeleteProjectVersionResponse.struct_class = Types::DeleteProjectVersionResponse
456
+
441
457
  DeleteStreamProcessorRequest.add_member(:name, Shapes::ShapeRef.new(shape: StreamProcessorName, required: true, location_name: "Name"))
442
458
  DeleteStreamProcessorRequest.struct_class = Types::DeleteStreamProcessorRequest
443
459
 
@@ -1272,6 +1288,36 @@ module Aws::Rekognition
1272
1288
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1273
1289
  end)
1274
1290
 
1291
+ api.add_operation(:delete_project, Seahorse::Model::Operation.new.tap do |o|
1292
+ o.name = "DeleteProject"
1293
+ o.http_method = "POST"
1294
+ o.http_request_uri = "/"
1295
+ o.input = Shapes::ShapeRef.new(shape: DeleteProjectRequest)
1296
+ o.output = Shapes::ShapeRef.new(shape: DeleteProjectResponse)
1297
+ o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1298
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1299
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
1300
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1301
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
1302
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1303
+ o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
1304
+ end)
1305
+
1306
+ api.add_operation(:delete_project_version, Seahorse::Model::Operation.new.tap do |o|
1307
+ o.name = "DeleteProjectVersion"
1308
+ o.http_method = "POST"
1309
+ o.http_request_uri = "/"
1310
+ o.input = Shapes::ShapeRef.new(shape: DeleteProjectVersionRequest)
1311
+ o.output = Shapes::ShapeRef.new(shape: DeleteProjectVersionResponse)
1312
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1313
+ o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1314
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
1315
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1316
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
1317
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1318
+ o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
1319
+ end)
1320
+
1275
1321
  api.add_operation(:delete_stream_processor, Seahorse::Model::Operation.new.tap do |o|
1276
1322
  o.name = "DeleteStreamProcessor"
1277
1323
  o.http_method = "POST"
@@ -6,13 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Rekognition
9
- # This class provides a resource oriented interface for Rekognition.
10
- # To create a resource object:
11
- # resource = Aws::Rekognition::Resource.new(region: 'us-west-2')
12
- # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
14
- # client = Aws::Rekognition::Client.new(region: 'us-west-2')
15
- # resource = Aws::Rekognition::Resource.new(client: client)
9
+
16
10
  class Resource
17
11
 
18
12
  # @param options ({})
@@ -751,6 +751,58 @@ module Aws::Rekognition
751
751
  include Aws::Structure
752
752
  end
753
753
 
754
+ # @note When making an API call, you may pass DeleteProjectRequest
755
+ # data as a hash:
756
+ #
757
+ # {
758
+ # project_arn: "ProjectArn", # required
759
+ # }
760
+ #
761
+ # @!attribute [rw] project_arn
762
+ # The Amazon Resource Name (ARN) of the project that you want to
763
+ # delete.
764
+ # @return [String]
765
+ #
766
+ class DeleteProjectRequest < Struct.new(
767
+ :project_arn)
768
+ include Aws::Structure
769
+ end
770
+
771
+ # @!attribute [rw] status
772
+ # The current status of the delete project operation.
773
+ # @return [String]
774
+ #
775
+ class DeleteProjectResponse < Struct.new(
776
+ :status)
777
+ include Aws::Structure
778
+ end
779
+
780
+ # @note When making an API call, you may pass DeleteProjectVersionRequest
781
+ # data as a hash:
782
+ #
783
+ # {
784
+ # project_version_arn: "ProjectVersionArn", # required
785
+ # }
786
+ #
787
+ # @!attribute [rw] project_version_arn
788
+ # The Amazon Resource Name (ARN) of the model version that you want to
789
+ # delete.
790
+ # @return [String]
791
+ #
792
+ class DeleteProjectVersionRequest < Struct.new(
793
+ :project_version_arn)
794
+ include Aws::Structure
795
+ end
796
+
797
+ # @!attribute [rw] status
798
+ # The status of the deletion operation.
799
+ # @return [String]
800
+ #
801
+ class DeleteProjectVersionResponse < Struct.new(
802
+ :status)
803
+ include Aws::Structure
804
+ end
805
+
754
806
  # @note When making an API call, you may pass DeleteStreamProcessorRequest
755
807
  # data as a hash:
756
808
  #
@@ -8,6 +8,68 @@
8
8
  require 'aws-sdk-core/waiters'
9
9
 
10
10
  module Aws::Rekognition
11
+ # Waiters are utility methods that poll for a particular state to occur
12
+ # on a client. Waiters can fail after a number of attempts at a polling
13
+ # interval defined for the service client.
14
+ #
15
+ # For a list of operations that can be waited for and the
16
+ # client methods called for each operation, see the table below or the
17
+ # {Client#wait_until} field documentation for the {Client}.
18
+ #
19
+ # # Invoking a Waiter
20
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
21
+ # is the waiter name, which is specific to the service client and indicates
22
+ # which operation is being waited for. The second parameter is a hash of
23
+ # parameters that are passed to the client method called by the waiter,
24
+ # which varies according to the waiter name.
25
+ #
26
+ # # Wait Failures
27
+ # To catch errors in a waiter, use WaiterFailed,
28
+ # as shown in the following example.
29
+ #
30
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
31
+ # puts "failed waiting for instance running: #{error.message}
32
+ # end
33
+ #
34
+ # # Configuring a Waiter
35
+ # Each waiter has a default polling interval and a maximum number of
36
+ # attempts it will make before returning control to your program.
37
+ # To set these values, use the `max_attempts` and `delay` parameters
38
+ # in your `#wait_until` call.
39
+ # The following example waits for up to 25 seconds, polling every five seconds.
40
+ #
41
+ # client.wait_until(...) do |w|
42
+ # w.max_attempts = 5
43
+ # w.delay = 5
44
+ # end
45
+ #
46
+ # To disable wait failures, set the value of either of these parameters
47
+ # to `nil`.
48
+ #
49
+ # # Extending a Waiter
50
+ # To modify the behavior of waiters, you can register callbacks that are
51
+ # triggered before each polling attempt and before waiting.
52
+ #
53
+ # The following example implements an exponential backoff in a waiter
54
+ # by doubling the amount of time to wait on every attempt.
55
+ #
56
+ # client.wait_until(...) do |w|
57
+ # w.interval = 0 # disable normal sleep
58
+ # w.before_wait do |n, resp|
59
+ # sleep(n ** 2)
60
+ # end
61
+ # end
62
+ #
63
+ # # Available Waiters
64
+ #
65
+ # The following table lists the valid waiter names, the operations they call,
66
+ # and the default `:delay` and `:max_attempts` values.
67
+ #
68
+ # | waiter_name | params | :delay | :max_attempts |
69
+ # | ---------------------------------- | ---------------------------------- | -------- | ------------- |
70
+ # | project_version_running | {Client#describe_project_versions} | 30 | 40 |
71
+ # | project_version_training_completed | {Client#describe_project_versions} | 120 | 360 |
72
+ #
11
73
  module Waiters
12
74
 
13
75
  # Wait until the ProjectVersion is running.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-rekognition
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.35.0
4
+ version: 1.36.0
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: 2020-03-09 00:00:00.000000000 Z
11
+ date: 2020-03-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core