You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Signer::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::Signer::Client

show all

Defined in:: (unknown)

Overview

An API client for AWS Signer. To construct a client, you need to configure a :region and :credentials.

signer = Aws::Signer::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::Signer::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::Signer::Client constructor
Constructs an API client.

API Operations collapse

#cancel_signing_profile(options = {}) ⇒ Struct
Changes the state of an ACTIVE signing profile to CANCELED.
#describe_signing_job(options = {}) ⇒ Types::DescribeSigningJobResponse
Returns information about a specific code signing job.
#get_signing_platform(options = {}) ⇒ Types::GetSigningPlatformResponse
Returns information on a specific signing platform.

.
#get_signing_profile(options = {}) ⇒ Types::GetSigningProfileResponse
Returns information on a specific signing profile.

.
#list_signing_jobs(options = {}) ⇒ Types::ListSigningJobsResponse
Lists all your signing jobs.
#list_signing_platforms(options = {}) ⇒ Types::ListSigningPlatformsResponse
Lists all signing platforms available in code signing that match the request parameters.
#list_signing_profiles(options = {}) ⇒ Types::ListSigningProfilesResponse
Lists all available signing profiles in your AWS account.
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags associated with a signing profile resource.

.
#put_signing_profile(options = {}) ⇒ Types::PutSigningProfileResponse
Creates a signing profile.
#start_signing_job(options = {}) ⇒ Types::StartSigningJobResponse
Initiates a signing job to be performed on the code provided.
#tag_resource(options = {}) ⇒ Struct
Adds one or more tags to a signing profile.
#untag_resource(options = {}) ⇒ Struct
Removes one or more tags from a signing profile.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::Signer::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#cancel_signing_profile(options = {}) ⇒ `Struct`

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

Examples:

Request syntax with placeholder values


resp = client.cancel_signing_profile({
  profile_name: "ProfileName", # required
})

Options Hash (options):

:profile_name (required, String) —
The name of the signing profile to be canceled.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#describe_signing_job(options = {}) ⇒ `Types::DescribeSigningJobResponse`

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

Examples:

Request syntax with placeholder values


resp = client.describe_signing_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.source.s3.bucket_name #=> String
resp.source.s3.key #=> String
resp.source.s3.version #=> String
resp.signing_material.certificate_arn #=> String
resp.platform_id #=> String
resp.profile_name #=> String
resp.overrides.signing_configuration.encryption_algorithm #=> String, one of "RSA", "ECDSA"
resp.overrides.signing_configuration.hash_algorithm #=> String, one of "SHA1", "SHA256"
resp.overrides.signing_image_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
resp.signing_parameters #=> Hash
resp.signing_parameters["SigningParameterKey"] #=> String
resp.created_at #=> Time
resp.completed_at #=> Time
resp.requested_by #=> String
resp.status #=> String, one of "InProgress", "Failed", "Succeeded"
resp.status_reason #=> String
resp.signed_object.s3.bucket_name #=> String
resp.signed_object.s3.key #=> String

Options Hash (options):

:job_id (required, String) —
The ID of the signing job on input.

Returns:

(Types::DescribeSigningJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String
- #source => Types::Source
- #signing_material => Types::SigningMaterial
- #platform_id => String
- #profile_name => String
- #overrides => Types::SigningPlatformOverrides
- #signing_parameters => Hash<String,String>
- #created_at => Time
- #completed_at => Time
- #requested_by => String
- #status => String
- #status_reason => String
- #signed_object => Types::SignedObject

See Also:

AWS API Documentation

#get_signing_platform(options = {}) ⇒ `Types::GetSigningPlatformResponse`

Returns information on a specific signing platform.

Examples:

Request syntax with placeholder values


resp = client.get_signing_platform({
  platform_id: "PlatformId", # required
})

Response structure


resp.platform_id #=> String
resp.display_name #=> String
resp.partner #=> String
resp.target #=> String
resp.category #=> String, one of "AWSIoT"
resp.signing_configuration.encryption_algorithm_options.allowed_values #=> Array
resp.signing_configuration.encryption_algorithm_options.allowed_values[0] #=> String, one of "RSA", "ECDSA"
resp.signing_configuration.encryption_algorithm_options.default_value #=> String, one of "RSA", "ECDSA"
resp.signing_configuration.hash_algorithm_options.allowed_values #=> Array
resp.signing_configuration.hash_algorithm_options.allowed_values[0] #=> String, one of "SHA1", "SHA256"
resp.signing_configuration.hash_algorithm_options.default_value #=> String, one of "SHA1", "SHA256"
resp.signing_image_format.supported_formats #=> Array
resp.signing_image_format.supported_formats[0] #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
resp.signing_image_format.default_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
resp.max_size_in_mb #=> Integer

Options Hash (options):

:platform_id (required, String) —
The ID of the target signing platform.

Returns:

(Types::GetSigningPlatformResponse) —
Returns a response object which responds to the following methods:
- #platform_id => String
- #display_name => String
- #partner => String
- #target => String
- #category => String
- #signing_configuration => Types::SigningConfiguration
- #signing_image_format => Types::SigningImageFormat
- #max_size_in_mb => Integer

See Also:

AWS API Documentation

#get_signing_profile(options = {}) ⇒ `Types::GetSigningProfileResponse`

Returns information on a specific signing profile.

Examples:

Request syntax with placeholder values


resp = client.get_signing_profile({
  profile_name: "ProfileName", # required
})

Response structure


resp.profile_name #=> String
resp.signing_material.certificate_arn #=> String
resp.platform_id #=> String
resp.overrides.signing_configuration.encryption_algorithm #=> String, one of "RSA", "ECDSA"
resp.overrides.signing_configuration.hash_algorithm #=> String, one of "SHA1", "SHA256"
resp.overrides.signing_image_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
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

Options Hash (options):

:profile_name (required, String) —
The name of the target signing profile.

Returns:

(Types::GetSigningProfileResponse) —
Returns a response object which responds to the following methods:
- #profile_name => String
- #signing_material => Types::SigningMaterial
- #platform_id => String
- #overrides => Types::SigningPlatformOverrides
- #signing_parameters => Hash<String,String>
- #status => String
- #arn => String
- #tags => Hash<String,String>

See Also:

AWS API Documentation

#list_signing_jobs(options = {}) ⇒ `Types::ListSigningJobsResponse`

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, 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.

Examples:

Request syntax with placeholder values


resp = client.list_signing_jobs({
  status: "InProgress", # accepts InProgress, Failed, Succeeded
  platform_id: "PlatformId",
  requested_by: "RequestedBy",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].job_id #=> String
resp.jobs[0].source.s3.bucket_name #=> String
resp.jobs[0].source.s3.key #=> String
resp.jobs[0].source.s3.version #=> String
resp.jobs[0].signed_object.s3.bucket_name #=> String
resp.jobs[0].signed_object.s3.key #=> String
resp.jobs[0].signing_material.certificate_arn #=> String
resp.jobs[0].created_at #=> Time
resp.jobs[0].status #=> String, one of "InProgress", "Failed", "Succeeded"
resp.next_token #=> String

Options Hash (options):

:status (String) —
A status value with which to filter your results.
:platform_id (String) —
The ID of microcontroller platform that you specified for the distribution of your code image.
:requested_by (String) —
The IAM principal that requested the signing job.
:max_results (Integer) —
Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.
:next_token (String) —
String for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

Returns:

(Types::ListSigningJobsResponse) —
Returns a response object which responds to the following methods:
- #jobs => Array<Types::SigningJob>
- #next_token => String

See Also:

AWS API Documentation

#list_signing_platforms(options = {}) ⇒ `Types::ListSigningPlatformsResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.list_signing_platforms({
  category: "String",
  partner: "String",
  target: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.platforms #=> Array
resp.platforms[0].platform_id #=> String
resp.platforms[0].display_name #=> String
resp.platforms[0].partner #=> String
resp.platforms[0].target #=> String
resp.platforms[0].category #=> String, one of "AWSIoT"
resp.platforms[0].signing_configuration.encryption_algorithm_options.allowed_values #=> Array
resp.platforms[0].signing_configuration.encryption_algorithm_options.allowed_values[0] #=> String, one of "RSA", "ECDSA"
resp.platforms[0].signing_configuration.encryption_algorithm_options.default_value #=> String, one of "RSA", "ECDSA"
resp.platforms[0].signing_configuration.hash_algorithm_options.allowed_values #=> Array
resp.platforms[0].signing_configuration.hash_algorithm_options.allowed_values[0] #=> String, one of "SHA1", "SHA256"
resp.platforms[0].signing_configuration.hash_algorithm_options.default_value #=> String, one of "SHA1", "SHA256"
resp.platforms[0].signing_image_format.supported_formats #=> Array
resp.platforms[0].signing_image_format.supported_formats[0] #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
resp.platforms[0].signing_image_format.default_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
resp.platforms[0].max_size_in_mb #=> Integer
resp.next_token #=> String

Options Hash (options):

:category (String) —
The category type of a signing platform.
:partner (String) —
Any partner entities connected to a signing platform.
:target (String) —
The validation template that is used by the target signing platform.
:max_results (Integer) —
The maximum number of results to be returned by this operation.
:next_token (String) —
Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

Returns:

(Types::ListSigningPlatformsResponse) —
Returns a response object which responds to the following methods:
- #platforms => Array<Types::SigningPlatform>
- #next_token => String

See Also:

AWS API Documentation

#list_signing_profiles(options = {}) ⇒ `Types::ListSigningProfilesResponse`

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, 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.

Examples:

Request syntax with placeholder values


resp = client.list_signing_profiles({
  include_canceled: false,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.profiles #=> Array
resp.profiles[0].profile_name #=> String
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

Options Hash (options):

:include_canceled (Boolean) —
Designates whether to include profiles with the status of CANCELED.
:max_results (Integer) —
The maximum number of profiles to be returned.
:next_token (String) —
Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

Returns:

(Types::ListSigningProfilesResponse) —
Returns a response object which responds to the following methods:
- #profiles => Array<Types::SigningProfile>
- #next_token => String

See Also:

AWS API Documentation

#list_tags_for_resource(options = {}) ⇒ `Types::ListTagsForResourceResponse`

Returns a list of the tags associated with a signing profile resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Options Hash (options):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) for the signing profile.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Hash<String,String>

See Also:

AWS API Documentation

#put_signing_profile(options = {}) ⇒ `Types::PutSigningProfileResponse`

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

Examples:

Request syntax with placeholder values


resp = client.put_signing_profile({
  profile_name: "ProfileName", # required
  signing_material: { # required
    certificate_arn: "CertificateArn", # required
  },
  platform_id: "PlatformId", # required
  overrides: {
    signing_configuration: {
      encryption_algorithm: "RSA", # accepts RSA, ECDSA
      hash_algorithm: "SHA1", # accepts SHA1, SHA256
    },
    signing_image_format: "JSON", # accepts JSON, JSONEmbedded, JSONDetached
  },
  signing_parameters: {
    "SigningParameterKey" => "SigningParameterValue",
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String

Options Hash (options):

:profile_name (required, String) —
The name of the signing profile to be created.
:signing_material (required, Types::SigningMaterial) —
The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.
:platform_id (required, String) —
The ID of the signing platform to be created.
:overrides (Types::SigningPlatformOverrides) —
A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).
:signing_parameters (Hash<String,String>) —
Map of key-value pairs for signing. These can include any information that you want to use during signing.
:tags (Hash<String,String>) —
Tags to be associated with the signing profile that is being created.

Returns:

(Types::PutSigningProfileResponse) —
Returns a response object which responds to the following methods:
- #arn => String

See Also:

AWS API Documentation

#start_signing_job(options = {}) ⇒ `Types::StartSigningJobResponse`

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide.
Your S3 source bucket must be version enabled.
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 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 http://docs.aws.amazon.com/acm/latest/userguide/

Examples:

Request syntax with placeholder values


resp = client.start_signing_job({
  source: { # required
    s3: {
      bucket_name: "BucketName", # required
      key: "Key", # required
      version: "Version", # required
    },
  },
  destination: { # required
    s3: {
      bucket_name: "BucketName",
      prefix: "Prefix",
    },
  },
  profile_name: "ProfileName",
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.job_id #=> String

Options Hash (options):

:source (required, Types::Source) —
The S3 bucket that contains the object to sign or a BLOB that contains your raw code.
:destination (required, Types::Destination) —
The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.
:profile_name (String) —
The name of the signing profile.
:client_request_token (required, String) —
This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

Returns:

(Types::StartSigningJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String

See Also:

AWS API Documentation

#tag_resource(options = {}) ⇒ `Struct`

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. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Options Hash (options):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) for the signing profile.
:tags (required, Hash<String,String>) —
One or more tags to be associated with the signing profile.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#untag_resource(options = {}) ⇒ `Struct`

Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) for the signing profile.
:tag_keys (required, Array<String>) —
A list of tag keys to be removed from the signing profile.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

#waiter_names ⇒ `Array<Symbol>`

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name	Client Method	Default Delay:	Default Max Attempts:
`:successful_signing_job`	#describe_signing_job	20	25

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::Signer::Client

Overview

Region

Credentials

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::Signer::Client

Instance Method Details

#cancel_signing_profile(options = {}) ⇒ Struct

#describe_signing_job(options = {}) ⇒ Types::DescribeSigningJobResponse

#get_signing_platform(options = {}) ⇒ Types::GetSigningPlatformResponse

#get_signing_profile(options = {}) ⇒ Types::GetSigningProfileResponse

#list_signing_jobs(options = {}) ⇒ Types::ListSigningJobsResponse

#list_signing_platforms(options = {}) ⇒ Types::ListSigningPlatformsResponse

#list_signing_profiles(options = {}) ⇒ Types::ListSigningProfilesResponse

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

#put_signing_profile(options = {}) ⇒ Types::PutSigningProfileResponse

#start_signing_job(options = {}) ⇒ Types::StartSigningJobResponse

#tag_resource(options = {}) ⇒ Struct

#untag_resource(options = {}) ⇒ Struct

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::Signer::Client`

#cancel_signing_profile(options = {}) ⇒ `Struct`

#describe_signing_job(options = {}) ⇒ `Types::DescribeSigningJobResponse`

#get_signing_platform(options = {}) ⇒ `Types::GetSigningPlatformResponse`

#get_signing_profile(options = {}) ⇒ `Types::GetSigningProfileResponse`

#list_signing_jobs(options = {}) ⇒ `Types::ListSigningJobsResponse`

#list_signing_platforms(options = {}) ⇒ `Types::ListSigningPlatformsResponse`

#list_signing_profiles(options = {}) ⇒ `Types::ListSigningProfilesResponse`

#list_tags_for_resource(options = {}) ⇒ `Types::ListTagsForResourceResponse`

#put_signing_profile(options = {}) ⇒ `Types::PutSigningProfileResponse`

#start_signing_job(options = {}) ⇒ `Types::StartSigningJobResponse`

#tag_resource(options = {}) ⇒ `Struct`

#untag_resource(options = {}) ⇒ `Struct`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`