Class: Aws::Signer::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Signer::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb
Overview
An API client for Signer. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Signer::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_profile_permission(params = {}) ⇒ Types::AddProfilePermissionResponse
Adds cross-account permissions to a signing profile.
-
#cancel_signing_profile(params = {}) ⇒ Struct
Changes the state of an
ACTIVE
signing profile toCANCELED
. -
#describe_signing_job(params = {}) ⇒ Types::DescribeSigningJobResponse
Returns information about a specific code signing job.
-
#get_signing_platform(params = {}) ⇒ Types::GetSigningPlatformResponse
Returns information on a specific signing platform.
-
#get_signing_profile(params = {}) ⇒ Types::GetSigningProfileResponse
Returns information on a specific signing profile.
-
#list_profile_permissions(params = {}) ⇒ Types::ListProfilePermissionsResponse
Lists the cross-account permissions associated with a signing profile.
-
#list_signing_jobs(params = {}) ⇒ Types::ListSigningJobsResponse
Lists all your signing jobs.
-
#list_signing_platforms(params = {}) ⇒ Types::ListSigningPlatformsResponse
Lists all signing platforms available in code signing that match the request parameters.
-
#list_signing_profiles(params = {}) ⇒ Types::ListSigningProfilesResponse
Lists all available signing profiles in your AWS account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags associated with a signing profile resource.
-
#put_signing_profile(params = {}) ⇒ Types::PutSigningProfileResponse
Creates a signing profile.
-
#remove_profile_permission(params = {}) ⇒ Types::RemoveProfilePermissionResponse
Removes cross-account permissions from a signing profile.
-
#revoke_signature(params = {}) ⇒ Struct
Changes the state of a signing job to REVOKED.
-
#revoke_signing_profile(params = {}) ⇒ Struct
Changes the state of a signing profile to REVOKED.
-
#start_signing_job(params = {}) ⇒ Types::StartSigningJobResponse
Initiates a signing job to be performed on the code provided.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a signing profile.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a signing profile.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
365 366 367 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#add_profile_permission(params = {}) ⇒ Types::AddProfilePermissionResponse
Adds cross-account permissions to a signing profile.
415 416 417 418 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 415 def (params = {}, = {}) req = build_request(:add_profile_permission, params) req.send_request() end |
#cancel_signing_profile(params = {}) ⇒ 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.
440 441 442 443 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 440 def cancel_signing_profile(params = {}, = {}) req = build_request(:cancel_signing_profile, params) req.send_request() end |
#describe_signing_job(params = {}) ⇒ 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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- successful_signing_job
519 520 521 522 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 519 def describe_signing_job(params = {}, = {}) req = build_request(:describe_signing_job, params) req.send_request() end |
#get_signing_platform(params = {}) ⇒ Types::GetSigningPlatformResponse
Returns information on a specific signing platform.
570 571 572 573 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 570 def get_signing_platform(params = {}, = {}) req = build_request(:get_signing_platform, params) req.send_request() end |
#get_signing_profile(params = {}) ⇒ Types::GetSigningProfileResponse
Returns information on a specific signing profile.
635 636 637 638 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 635 def get_signing_profile(params = {}, = {}) req = build_request(:get_signing_profile, params) req.send_request() end |
#list_profile_permissions(params = {}) ⇒ Types::ListProfilePermissionsResponse
Lists the cross-account permissions associated with a signing profile.
677 678 679 680 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 677 def (params = {}, = {}) req = build_request(:list_profile_permissions, params) req.send_request() end |
#list_signing_jobs(params = {}) ⇒ 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
776 777 778 779 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 776 def list_signing_jobs(params = {}, = {}) req = build_request(:list_signing_jobs, params) req.send_request() end |
#list_signing_platforms(params = {}) ⇒ 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
849 850 851 852 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 849 def list_signing_platforms(params = {}, = {}) req = build_request(:list_signing_platforms, params) req.send_request() end |
#list_signing_profiles(params = {}) ⇒ 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
923 924 925 926 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 923 def list_signing_profiles(params = {}, = {}) req = build_request(:list_signing_profiles, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags associated with a signing profile resource.
952 953 954 955 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 952 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_signing_profile(params = {}) ⇒ 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
1035 1036 1037 1038 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 1035 def put_signing_profile(params = {}, = {}) req = build_request(:put_signing_profile, params) req.send_request() end |
#remove_profile_permission(params = {}) ⇒ Types::RemoveProfilePermissionResponse
Removes cross-account permissions from a signing profile.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 1073 def (params = {}, = {}) req = build_request(:remove_profile_permission, params) req.send_request() end |
#revoke_signature(params = {}) ⇒ Struct
Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.
1104 1105 1106 1107 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 1104 def revoke_signature(params = {}, = {}) req = build_request(:revoke_signature, params) req.send_request() end |
#revoke_signing_profile(params = {}) ⇒ Struct
Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid.
1142 1143 1144 1145 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 1142 def revoke_signing_profile(params = {}, = {}) req = build_request(:revoke_signing_profile, params) req.send_request() end |
#start_signing_job(params = {}) ⇒ 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/
1232 1233 1234 1235 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 1232 def start_signing_job(params = {}, = {}) req = build_request(:start_signing_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ 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.
1264 1265 1266 1267 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 1264 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
1291 1292 1293 1294 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 1291 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
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(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
successful_signing_job | #describe_signing_job | 20 | 25 |
1401 1402 1403 1404 1405 |
# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/client.rb', line 1401 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |