lib/aws-sdk-signer/client.rb in aws-sdk-signer-1.16.0 vs lib/aws-sdk-signer/client.rb in aws-sdk-signer-1.17.0

- old
+ new

@@ -398,10 +398,12 @@ # * {Types::GetSigningProfileResponse#signing_material #signing_material} => Types::SigningMaterial # * {Types::GetSigningProfileResponse#platform_id #platform_id} => String # * {Types::GetSigningProfileResponse#overrides #overrides} => Types::SigningPlatformOverrides # * {Types::GetSigningProfileResponse#signing_parameters #signing_parameters} => Hash&lt;String,String&gt; # * {Types::GetSigningProfileResponse#status #status} => String + # * {Types::GetSigningProfileResponse#arn #arn} => String + # * {Types::GetSigningProfileResponse#tags #tags} => Hash&lt;String,String&gt; # # @example Request syntax with placeholder values # # resp = client.get_signing_profile({ # profile_name: "ProfileName", # required @@ -415,10 +417,13 @@ # resp.overrides.signing_configuration.encryption_algorithm #=> String, one of "RSA", "ECDSA" # resp.overrides.signing_configuration.hash_algorithm #=> String, one of "SHA1", "SHA256" # resp.signing_parameters #=> Hash # resp.signing_parameters["SigningParameterKey"] #=> String # resp.status #=> String, one of "Active", "Canceled" + # resp.arn #=> String + # resp.tags #=> Hash + # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningProfile AWS API Documentation # # @overload get_signing_profile(params = {}) # @param [Hash] params ({}) @@ -427,16 +432,16 @@ req.send_request(options) end # Lists all your signing jobs. You can use the `maxResults` parameter to # limit the number of signing jobs that are returned in the response. If - # additional jobs remain to be listed, AWS Signer returns a `nextToken` - # value. Use this value in subsequent calls to `ListSigningJobs` to - # fetch the remaining values. You can continue calling `ListSigningJobs` - # with your `maxResults` parameter and with new values that AWS Signer - # returns in the `nextToken` parameter until all of your signing jobs - # have been returned. + # additional jobs remain to be listed, code signing returns a + # `nextToken` value. Use this value in subsequent calls to + # `ListSigningJobs` to fetch the remaining values. You can continue + # calling `ListSigningJobs` with your `maxResults` parameter and with + # new values that code signing returns in the `nextToken` parameter + # until all of your signing jobs have been returned. # # @option params [String] :status # A status value with which to filter your results. # # @option params [String] :platform_id @@ -495,17 +500,17 @@ def list_signing_jobs(params = {}, options = {}) req = build_request(:list_signing_jobs, params) req.send_request(options) end - # Lists all signing platforms available in AWS Signer that match the - # request parameters. If additional jobs remain to be listed, AWS Signer - # returns a `nextToken` value. Use this value in subsequent calls to - # `ListSigningJobs` to fetch the remaining values. You can continue - # calling `ListSigningJobs` with your `maxResults` parameter and with - # new values that AWS Signer returns in the `nextToken` parameter until - # all of your signing jobs have been returned. + # Lists all signing platforms available in code signing that match the + # request parameters. If additional jobs remain to be listed, code + # signing returns a `nextToken` value. Use this value in subsequent + # calls to `ListSigningJobs` to fetch the remaining values. You can + # continue calling `ListSigningJobs` with your `maxResults` parameter + # and with new values that code signing returns in the `nextToken` + # parameter until all of your signing jobs have been returned. # # @option params [String] :category # The category type of a signing platform. # # @option params [String] :partner @@ -567,16 +572,16 @@ req.send_request(options) end # Lists all available signing profiles in your AWS account. Returns only # profiles with an `ACTIVE` status unless the `includeCanceled` request - # field is set to `true`. If additional jobs remain to be listed, AWS - # Signer returns a `nextToken` value. Use this value in subsequent calls - # to `ListSigningJobs` to fetch the remaining values. You can continue - # calling `ListSigningJobs` with your `maxResults` parameter and with - # new values that AWS Signer returns in the `nextToken` parameter until - # all of your signing jobs have been returned. + # field is set to `true`. If additional jobs remain to be listed, code + # signing returns a `nextToken` value. Use this value in subsequent + # calls to `ListSigningJobs` to fetch the remaining values. You can + # continue calling `ListSigningJobs` with your `maxResults` parameter + # and with new values that code signing returns in the `nextToken` + # parameter until all of your signing jobs have been returned. # # @option params [Boolean] :include_canceled # Designates whether to include profiles with the status of `CANCELED`. # # @option params [Integer] :max_results @@ -608,10 +613,13 @@ # resp.profiles[0].signing_material.certificate_arn #=> String # resp.profiles[0].platform_id #=> String # resp.profiles[0].signing_parameters #=> Hash # resp.profiles[0].signing_parameters["SigningParameterKey"] #=> String # resp.profiles[0].status #=> String, one of "Active", "Canceled" + # resp.profiles[0].arn #=> String + # resp.profiles[0].tags #=> Hash + # resp.profiles[0].tags["TagKey"] #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningProfiles AWS API Documentation # # @overload list_signing_profiles(params = {}) @@ -619,13 +627,42 @@ def list_signing_profiles(params = {}, options = {}) req = build_request(:list_signing_profiles, params) req.send_request(options) end - # Creates a signing profile. A signing profile is an AWS Signer template - # that can be used to carry out a pre-defined signing job. For more - # information, see + # Returns a list of the tags associated with a signing profile resource. + # + # @option params [required, String] :resource_arn + # The Amazon Resource Name (ARN) for the signing profile. + # + # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.list_tags_for_resource({ + # resource_arn: "String", # required + # }) + # + # @example Response structure + # + # resp.tags #=> Hash + # resp.tags["TagKey"] #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListTagsForResource AWS API Documentation + # + # @overload list_tags_for_resource(params = {}) + # @param [Hash] params ({}) + def list_tags_for_resource(params = {}, options = {}) + req = build_request(:list_tags_for_resource, params) + req.send_request(options) + end + + # Creates a signing profile. A signing profile is a code signing + # template that can be used to carry out a pre-defined signing job. For + # more information, see # [http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html][1] # # # # [1]: http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html @@ -647,10 +684,13 @@ # # @option params [Hash<String,String>] :signing_parameters # Map of key-value pairs for signing. These can include any information # that you want to use during signing. # + # @option params [Hash<String,String>] :tags + # Tags to be associated with the signing profile being created. + # # @return [Types::PutSigningProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PutSigningProfileResponse#arn #arn} => String # # @example Request syntax with placeholder values @@ -668,10 +708,13 @@ # }, # }, # signing_parameters: { # "SigningParameterKey" => "SigningParameterValue", # }, + # tags: { + # "TagKey" => "TagValue", + # }, # }) # # @example Response structure # # resp.arn #=> String @@ -692,18 +735,18 @@ # * You must create an Amazon S3 source bucket. For more information, # see [Create a Bucket][1] in the *Amazon S3 Getting Started Guide*. # # * Your S3 source bucket must be version enabled. # - # * You must create an S3 destination bucket. AWS Signer uses your S3 + # * You must create an S3 destination bucket. Code signing uses your S3 # destination bucket to write your signed code. # # * You specify the name of the source and destination buckets when # calling the `StartSigningJob` operation. # # * You must also specify a request token that identifies your request - # to AWS Signer. + # to code signing. # # You can call the DescribeSigningJob and the ListSigningJobs actions # after you call `StartSigningJob`. # # For a Java example that shows how to use this action, see @@ -767,10 +810,69 @@ def start_signing_job(params = {}, options = {}) req = build_request(:start_signing_job, params) req.send_request(options) end + # Adds one or more tags to a signing profile. Tags are labels that you + # can use to identify and organize your AWS resources. Each tag consists + # of a key and an optional value. You specify the signing profile using + # its Amazon Resource Name (ARN). You specify the tag by using a + # key-value pair. + # + # @option params [required, String] :resource_arn + # Amazon Resource Name (ARN) for the signing profile. + # + # @option params [required, Hash<String,String>] :tags + # One or more tags to be associated with the signing profile. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.tag_resource({ + # resource_arn: "String", # required + # tags: { # required + # "TagKey" => "TagValue", + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/TagResource AWS API Documentation + # + # @overload tag_resource(params = {}) + # @param [Hash] params ({}) + def tag_resource(params = {}, options = {}) + req = build_request(:tag_resource, params) + req.send_request(options) + end + + # Remove one or more tags from a signing profile. Specify a list of tag + # keys to remove the tags. + # + # @option params [required, String] :resource_arn + # Amazon Resource Name (ARN) for the signing profile . + # + # @option params [required, Array<String>] :tag_keys + # A list of tag keys to be removed from the signing profile . + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.untag_resource({ + # resource_arn: "String", # required + # tag_keys: ["TagKey"], # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/UntagResource AWS API Documentation + # + # @overload untag_resource(params = {}) + # @param [Hash] params ({}) + def untag_resource(params = {}, options = {}) + req = build_request(:untag_resource, params) + req.send_request(options) + end + # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) @@ -780,10 +882,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-signer' - context[:gem_version] = '1.16.0' + context[:gem_version] = '1.17.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #