aws-sdk-signer 1.17.0 → 1.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 953735d4dc87e531a6e8d7c5d9b9094146ccb650
4
- data.tar.gz: acc9ed91d1cd916efd23b4db8159641e84f78a0e
3
+ metadata.gz: acb9107d256cc32071eb567f83bf13e5d9d03918
4
+ data.tar.gz: 8d58d73814862e42f449a936584bb821fe28c2b0
5
5
  SHA512:
6
- metadata.gz: da645be34a7f44f48f48ed1a18337636c1dc5e19f61e659856270f3562f8a3a7fca3653eb99ea88c896c080ef819e48f9931983d08ad326e48c130a283bdca7b
7
- data.tar.gz: 87209f5206f2084845df34270d5d34df61450b8137f18d63760c1537bbd1e636593f7a9b711511bf1d2a555d3cf1a8009c306608d95ae6c0d33b825155ec8401
6
+ metadata.gz: 358de6e09e1b39715a2a396857b9f1ad6eb015697213d94ad232d90acbc9bdd6fd8f86eb3523d9d604271a50b18c1ef25bd6996beebc6ab1ecc28dda0f4cf773
7
+ data.tar.gz: c6f8eac8a0738e5e410e8b83d1dbad52933fa661a4bc60b32dbcbf3b4de12c13b15afdfbae64677fb5e139fdf0a599121340c1f9a036b0f4faecd1c9dd68c390
@@ -25,17 +25,20 @@ require_relative 'aws-sdk-signer/customizations'
25
25
  # methods each accept a hash of request parameters and return a response
26
26
  # structure.
27
27
  #
28
+ # signer = Aws::Signer::Client.new
29
+ # resp = signer.cancel_signing_profile(params)
30
+ #
28
31
  # See {Client} for more information.
29
32
  #
30
33
  # # Errors
31
34
  #
32
- # Errors returned from AWS Signer all
33
- # extend {Errors::ServiceError}.
35
+ # Errors returned from AWS Signer are defined in the
36
+ # {Errors} module and all extend {Errors::ServiceError}.
34
37
  #
35
38
  # begin
36
39
  # # do stuff
37
40
  # rescue Aws::Signer::Errors::ServiceError
38
- # # rescues all service API errors
41
+ # # rescues all AWS Signer API errors
39
42
  # end
40
43
  #
41
44
  # See {Errors} for more information.
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-signer/customizations'
43
46
  # @service
44
47
  module Aws::Signer
45
48
 
46
- GEM_VERSION = '1.17.0'
49
+ GEM_VERSION = '1.18.0'
47
50
 
48
51
  end
@@ -30,6 +30,16 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:signer)
31
31
 
32
32
  module Aws::Signer
33
+ # An API client for Signer. To construct a client, you need to configure a +:region+ and +:credentials+.
34
+ # client = Aws::Signer::Client.new(
35
+ # region: region_name,
36
+ # credentials: credentials,
37
+ # # ...
38
+ # )
39
+ # For details on configuring region and credentials see
40
+ # the {developer-guide}[https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html].
41
+ #
42
+ # See {#initialize} for a full list of supported configuration options.
33
43
  class Client < Seahorse::Client::Base
34
44
 
35
45
  include Aws::ClientStubs
@@ -209,16 +219,16 @@ module Aws::Signer
209
219
  # requests through. Formatted like 'http://proxy.com:123'.
210
220
  #
211
221
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
222
+ # seconds to wait when opening a HTTP session before raising a
213
223
  # `Timeout::Error`.
214
224
  #
215
225
  # @option options [Integer] :http_read_timeout (60) The default
216
226
  # number of seconds to wait for response data. This value can
217
227
  # safely be set
218
- # per-request on the session yeidled by {#session_for}.
228
+ # per-request on the session yielded by {#session_for}.
219
229
  #
220
230
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
231
+ # seconds a connection is allowed to sit idle before it is
222
232
  # considered stale. Stale connections are closed and removed
223
233
  # from the pool before making a request.
224
234
  #
@@ -227,7 +237,7 @@ module Aws::Signer
227
237
  # request body. This option has no effect unless the request has
228
238
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
239
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
240
+ # request on the session yielded by {#session_for}.
231
241
  #
232
242
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
243
  # HTTP debug output will be sent to the `:logger`.
@@ -319,6 +329,7 @@ module Aws::Signer
319
329
  # resp.profile_name #=> String
320
330
  # resp.overrides.signing_configuration.encryption_algorithm #=> String, one of "RSA", "ECDSA"
321
331
  # resp.overrides.signing_configuration.hash_algorithm #=> String, one of "SHA1", "SHA256"
332
+ # resp.overrides.signing_image_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
322
333
  # resp.signing_parameters #=> Hash
323
334
  # resp.signing_parameters["SigningParameterKey"] #=> String
324
335
  # resp.created_at #=> Time
@@ -374,8 +385,8 @@ module Aws::Signer
374
385
  # resp.signing_configuration.hash_algorithm_options.allowed_values[0] #=> String, one of "SHA1", "SHA256"
375
386
  # resp.signing_configuration.hash_algorithm_options.default_value #=> String, one of "SHA1", "SHA256"
376
387
  # resp.signing_image_format.supported_formats #=> Array
377
- # resp.signing_image_format.supported_formats[0] #=> String, one of "JSON"
378
- # resp.signing_image_format.default_format #=> String, one of "JSON"
388
+ # resp.signing_image_format.supported_formats[0] #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
389
+ # resp.signing_image_format.default_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
379
390
  # resp.max_size_in_mb #=> Integer
380
391
  #
381
392
  # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningPlatform AWS API Documentation
@@ -416,6 +427,7 @@ module Aws::Signer
416
427
  # resp.platform_id #=> String
417
428
  # resp.overrides.signing_configuration.encryption_algorithm #=> String, one of "RSA", "ECDSA"
418
429
  # resp.overrides.signing_configuration.hash_algorithm #=> String, one of "SHA1", "SHA256"
430
+ # resp.overrides.signing_image_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
419
431
  # resp.signing_parameters #=> Hash
420
432
  # resp.signing_parameters["SigningParameterKey"] #=> String
421
433
  # resp.status #=> String, one of "Active", "Canceled"
@@ -558,8 +570,8 @@ module Aws::Signer
558
570
  # resp.platforms[0].signing_configuration.hash_algorithm_options.allowed_values[0] #=> String, one of "SHA1", "SHA256"
559
571
  # resp.platforms[0].signing_configuration.hash_algorithm_options.default_value #=> String, one of "SHA1", "SHA256"
560
572
  # resp.platforms[0].signing_image_format.supported_formats #=> Array
561
- # resp.platforms[0].signing_image_format.supported_formats[0] #=> String, one of "JSON"
562
- # resp.platforms[0].signing_image_format.default_format #=> String, one of "JSON"
573
+ # resp.platforms[0].signing_image_format.supported_formats[0] #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
574
+ # resp.platforms[0].signing_image_format.default_format #=> String, one of "JSON", "JSONEmbedded", "JSONDetached"
563
575
  # resp.platforms[0].max_size_in_mb #=> Integer
564
576
  # resp.next_token #=> String
565
577
  #
@@ -675,7 +687,7 @@ module Aws::Signer
675
687
  # with the new signing profile.
676
688
  #
677
689
  # @option params [required, String] :platform_id
678
- # The ID of the signing profile to be created.
690
+ # The ID of the signing platform to be created.
679
691
  #
680
692
  # @option params [Types::SigningPlatformOverrides] :overrides
681
693
  # A subfield of `platform`. This specifies any different configuration
@@ -687,7 +699,7 @@ module Aws::Signer
687
699
  # that you want to use during signing.
688
700
  #
689
701
  # @option params [Hash<String,String>] :tags
690
- # Tags to be associated with the signing profile being created.
702
+ # Tags to be associated with the signing profile that is being created.
691
703
  #
692
704
  # @return [Types::PutSigningProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
693
705
  #
@@ -706,6 +718,7 @@ module Aws::Signer
706
718
  # encryption_algorithm: "RSA", # accepts RSA, ECDSA
707
719
  # hash_algorithm: "SHA1", # accepts SHA1, SHA256
708
720
  # },
721
+ # signing_image_format: "JSON", # accepts JSON, JSONEmbedded, JSONDetached
709
722
  # },
710
723
  # signing_parameters: {
711
724
  # "SigningParameterKey" => "SigningParameterValue",
@@ -814,12 +827,12 @@ module Aws::Signer
814
827
 
815
828
  # Adds one or more tags to a signing profile. Tags are labels that you
816
829
  # can use to identify and organize your AWS resources. Each tag consists
817
- # of a key and an optional value. You specify the signing profile using
818
- # its Amazon Resource Name (ARN). You specify the tag by using a
819
- # key-value pair.
830
+ # of a key and an optional value. To specify the signing profile, use
831
+ # its Amazon Resource Name (ARN). To specify the tag, use a key-value
832
+ # pair.
820
833
  #
821
834
  # @option params [required, String] :resource_arn
822
- # Amazon Resource Name (ARN) for the signing profile.
835
+ # The Amazon Resource Name (ARN) for the signing profile.
823
836
  #
824
837
  # @option params [required, Hash<String,String>] :tags
825
838
  # One or more tags to be associated with the signing profile.
@@ -844,14 +857,14 @@ module Aws::Signer
844
857
  req.send_request(options)
845
858
  end
846
859
 
847
- # Remove one or more tags from a signing profile. Specify a list of tag
848
- # keys to remove the tags.
860
+ # Removes one or more tags from a signing profile. To remove the tags,
861
+ # specify a list of tag keys.
849
862
  #
850
863
  # @option params [required, String] :resource_arn
851
- # Amazon Resource Name (ARN) for the signing profile .
864
+ # The Amazon Resource Name (ARN) for the signing profile.
852
865
  #
853
866
  # @option params [required, Array<String>] :tag_keys
854
- # A list of tag keys to be removed from the signing profile .
867
+ # A list of tag keys to be removed from the signing profile.
855
868
  #
856
869
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
857
870
  #
@@ -884,7 +897,7 @@ module Aws::Signer
884
897
  params: params,
885
898
  config: config)
886
899
  context[:gem_name] = 'aws-sdk-signer'
887
- context[:gem_version] = '1.17.0'
900
+ context[:gem_version] = '1.18.0'
888
901
  Seahorse::Client::Request.new(handlers, context)
889
902
  end
890
903
 
@@ -281,6 +281,7 @@ module Aws::Signer
281
281
  SigningPlatform.struct_class = Types::SigningPlatform
282
282
 
283
283
  SigningPlatformOverrides.add_member(:signing_configuration, Shapes::ShapeRef.new(shape: SigningConfigurationOverrides, location_name: "signingConfiguration"))
284
+ SigningPlatformOverrides.add_member(:signing_image_format, Shapes::ShapeRef.new(shape: ImageFormat, location_name: "signingImageFormat"))
284
285
  SigningPlatformOverrides.struct_class = Types::SigningPlatformOverrides
285
286
 
286
287
  SigningPlatforms.member = Shapes::ShapeRef.new(shape: SigningPlatform)
@@ -6,6 +6,39 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Signer
9
+
10
+ # When Signer returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::Signer::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all Signer errors using ServiceError:
14
+ # begin
15
+ # # do stuff
16
+ # rescue Aws::Signer::Errors::ServiceError
17
+ # # rescues all Signer API errors
18
+ # end
19
+ #
20
+ # ## Request Context
21
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
22
+ # information about the request that generated the error, including:
23
+ # *
24
+ # * #params - The request params
25
+ # * #operation_name - Name of the API operation invoked
26
+ # * #http_request
27
+ # * #http_response
28
+ # * etc ...
29
+ #
30
+ # See {Seahorse::Client::RequestContext} for more information.
31
+ #
32
+ # ## Error Classes
33
+ # * {AccessDeniedException}
34
+ # * {BadRequestException}
35
+ # * {InternalServiceErrorException}
36
+ # * {NotFoundException}
37
+ # * {ResourceNotFoundException}
38
+ # * {ThrottlingException}
39
+ # * {ValidationException}
40
+ # Additionally, error classes are dynamically generated for service errors based on the error code
41
+ # if they are not defined above.
9
42
  module Errors
10
43
 
11
44
  extend Aws::Errors::DynamicErrors
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Signer
9
+ # This class provides a resource oriented interface for Signer.
10
+ # To create a resource object:
11
+ # resource = Aws::Signer::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::Signer::Client.new(region: 'us-west-2')
15
+ # resource = Aws::Signer::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
@@ -80,7 +80,7 @@ module Aws::Signer
80
80
  # @return [Types::Source]
81
81
  #
82
82
  # @!attribute [rw] signing_material
83
- # Amazon Resource Name (ARN) of your code signing certificate.
83
+ # The Amazon Resource Name (ARN) of your code signing certificate.
84
84
  # @return [Types::SigningMaterial]
85
85
  #
86
86
  # @!attribute [rw] platform_id
@@ -586,6 +586,7 @@ module Aws::Signer
586
586
  # encryption_algorithm: "RSA", # accepts RSA, ECDSA
587
587
  # hash_algorithm: "SHA1", # accepts SHA1, SHA256
588
588
  # },
589
+ # signing_image_format: "JSON", # accepts JSON, JSONEmbedded, JSONDetached
589
590
  # },
590
591
  # signing_parameters: {
591
592
  # "SigningParameterKey" => "SigningParameterValue",
@@ -605,7 +606,7 @@ module Aws::Signer
605
606
  # @return [Types::SigningMaterial]
606
607
  #
607
608
  # @!attribute [rw] platform_id
608
- # The ID of the signing profile to be created.
609
+ # The ID of the signing platform to be created.
609
610
  # @return [String]
610
611
  #
611
612
  # @!attribute [rw] overrides
@@ -620,7 +621,8 @@ module Aws::Signer
620
621
  # @return [Hash<String,String>]
621
622
  #
622
623
  # @!attribute [rw] tags
623
- # Tags to be associated with the signing profile being created.
624
+ # Tags to be associated with the signing profile that is being
625
+ # created.
624
626
  # @return [Hash<String,String>]
625
627
  #
626
628
  # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/PutSigningProfileRequest AWS API Documentation
@@ -760,7 +762,7 @@ module Aws::Signer
760
762
  # @return [Types::EncryptionAlgorithmOptions]
761
763
  #
762
764
  # @!attribute [rw] hash_algorithm_options
763
- # The hash algorithm options that are available for a a code signing
765
+ # The hash algorithm options that are available for a code signing
764
766
  # job.
765
767
  # @return [Types::HashAlgorithmOptions]
766
768
  #
@@ -804,11 +806,11 @@ module Aws::Signer
804
806
  # The image format of a code signing platform or profile.
805
807
  #
806
808
  # @!attribute [rw] supported_formats
807
- # The supported formats of a code signing signing image.
809
+ # The supported formats of a code signing image.
808
810
  # @return [Array<String>]
809
811
  #
810
812
  # @!attribute [rw] default_format
811
- # The default format of a code signing signing image.
813
+ # The default format of a code signing image.
812
814
  # @return [String]
813
815
  #
814
816
  # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningImageFormat AWS API Documentation
@@ -882,7 +884,7 @@ module Aws::Signer
882
884
  end
883
885
 
884
886
  # Contains information about the signing configurations and parameters
885
- # that is used to perform a code signing job.
887
+ # that are used to perform a code signing job.
886
888
  #
887
889
  # @!attribute [rw] platform_id
888
890
  # The ID of a code signing; platform.
@@ -944,6 +946,7 @@ module Aws::Signer
944
946
  # encryption_algorithm: "RSA", # accepts RSA, ECDSA
945
947
  # hash_algorithm: "SHA1", # accepts SHA1, SHA256
946
948
  # },
949
+ # signing_image_format: "JSON", # accepts JSON, JSONEmbedded, JSONDetached
947
950
  # }
948
951
  #
949
952
  # @!attribute [rw] signing_configuration
@@ -951,10 +954,20 @@ module Aws::Signer
951
954
  # hash algorithm of a signing job.
952
955
  # @return [Types::SigningConfigurationOverrides]
953
956
  #
957
+ # @!attribute [rw] signing_image_format
958
+ # A signed image is a JSON object. When overriding the default signing
959
+ # platform configuration, a customer can select either of two signing
960
+ # formats, `JSONEmbedded` or `JSONDetached`. (A third format value,
961
+ # `JSON`, is reserved for future use.) With `JSONEmbedded`, the
962
+ # signing image has the payload embedded in it. With `JSONDetached`,
963
+ # the payload is not be embedded in the signing image.
964
+ # @return [String]
965
+ #
954
966
  # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningPlatformOverrides AWS API Documentation
955
967
  #
956
968
  class SigningPlatformOverrides < Struct.new(
957
- :signing_configuration)
969
+ :signing_configuration,
970
+ :signing_image_format)
958
971
  include Aws::Structure
959
972
  end
960
973
 
@@ -983,7 +996,7 @@ module Aws::Signer
983
996
  # @return [String]
984
997
  #
985
998
  # @!attribute [rw] arn
986
- # Amazon Resource Name (ARN) for the signing profile.
999
+ # The Amazon Resource Name (ARN) for the signing profile.
987
1000
  # @return [String]
988
1001
  #
989
1002
  # @!attribute [rw] tags
@@ -1104,7 +1117,7 @@ module Aws::Signer
1104
1117
  # }
1105
1118
  #
1106
1119
  # @!attribute [rw] resource_arn
1107
- # Amazon Resource Name (ARN) for the signing profile.
1120
+ # The Amazon Resource Name (ARN) for the signing profile.
1108
1121
  # @return [String]
1109
1122
  #
1110
1123
  # @!attribute [rw] tags
@@ -1144,11 +1157,11 @@ module Aws::Signer
1144
1157
  # }
1145
1158
  #
1146
1159
  # @!attribute [rw] resource_arn
1147
- # Amazon Resource Name (ARN) for the signing profile .
1160
+ # The Amazon Resource Name (ARN) for the signing profile.
1148
1161
  # @return [String]
1149
1162
  #
1150
1163
  # @!attribute [rw] tag_keys
1151
- # A list of tag keys to be removed from the signing profile .
1164
+ # A list of tag keys to be removed from the signing profile.
1152
1165
  # @return [Array<String>]
1153
1166
  #
1154
1167
  # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/UntagResourceRequest AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-signer
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.0
4
+ version: 1.18.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: 2019-11-06 00:00:00.000000000 Z
11
+ date: 2020-03-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core