aws-sdk-rekognition 1.69.0 → 1.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c18f35079e645c8c14ba246ba76f0d1eb862b205192d586c1a0c4bc306376a4f
-  data.tar.gz: 6e3bc7e3aeabde379f20eeeee5804c9fd3bcd5c58048e359e10a8fb3321a9622
+  metadata.gz: 905750bbefaa5fa1c3911030a8c24e9e373f87cf5a4f38f0538f84df5c63e3f5
+  data.tar.gz: 3ab5a14ff6b83ce0ba0e653531d5bfa784db068aae320298d5417e6ecc6bf8c6
 SHA512:
-  metadata.gz: 26aa60c7d490065be88643d7870384ffe4650545385d9f951fc5dce97bc30d67c2db7b3e8f2a356bf9aa0896e5dfd1755787edcddcbdff8129e6063a63782764
-  data.tar.gz: 9cce0427913d4f6db324ba298a4cefea78f5c2e3e4a4457b5984db659a77d62ef2661a7ac6898c505fb7f32cb1f4072f67906a021fa833c598be261baf97b906
+  metadata.gz: 5596e290509cace40198994218271e9f9de737d4c0f1fc1d8741f4c07d2faf3e094630e383919617706b129a79463e96cf1da121147fd134c8f8c8cccfcf71f0
+  data.tar.gz: feb2605c0dc3ca1c0070a9e55f01fe147266b7a3b932fc7344c95e944d3f6846eb13539533c9f2128021bab665a6fa5c3ad0b56f8c42a36c89daa7cc13e90200

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.71.0 (2022-10-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.70.0 (2022-08-16)
+------------------
+
+* Feature - This release adds APIs which support copying an Amazon Rekognition Custom Labels model and managing project policies across AWS account.
+
 1.69.0 (2022-07-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.69.0
+1.71.0

data/lib/aws-sdk-rekognition/client.rb

@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/checksum_algorithm.rb'
 require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/recursion_detection.rb'
-require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/sign.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:rekognition)
@@ -79,8 +79,9 @@ module Aws::Rekognition
     add_plugin(Aws::Plugins::ChecksumAlgorithm)
     add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::RecursionDetection)
-    add_plugin(Aws::Plugins::SignatureV4)
+    add_plugin(Aws::Plugins::Sign)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
+    add_plugin(Aws::Rekognition::Plugins::Endpoints)
 
     # @overload initialize(options)
     #   @param [Hash] options
@@ -297,6 +298,19 @@ module Aws::Rekognition
     #     ** Please note ** When response stubbing is enabled, no HTTP
     #     requests are made, and retries are disabled.
     #
+    #   @option options [Aws::TokenProvider] :token_provider
+    #     A Bearer Token Provider. This can be an instance of any one of the
+    #     following classes:
+    #
+    #     * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
+    #       tokens.
+    #
+    #     * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
+    #     will be used to search for tokens configured for your profile in shared configuration files.
+    #
     #   @option options [Boolean] :use_dualstack_endpoint
     #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
     #     will be used if available.
@@ -310,6 +324,9 @@ module Aws::Rekognition
     #     When `true`, request parameters are validated before
     #     sending the request.
     #
+    #   @option options [Aws::Rekognition::EndpointProvider] :endpoint_provider
+    #     The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Rekognition::EndpointParameters`
+    #
     #   @option options [URI::HTTP,String] :http_proxy A proxy to send
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
@@ -606,6 +623,135 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Copies a version of an Amazon Rekognition Custom Labels model from a
+    # source project to a destination project. The source and destination
+    # projects can be in different AWS accounts but must be in the same AWS
+    # Region. You can't copy a model to another AWS service.
+    #
+    # To copy a model version to a different AWS account, you need to create
+    # a resource-based policy known as a *project policy*. You attach the
+    # project policy to the source project by calling PutProjectPolicy. The
+    # project policy gives permission to copy the model version from a
+    # trusting AWS account to a trusted account.
+    #
+    # For more information creating and attaching a project policy, see
+    # Attaching a project policy (SDK) in the *Amazon Rekognition Custom
+    # Labels Developer Guide*.
+    #
+    # If you are copying a model version to a project in the same AWS
+    # account, you don't need to create a project policy.
+    #
+    # <note markdown="1"> To copy a model, the destination project, source project, and source
+    # model version must already exist.
+    #
+    #  </note>
+    #
+    # Copying a model version takes a while to complete. To get the current
+    # status, call DescribeProjectVersions and check the value of `Status`
+    # in the ProjectVersionDescription object. The copy operation has
+    # finished when the value of `Status` is `COPYING_COMPLETED`.
+    #
+    # @option params [required, String] :source_project_arn
+    #   The ARN of the source project in the trusting AWS account.
+    #
+    # @option params [required, String] :source_project_version_arn
+    #   The ARN of the model version in the source project that you want to
+    #   copy to a destination project.
+    #
+    # @option params [required, String] :destination_project_arn
+    #   The ARN of the project in the trusted AWS account that you want to
+    #   copy the model version to.
+    #
+    # @option params [required, String] :version_name
+    #   A name for the version of the model that's copied to the destination
+    #   project.
+    #
+    # @option params [required, Types::OutputConfig] :output_config
+    #   The S3 bucket and folder location where the training output for the
+    #   source model version is placed.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   The key-value tags to assign to the model version.
+    #
+    # @option params [String] :kms_key_id
+    #   The identifier for your AWS Key Management Service key (AWS KMS key).
+    #   You can supply the Amazon Resource Name (ARN) of your KMS key, the ID
+    #   of your KMS key, an alias for your KMS key, or an alias ARN. The key
+    #   is used to encrypt training results and manifest files written to the
+    #   output Amazon S3 bucket (`OutputConfig`).
+    #
+    #   If you choose to use your own KMS key, you need the following
+    #   permissions on the KMS key.
+    #
+    #   * kms:CreateGrant
+    #
+    #   * kms:DescribeKey
+    #
+    #   * kms:GenerateDataKey
+    #
+    #   * kms:Decrypt
+    #
+    #   If you don't specify a value for `KmsKeyId`, images copied into the
+    #   service are encrypted using a key that AWS owns and manages.
+    #
+    # @return [Types::CopyProjectVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CopyProjectVersionResponse#project_version_arn #project_version_arn} => String
+    #
+    #
+    # @example Example: CopyProjectVersion
+    #
+    #   # This operation copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination
+    #   # project.
+    #
+    #   resp = client.copy_project_version({
+    #     destination_project_arn: "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/1656705098765", 
+    #     kms_key_id: "arn:1234abcd-12ab-34cd-56ef-1234567890ab", 
+    #     output_config: {
+    #       s3_bucket: "bucket-name", 
+    #       s3_key_prefix: "path_to_folder", 
+    #     }, 
+    #     source_project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/16565123456", 
+    #     source_project_version_arn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/version/model_1/1656611123456", 
+    #     tags: {
+    #       "key1" => "val1", 
+    #     }, 
+    #     version_name: "DestinationVersionName_cross_account", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     project_version_arn: "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/version/DestinationVersionName_cross_account/16567050987651", 
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.copy_project_version({
+    #     source_project_arn: "ProjectArn", # required
+    #     source_project_version_arn: "ProjectVersionArn", # required
+    #     destination_project_arn: "ProjectArn", # required
+    #     version_name: "VersionName", # required
+    #     output_config: { # required
+    #       s3_bucket: "S3Bucket",
+    #       s3_key_prefix: "S3KeyPrefix",
+    #     },
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #     kms_key_id: "KmsKeyId",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.project_version_arn #=> String
+    #
+    # @overload copy_project_version(params = {})
+    # @param [Hash] params ({})
+    def copy_project_version(params = {}, options = {})
+      req = build_request(:copy_project_version, params)
+      req.send_request(options)
+    end
+
     # Creates a collection in an AWS Region. You can add faces to the
     # collection using the IndexFaces operation.
     #
@@ -1255,7 +1401,9 @@ module Aws::Rekognition
     #
     # `DeleteProject` is an asynchronous operation. To check if the project
     # is deleted, call DescribeProjects. The project is deleted when the
-    # project no longer appears in the response.
+    # project no longer appears in the response. Be aware that deleting a
+    # given project will also delete any `ProjectPolicies` associated with
+    # that project.
     #
     # This operation requires permissions to perform the
     # `rekognition:DeleteProject` action.
@@ -1284,6 +1432,54 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Deletes an existing project policy.
+    #
+    # To get a list of project policies attached to a project, call
+    # ListProjectPolicies. To attach a project policy to a project, call
+    # PutProjectPolicy.
+    #
+    # @option params [required, String] :project_arn
+    #   The Amazon Resource Name (ARN) of the project that the project policy
+    #   you want to delete is attached to.
+    #
+    # @option params [required, String] :policy_name
+    #   The name of the policy that you want to delete.
+    #
+    # @option params [String] :policy_revision_id
+    #   The ID of the project policy revision that you want to delete.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    #
+    # @example Example: DeleteProjectPolicy
+    #
+    #   # This operation deletes a revision of an existing project policy from an Amazon Rekognition Custom Labels project.
+    #
+    #   resp = client.delete_project_policy({
+    #     policy_name: "testPolicy1", 
+    #     policy_revision_id: "3b274c25e9203a56a99e00e3ff205fbc", 
+    #     project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/1656557123456", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_project_policy({
+    #     project_arn: "ProjectArn", # required
+    #     policy_name: "ProjectPolicyName", # required
+    #     policy_revision_id: "ProjectPolicyRevisionId",
+    #   })
+    #
+    # @overload delete_project_policy(params = {})
+    # @param [Hash] params ({})
+    def delete_project_policy(params = {}, options = {})
+      req = build_request(:delete_project_policy, params)
+      req.send_request(options)
+    end
+
     # Deletes an Amazon Rekognition Custom Labels model.
     #
     # You can't delete a model if it is running or if it is training. To
@@ -1310,7 +1506,7 @@ module Aws::Rekognition
     #
     # @example Response structure
     #
-    #   resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING"
+    #   resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED"
     #
     # @overload delete_project_version(params = {})
     # @param [Hash] params ({})
@@ -1476,7 +1672,7 @@ module Aws::Rekognition
     #   resp.project_version_descriptions[0].project_version_arn #=> String
     #   resp.project_version_descriptions[0].creation_timestamp #=> Time
     #   resp.project_version_descriptions[0].min_inference_units #=> Integer
-    #   resp.project_version_descriptions[0].status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING"
+    #   resp.project_version_descriptions[0].status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED"
     #   resp.project_version_descriptions[0].status_message #=> String
     #   resp.project_version_descriptions[0].billable_training_time_in_seconds #=> Integer
     #   resp.project_version_descriptions[0].training_end_timestamp #=> Time
@@ -1517,6 +1713,7 @@ module Aws::Rekognition
     #   resp.project_version_descriptions[0].manifest_summary.s3_object.version #=> String
     #   resp.project_version_descriptions[0].kms_key_id #=> String
     #   resp.project_version_descriptions[0].max_inference_units #=> Integer
+    #   resp.project_version_descriptions[0].source_project_version_arn #=> String
     #   resp.next_token #=> String
     #
     #
@@ -4386,6 +4583,85 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Gets a list of the project policies attached to a project.
+    #
+    # To attach a project policy to a project, call PutProjectPolicy. To
+    # remove a project policy from a project, call DeleteProjectPolicy.
+    #
+    # @option params [required, String] :project_arn
+    #   The ARN of the project for which you want to list the project
+    #   policies.
+    #
+    # @option params [String] :next_token
+    #   If the previous response was incomplete (because there is more results
+    #   to retrieve), Amazon Rekognition Custom Labels returns a pagination
+    #   token in the response. You can use this pagination token to retrieve
+    #   the next set of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per paginated call. The
+    #   largest value you can specify is 5. If you specify a value greater
+    #   than 5, a ValidationException error occurs. The default value is 5.
+    #
+    # @return [Types::ListProjectPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListProjectPoliciesResponse#project_policies #project_policies} => Array&lt;Types::ProjectPolicy&gt;
+    #   * {Types::ListProjectPoliciesResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    #
+    # @example Example: ListProjectPolicies
+    #
+    #   # This operation lists the project policies that are attached to an Amazon Rekognition Custom Labels project.
+    #
+    #   resp = client.list_project_policies({
+    #     max_results: 5, 
+    #     next_token: "", 
+    #     project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     next_token: "", 
+    #     project_policies: [
+    #       {
+    #         creation_timestamp: Time.parse("2022-07-01T11:51:27.086000-07:00"), 
+    #         last_updated_timestamp: Time.parse("2022-07-01T11:51:27.086000-07:00"), 
+    #         policy_document: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Statemented1\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:root\"},\"Action\":\"rekognition:CopyProjectVersion\",\"Resource\":\"*\"}]}", 
+    #         policy_name: "testPolicy", 
+    #         policy_revision_id: "3b274c25e9203a56a99e00e3ff205fbc", 
+    #         project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929", 
+    #       }, 
+    #     ], 
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_project_policies({
+    #     project_arn: "ProjectArn", # required
+    #     next_token: "ExtendedPaginationToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.project_policies #=> Array
+    #   resp.project_policies[0].project_arn #=> String
+    #   resp.project_policies[0].policy_name #=> String
+    #   resp.project_policies[0].policy_revision_id #=> String
+    #   resp.project_policies[0].policy_document #=> String
+    #   resp.project_policies[0].creation_timestamp #=> Time
+    #   resp.project_policies[0].last_updated_timestamp #=> Time
+    #   resp.next_token #=> String
+    #
+    # @overload list_project_policies(params = {})
+    # @param [Hash] params ({})
+    def list_project_policies(params = {}, options = {})
+      req = build_request(:list_project_policies, params)
+      req.send_request(options)
+    end
+
     # Gets a list of stream processors that you have created with
     # CreateStreamProcessor.
     #
@@ -4459,6 +4735,92 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Attaches a project policy to a Amazon Rekognition Custom Labels
+    # project in a trusting AWS account. A project policy specifies that a
+    # trusted AWS account can copy a model version from a trusting AWS
+    # account to a project in the trusted AWS account. To copy a model
+    # version you use the CopyProjectVersion operation.
+    #
+    # For more information about the format of a project policy document,
+    # see Attaching a project policy (SDK) in the *Amazon Rekognition Custom
+    # Labels Developer Guide*.
+    #
+    # The response from `PutProjectPolicy` is a revision ID for the project
+    # policy. You can attach multiple project policies to a project. You can
+    # also update an existing project policy by specifying the policy
+    # revision ID of the existing policy.
+    #
+    # To remove a project policy from a project, call DeleteProjectPolicy.
+    # To get a list of project policies attached to a project, call
+    # ListProjectPolicies.
+    #
+    # You copy a model version by calling CopyProjectVersion.
+    #
+    # @option params [required, String] :project_arn
+    #   The Amazon Resource Name (ARN) of the project that the project policy
+    #   is attached to.
+    #
+    # @option params [required, String] :policy_name
+    #   A name for the policy.
+    #
+    # @option params [String] :policy_revision_id
+    #   The revision ID for the Project Policy. Each time you modify a policy,
+    #   Amazon Rekognition Custom Labels generates and assigns a new
+    #   `PolicyRevisionId` and then deletes the previous version of the
+    #   policy.
+    #
+    # @option params [required, String] :policy_document
+    #   A resource policy to add to the model. The policy is a JSON structure
+    #   that contains one or more statements that define the policy. The
+    #   policy must follow the IAM syntax. For more information about the
+    #   contents of a JSON policy document, see [IAM JSON policy
+    #   reference][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
+    #
+    # @return [Types::PutProjectPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::PutProjectPolicyResponse#policy_revision_id #policy_revision_id} => String
+    #
+    #
+    # @example Example: PutProjectPolicy
+    #
+    #   # This operation attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account.
+    #
+    #   resp = client.put_project_policy({
+    #     policy_document: "'{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"ALLOW\",\"Principal\":{\"AWS\":\"principal\"},\"Action\":\"rekognition:CopyProjectVersion\",\"Resource\":\"arn:aws:rekognition:us-east-1:123456789012:project/my-sdk-project/version/DestinationVersionName/1627045542080\"}]}'", 
+    #     policy_name: "SamplePolicy", 
+    #     policy_revision_id: "0123456789abcdef", 
+    #     project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     policy_revision_id: "0123456789abcdef", 
+    #   }
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_project_policy({
+    #     project_arn: "ProjectArn", # required
+    #     policy_name: "ProjectPolicyName", # required
+    #     policy_revision_id: "ProjectPolicyRevisionId",
+    #     policy_document: "ProjectPolicyDocument", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.policy_revision_id #=> String
+    #
+    # @overload put_project_policy(params = {})
+    # @param [Hash] params ({})
+    def put_project_policy(params = {}, options = {})
+      req = build_request(:put_project_policy, params)
+      req.send_request(options)
+    end
+
     # Returns an array of celebrities recognized in the input image. For
     # more information, see Recognizing celebrities in the Amazon
     # Rekognition Developer Guide.
@@ -5444,7 +5806,7 @@ module Aws::Rekognition
     #
     # @example Response structure
     #
-    #   resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING"
+    #   resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED"
     #
     # @overload start_project_version(params = {})
     # @param [Hash] params ({})
@@ -5747,7 +6109,7 @@ module Aws::Rekognition
     #
     # @example Response structure
     #
-    #   resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING"
+    #   resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED"
     #
     # @overload stop_project_version(params = {})
     # @param [Hash] params ({})
@@ -5976,7 +6338,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.69.0'
+      context[:gem_version] = '1.71.0'
       Seahorse::Client::Request.new(handlers, context)
     end