aws-sdk-iot 1.0.0.rc1 → 1.0.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9c865cbf91f2a0c3e73a2bede8693234a4679212
4
- data.tar.gz: ad22e0abddd8082572d86fa9743fee7f2d25dece
3
+ metadata.gz: 9fd6eb264ae9e74174f61f3367405f587e06cd1b
4
+ data.tar.gz: fcf5f570865549cb56aa578aa9533e10d754732a
5
5
  SHA512:
6
- metadata.gz: 2c573509125a7fb5420f3faec79c75f4f4bb387b97e2b357d2ad4f82d7a3d2bf026c0d14568237349243355c662ff5d0ad225715827d4695060feedde28320da
7
- data.tar.gz: b1ec077a2561f1d7a53b1a4ab5859f9bb4a7b1873a06b41cab1312aff2a8c41f133d3deecb442a5735081959d376fd4b90d1af63cadd18279e9981f7dde76f9f
6
+ metadata.gz: 561d7ef8d9ab56701c1a39b3258f4ba7c570b1044a67fe8d90e65754ab7984d3555e407360768573b90225853c0bac128adbb56d5202814aa25fc2064273268b
7
+ data.tar.gz: 07f896a262910e75d4df8f805ac45b682c13210e6c677904f8d013a41ad46d273d33258aa1145a3d8abe8236234db13b4ff635bfec27160bde3e5a0242b1ec21
data/lib/aws-sdk-iot.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-iot/customizations'
42
42
  # @service
43
43
  module Aws::IoT
44
44
 
45
- GEM_VERSION = '1.0.0.rc1'
45
+ GEM_VERSION = '1.0.0.rc2'
46
46
 
47
47
  end
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -18,1998 +18,2315 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
18
  require 'aws-sdk-core/plugins/response_paging.rb'
19
19
  require 'aws-sdk-core/plugins/stub_responses.rb'
20
20
  require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
21
22
  require 'aws-sdk-core/plugins/signature_v4.rb'
22
23
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
23
24
 
24
25
  Aws::Plugins::GlobalConfiguration.add_identifier(:iot)
25
26
 
26
- module Aws
27
- module IoT
28
- class Client < Seahorse::Client::Base
29
-
30
- include Aws::ClientStubs
31
-
32
- @identifier = :iot
33
-
34
- set_api(ClientApi::API)
35
-
36
- add_plugin(Seahorse::Client::Plugins::ContentLength)
37
- add_plugin(Aws::Plugins::CredentialsConfiguration)
38
- add_plugin(Aws::Plugins::Logging)
39
- add_plugin(Aws::Plugins::ParamConverter)
40
- add_plugin(Aws::Plugins::ParamValidator)
41
- add_plugin(Aws::Plugins::UserAgent)
42
- add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
- add_plugin(Aws::Plugins::RetryErrors)
44
- add_plugin(Aws::Plugins::GlobalConfiguration)
45
- add_plugin(Aws::Plugins::RegionalEndpoint)
46
- add_plugin(Aws::Plugins::ResponsePaging)
47
- add_plugin(Aws::Plugins::StubResponses)
48
- add_plugin(Aws::Plugins::IdempotencyToken)
49
- add_plugin(Aws::Plugins::SignatureV4)
50
- add_plugin(Aws::Plugins::Protocols::RestJson)
51
-
52
- # @option options [required, Aws::CredentialProvider] :credentials
53
- # Your AWS credentials. This can be an instance of any one of the
54
- # following classes:
55
- #
56
- # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
- # credentials.
58
- #
59
- # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
- # from an EC2 IMDS on an EC2 instance.
61
- #
62
- # * `Aws::SharedCredentials` - Used for loading credentials from a
63
- # shared file, such as `~/.aws/config`.
64
- #
65
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
- #
67
- # When `:credentials` are not configured directly, the following
68
- # locations will be searched for credentials:
69
- #
70
- # * `Aws.config[:credentials]`
71
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
- # * `~/.aws/credentials`
74
- # * `~/.aws/config`
75
- # * EC2 IMDS instance profile - When used by default, the timeouts are
76
- # very aggressive. Construct and pass an instance of
77
- # `Aws::InstanceProfileCredentails` to enable retries and extended
78
- # timeouts.
79
- # @option options [required, String] :region
80
- # The AWS region to connect to. The configured `:region` is
81
- # used to determine the service `:endpoint`. When not passed,
82
- # a default `:region` is search for in the following locations:
83
- #
84
- # * `Aws.config[:region]`
85
- # * `ENV['AWS_REGION']`
86
- # * `ENV['AMAZON_REGION']`
87
- # * `ENV['AWS_DEFAULT_REGION']`
88
- # * `~/.aws/credentials`
89
- # * `~/.aws/config`
90
- # @option options [String] :access_key_id
91
- # @option options [Boolean] :convert_params (true)
92
- # When `true`, an attempt is made to coerce request parameters into
93
- # the required types.
94
- # @option options [String] :endpoint
95
- # The client endpoint is normally constructed from the `:region`
96
- # option. You should only configure an `:endpoint` when connecting
97
- # to test endpoints. This should be avalid HTTP(S) URI.
98
- # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
- # The log formatter.
100
- # @option options [Symbol] :log_level (:info)
101
- # The log level to send messages to the `:logger` at.
102
- # @option options [Logger] :logger
103
- # The Logger instance to send log messages to. If this option
104
- # is not set, logging will be disabled.
105
- # @option options [String] :profile ("default")
106
- # Used when loading credentials from the shared credentials file
107
- # at HOME/.aws/credentials. When not specified, 'default' is used.
108
- # @option options [Integer] :retry_limit (3)
109
- # The maximum number of times to retry failed requests. Only
110
- # ~ 500 level server errors and certain ~ 400 level client errors
111
- # are retried. Generally, these are throttling errors, data
112
- # checksum errors, networking errors, timeout errors and auth
113
- # errors from expired credentials.
114
- # @option options [String] :secret_access_key
115
- # @option options [String] :session_token
116
- # @option options [Boolean] :stub_responses (false)
117
- # Causes the client to return stubbed responses. By default
118
- # fake responses are generated and returned. You can specify
119
- # the response data to return or errors to raise by calling
120
- # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
121
- #
122
- # ** Please note ** When response stubbing is enabled, no HTTP
123
- # requests are made, and retries are disabled.
124
- # @option options [Boolean] :validate_params (true)
125
- # When `true`, request parameters are validated before
126
- # sending the request.
127
- def initialize(*args)
128
- super
129
- end
27
+ module Aws::IoT
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :iot
33
+
34
+ set_api(ClientApi::API)
35
+
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::RestJson)
52
+
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
99
+ # @option options [String] :endpoint
100
+ # The client endpoint is normally constructed from the `:region`
101
+ # option. You should only configure an `:endpoint` when connecting
102
+ # to test endpoints. This should be avalid HTTP(S) URI.
103
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :stub_responses (false)
130
+ # Causes the client to return stubbed responses. By default
131
+ # fake responses are generated and returned. You can specify
132
+ # the response data to return or errors to raise by calling
133
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
134
+ #
135
+ # ** Please note ** When response stubbing is enabled, no HTTP
136
+ # requests are made, and retries are disabled.
137
+ #
138
+ # @option options [Boolean] :validate_params (true)
139
+ # When `true`, request parameters are validated before
140
+ # sending the request.
141
+ #
142
+ def initialize(*args)
143
+ super
144
+ end
130
145
 
131
- # @!group API Operations
132
-
133
- # Accepts a pending certificate transfer. The default state of the
134
- # certificate is INACTIVE.
135
- #
136
- # To check for pending certificate transfers, call ListCertificates to
137
- # enumerate your certificates.
138
- # @option params [required, String] :certificate_id
139
- # The ID of the certificate.
140
- # @option params [Boolean] :set_as_active
141
- # Specifies whether the certificate is active.
142
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
143
- #
144
- # @example Request syntax with placeholder values
145
- # resp = client.accept_certificate_transfer({
146
- # certificate_id: "CertificateId", # required
147
- # set_as_active: false,
148
- # })
149
- # @overload accept_certificate_transfer(params = {})
150
- # @param [Hash] params ({})
151
- def accept_certificate_transfer(params = {}, options = {})
152
- req = build_request(:accept_certificate_transfer, params)
153
- req.send_request(options)
154
- end
146
+ # @!group API Operations
147
+
148
+ # Accepts a pending certificate transfer. The default state of the
149
+ # certificate is INACTIVE.
150
+ #
151
+ # To check for pending certificate transfers, call ListCertificates to
152
+ # enumerate your certificates.
153
+ #
154
+ # @option params [required, String] :certificate_id
155
+ # The ID of the certificate.
156
+ #
157
+ # @option params [Boolean] :set_as_active
158
+ # Specifies whether the certificate is active.
159
+ #
160
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
161
+ #
162
+ # @example Request syntax with placeholder values
163
+ #
164
+ # resp = client.accept_certificate_transfer({
165
+ # certificate_id: "CertificateId", # required
166
+ # set_as_active: false,
167
+ # })
168
+ #
169
+ # @overload accept_certificate_transfer(params = {})
170
+ # @param [Hash] params ({})
171
+ def accept_certificate_transfer(params = {}, options = {})
172
+ req = build_request(:accept_certificate_transfer, params)
173
+ req.send_request(options)
174
+ end
155
175
 
156
- # Attaches the specified policy to the specified principal (certificate
157
- # or other credential).
158
- # @option params [required, String] :policy_name
159
- # The policy name.
160
- # @option params [required, String] :principal
161
- # The principal, which can be a certificate ARN (as returned from the
162
- # CreateCertificate operation) or an Amazon Cognito ID.
163
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
164
- #
165
- # @example Request syntax with placeholder values
166
- # resp = client.attach_principal_policy({
167
- # policy_name: "PolicyName", # required
168
- # principal: "Principal", # required
169
- # })
170
- # @overload attach_principal_policy(params = {})
171
- # @param [Hash] params ({})
172
- def attach_principal_policy(params = {}, options = {})
173
- req = build_request(:attach_principal_policy, params)
174
- req.send_request(options)
175
- end
176
+ # Attaches the specified policy to the specified principal (certificate
177
+ # or other credential).
178
+ #
179
+ # @option params [required, String] :policy_name
180
+ # The policy name.
181
+ #
182
+ # @option params [required, String] :principal
183
+ # The principal, which can be a certificate ARN (as returned from the
184
+ # CreateCertificate operation) or an Amazon Cognito ID.
185
+ #
186
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
187
+ #
188
+ # @example Request syntax with placeholder values
189
+ #
190
+ # resp = client.attach_principal_policy({
191
+ # policy_name: "PolicyName", # required
192
+ # principal: "Principal", # required
193
+ # })
194
+ #
195
+ # @overload attach_principal_policy(params = {})
196
+ # @param [Hash] params ({})
197
+ def attach_principal_policy(params = {}, options = {})
198
+ req = build_request(:attach_principal_policy, params)
199
+ req.send_request(options)
200
+ end
176
201
 
177
- # Attaches the specified principal to the specified thing.
178
- # @option params [required, String] :thing_name
179
- # The name of the thing.
180
- # @option params [required, String] :principal
181
- # The principal, such as a certificate or other credential.
182
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
183
- #
184
- # @example Request syntax with placeholder values
185
- # resp = client.attach_thing_principal({
186
- # thing_name: "ThingName", # required
187
- # principal: "Principal", # required
188
- # })
189
- # @overload attach_thing_principal(params = {})
190
- # @param [Hash] params ({})
191
- def attach_thing_principal(params = {}, options = {})
192
- req = build_request(:attach_thing_principal, params)
193
- req.send_request(options)
194
- end
202
+ # Attaches the specified principal to the specified thing.
203
+ #
204
+ # @option params [required, String] :thing_name
205
+ # The name of the thing.
206
+ #
207
+ # @option params [required, String] :principal
208
+ # The principal, such as a certificate or other credential.
209
+ #
210
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
211
+ #
212
+ # @example Request syntax with placeholder values
213
+ #
214
+ # resp = client.attach_thing_principal({
215
+ # thing_name: "ThingName", # required
216
+ # principal: "Principal", # required
217
+ # })
218
+ #
219
+ # @overload attach_thing_principal(params = {})
220
+ # @param [Hash] params ({})
221
+ def attach_thing_principal(params = {}, options = {})
222
+ req = build_request(:attach_thing_principal, params)
223
+ req.send_request(options)
224
+ end
195
225
 
196
- # Cancels a pending transfer for the specified certificate.
197
- #
198
- # **Note** Only the transfer source account can use this operation to
199
- # cancel a transfer. (Transfer destinations can use
200
- # RejectCertificateTransfer instead.) After transfer, AWS IoT returns
201
- # the certificate to the source account in the INACTIVE state. After the
202
- # destination account has accepted the transfer, the transfer cannot be
203
- # cancelled.
204
- #
205
- # After a certificate transfer is cancelled, the status of the
206
- # certificate changes from PENDING\_TRANSFER to INACTIVE.
207
- # @option params [required, String] :certificate_id
208
- # The ID of the certificate.
209
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
210
- #
211
- # @example Request syntax with placeholder values
212
- # resp = client.cancel_certificate_transfer({
213
- # certificate_id: "CertificateId", # required
214
- # })
215
- # @overload cancel_certificate_transfer(params = {})
216
- # @param [Hash] params ({})
217
- def cancel_certificate_transfer(params = {}, options = {})
218
- req = build_request(:cancel_certificate_transfer, params)
219
- req.send_request(options)
220
- end
226
+ # Cancels a pending transfer for the specified certificate.
227
+ #
228
+ # **Note** Only the transfer source account can use this operation to
229
+ # cancel a transfer. (Transfer destinations can use
230
+ # RejectCertificateTransfer instead.) After transfer, AWS IoT returns
231
+ # the certificate to the source account in the INACTIVE state. After the
232
+ # destination account has accepted the transfer, the transfer cannot be
233
+ # cancelled.
234
+ #
235
+ # After a certificate transfer is cancelled, the status of the
236
+ # certificate changes from PENDING\_TRANSFER to INACTIVE.
237
+ #
238
+ # @option params [required, String] :certificate_id
239
+ # The ID of the certificate.
240
+ #
241
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
242
+ #
243
+ # @example Request syntax with placeholder values
244
+ #
245
+ # resp = client.cancel_certificate_transfer({
246
+ # certificate_id: "CertificateId", # required
247
+ # })
248
+ #
249
+ # @overload cancel_certificate_transfer(params = {})
250
+ # @param [Hash] params ({})
251
+ def cancel_certificate_transfer(params = {}, options = {})
252
+ req = build_request(:cancel_certificate_transfer, params)
253
+ req.send_request(options)
254
+ end
221
255
 
222
- # Creates an X.509 certificate using the specified certificate signing
223
- # request.
224
- #
225
- # **Note** Reusing the same certificate signing request (CSR) results in
226
- # a distinct certificate.
227
- #
228
- # You can create multiple certificates in a batch by creating a
229
- # directory, copying multiple .csr files into that directory, and then
230
- # specifying that directory on the command line. The following commands
231
- # show how to create a batch of certificates given a batch of CSRs.
232
- #
233
- # Assuming a set of CSRs are located inside of the directory
234
- # my-csr-directory:
235
- #
236
- # On Linux and OS X, the command is:
237
- #
238
- # $ ls my-csr-directory/ \| xargs -I \\\{\\} aws iot
239
- # create-certificate-from-csr --certificate-signing-request
240
- # file://my-csr-directory/\\\{\\}
241
- #
242
- # This command lists all of the CSRs in my-csr-directory and pipes each
243
- # CSR file name to the aws iot create-certificate-from-csr AWS CLI
244
- # command to create a certificate for the corresponding CSR.
245
- #
246
- # The aws iot create-certificate-from-csr part of the command can also
247
- # be run in parallel to speed up the certificate creation process:
248
- #
249
- # $ ls my-csr-directory/ \| xargs -P 10 -I \\\{\\} aws iot
250
- # create-certificate-from-csr --certificate-signing-request
251
- # file://my-csr-directory/\\\{\\}
252
- #
253
- # On Windows PowerShell, the command to create certificates for all CSRs
254
- # in my-csr-directory is:
255
- #
256
- # &gt; ls -Name my-csr-directory \| %\\\{aws iot
257
- # create-certificate-from-csr --certificate-signing-request
258
- # file://my-csr-directory/$\_\\}
259
- #
260
- # On a Windows command prompt, the command to create certificates for
261
- # all CSRs in my-csr-directory is:
262
- #
263
- # &gt; forfiles /p my-csr-directory /c "cmd /c aws iot
264
- # create-certificate-from-csr --certificate-signing-request
265
- # file://@path"
266
- # @option params [required, String] :certificate_signing_request
267
- # The certificate signing request (CSR).
268
- # @option params [Boolean] :set_as_active
269
- # Specifies whether the certificate is active.
270
- # @return [Types::CreateCertificateFromCsrResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
271
- #
272
- # * {Types::CreateCertificateFromCsrResponse#certificate_arn #certificateArn} => String
273
- # * {Types::CreateCertificateFromCsrResponse#certificate_id #certificateId} => String
274
- # * {Types::CreateCertificateFromCsrResponse#certificate_pem #certificatePem} => String
275
- #
276
- # @example Request syntax with placeholder values
277
- # resp = client.create_certificate_from_csr({
278
- # certificate_signing_request: "CertificateSigningRequest", # required
279
- # set_as_active: false,
280
- # })
281
- #
282
- # @example Response structure
283
- # resp.certificate_arn #=> String
284
- # resp.certificate_id #=> String
285
- # resp.certificate_pem #=> String
286
- # @overload create_certificate_from_csr(params = {})
287
- # @param [Hash] params ({})
288
- def create_certificate_from_csr(params = {}, options = {})
289
- req = build_request(:create_certificate_from_csr, params)
290
- req.send_request(options)
291
- end
256
+ # Creates an X.509 certificate using the specified certificate signing
257
+ # request.
258
+ #
259
+ # **Note** Reusing the same certificate signing request (CSR) results in
260
+ # a distinct certificate.
261
+ #
262
+ # You can create multiple certificates in a batch by creating a
263
+ # directory, copying multiple .csr files into that directory, and then
264
+ # specifying that directory on the command line. The following commands
265
+ # show how to create a batch of certificates given a batch of CSRs.
266
+ #
267
+ # Assuming a set of CSRs are located inside of the directory
268
+ # my-csr-directory:
269
+ #
270
+ # On Linux and OS X, the command is:
271
+ #
272
+ # $ ls my-csr-directory/ \| xargs -I \\\{\\} aws iot
273
+ # create-certificate-from-csr --certificate-signing-request
274
+ # file://my-csr-directory/\\\{\\}
275
+ #
276
+ # This command lists all of the CSRs in my-csr-directory and pipes each
277
+ # CSR file name to the aws iot create-certificate-from-csr AWS CLI
278
+ # command to create a certificate for the corresponding CSR.
279
+ #
280
+ # The aws iot create-certificate-from-csr part of the command can also
281
+ # be run in parallel to speed up the certificate creation process:
282
+ #
283
+ # $ ls my-csr-directory/ \| xargs -P 10 -I \\\{\\} aws iot
284
+ # create-certificate-from-csr --certificate-signing-request
285
+ # file://my-csr-directory/\\\{\\}
286
+ #
287
+ # On Windows PowerShell, the command to create certificates for all CSRs
288
+ # in my-csr-directory is:
289
+ #
290
+ # &gt; ls -Name my-csr-directory \| %\\\{aws iot
291
+ # create-certificate-from-csr --certificate-signing-request
292
+ # file://my-csr-directory/$\_\\}
293
+ #
294
+ # On a Windows command prompt, the command to create certificates for
295
+ # all CSRs in my-csr-directory is:
296
+ #
297
+ # &gt; forfiles /p my-csr-directory /c "cmd /c aws iot
298
+ # create-certificate-from-csr --certificate-signing-request
299
+ # file://@path"
300
+ #
301
+ # @option params [required, String] :certificate_signing_request
302
+ # The certificate signing request (CSR).
303
+ #
304
+ # @option params [Boolean] :set_as_active
305
+ # Specifies whether the certificate is active.
306
+ #
307
+ # @return [Types::CreateCertificateFromCsrResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
308
+ #
309
+ # * {Types::CreateCertificateFromCsrResponse#certificate_arn #certificate_arn} => String
310
+ # * {Types::CreateCertificateFromCsrResponse#certificate_id #certificate_id} => String
311
+ # * {Types::CreateCertificateFromCsrResponse#certificate_pem #certificate_pem} => String
312
+ #
313
+ # @example Request syntax with placeholder values
314
+ #
315
+ # resp = client.create_certificate_from_csr({
316
+ # certificate_signing_request: "CertificateSigningRequest", # required
317
+ # set_as_active: false,
318
+ # })
319
+ #
320
+ # @example Response structure
321
+ #
322
+ # resp.certificate_arn #=> String
323
+ # resp.certificate_id #=> String
324
+ # resp.certificate_pem #=> String
325
+ #
326
+ # @overload create_certificate_from_csr(params = {})
327
+ # @param [Hash] params ({})
328
+ def create_certificate_from_csr(params = {}, options = {})
329
+ req = build_request(:create_certificate_from_csr, params)
330
+ req.send_request(options)
331
+ end
292
332
 
293
- # Creates a 2048-bit RSA key pair and issues an X.509 certificate using
294
- # the issued public key.
295
- #
296
- # **Note** This is the only time AWS IoT issues the private key for this
297
- # certificate, so it is important to keep it in a secure location.
298
- # @option params [Boolean] :set_as_active
299
- # Specifies whether the certificate is active.
300
- # @return [Types::CreateKeysAndCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
301
- #
302
- # * {Types::CreateKeysAndCertificateResponse#certificate_arn #certificateArn} => String
303
- # * {Types::CreateKeysAndCertificateResponse#certificate_id #certificateId} => String
304
- # * {Types::CreateKeysAndCertificateResponse#certificate_pem #certificatePem} => String
305
- # * {Types::CreateKeysAndCertificateResponse#key_pair #keyPair} => Types::KeyPair
306
- #
307
- # @example Request syntax with placeholder values
308
- # resp = client.create_keys_and_certificate({
309
- # set_as_active: false,
310
- # })
311
- #
312
- # @example Response structure
313
- # resp.certificate_arn #=> String
314
- # resp.certificate_id #=> String
315
- # resp.certificate_pem #=> String
316
- # resp.key_pair.public_key #=> String
317
- # resp.key_pair.private_key #=> String
318
- # @overload create_keys_and_certificate(params = {})
319
- # @param [Hash] params ({})
320
- def create_keys_and_certificate(params = {}, options = {})
321
- req = build_request(:create_keys_and_certificate, params)
322
- req.send_request(options)
323
- end
333
+ # Creates a 2048-bit RSA key pair and issues an X.509 certificate using
334
+ # the issued public key.
335
+ #
336
+ # **Note** This is the only time AWS IoT issues the private key for this
337
+ # certificate, so it is important to keep it in a secure location.
338
+ #
339
+ # @option params [Boolean] :set_as_active
340
+ # Specifies whether the certificate is active.
341
+ #
342
+ # @return [Types::CreateKeysAndCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
343
+ #
344
+ # * {Types::CreateKeysAndCertificateResponse#certificate_arn #certificate_arn} => String
345
+ # * {Types::CreateKeysAndCertificateResponse#certificate_id #certificate_id} => String
346
+ # * {Types::CreateKeysAndCertificateResponse#certificate_pem #certificate_pem} => String
347
+ # * {Types::CreateKeysAndCertificateResponse#key_pair #key_pair} => Types::KeyPair
348
+ #
349
+ # @example Request syntax with placeholder values
350
+ #
351
+ # resp = client.create_keys_and_certificate({
352
+ # set_as_active: false,
353
+ # })
354
+ #
355
+ # @example Response structure
356
+ #
357
+ # resp.certificate_arn #=> String
358
+ # resp.certificate_id #=> String
359
+ # resp.certificate_pem #=> String
360
+ # resp.key_pair.public_key #=> String
361
+ # resp.key_pair.private_key #=> String
362
+ #
363
+ # @overload create_keys_and_certificate(params = {})
364
+ # @param [Hash] params ({})
365
+ def create_keys_and_certificate(params = {}, options = {})
366
+ req = build_request(:create_keys_and_certificate, params)
367
+ req.send_request(options)
368
+ end
324
369
 
325
- # Creates an AWS IoT policy.
326
- #
327
- # The created policy is the default version for the policy. This
328
- # operation creates a policy version with a version identifier of **1**
329
- # and sets **1** as the policy's default version.
330
- # @option params [required, String] :policy_name
331
- # The policy name.
332
- # @option params [required, String] :policy_document
333
- # The JSON document that describes the policy. **policyDocument** must
334
- # have a minimum length of 1, with a maximum length of 2048, excluding
335
- # whitespace.
336
- # @return [Types::CreatePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
337
- #
338
- # * {Types::CreatePolicyResponse#policy_name #policyName} => String
339
- # * {Types::CreatePolicyResponse#policy_arn #policyArn} => String
340
- # * {Types::CreatePolicyResponse#policy_document #policyDocument} => String
341
- # * {Types::CreatePolicyResponse#policy_version_id #policyVersionId} => String
342
- #
343
- # @example Request syntax with placeholder values
344
- # resp = client.create_policy({
345
- # policy_name: "PolicyName", # required
346
- # policy_document: "PolicyDocument", # required
347
- # })
348
- #
349
- # @example Response structure
350
- # resp.policy_name #=> String
351
- # resp.policy_arn #=> String
352
- # resp.policy_document #=> String
353
- # resp.policy_version_id #=> String
354
- # @overload create_policy(params = {})
355
- # @param [Hash] params ({})
356
- def create_policy(params = {}, options = {})
357
- req = build_request(:create_policy, params)
358
- req.send_request(options)
359
- end
370
+ # Creates an AWS IoT policy.
371
+ #
372
+ # The created policy is the default version for the policy. This
373
+ # operation creates a policy version with a version identifier of **1**
374
+ # and sets **1** as the policy's default version.
375
+ #
376
+ # @option params [required, String] :policy_name
377
+ # The policy name.
378
+ #
379
+ # @option params [required, String] :policy_document
380
+ # The JSON document that describes the policy. **policyDocument** must
381
+ # have a minimum length of 1, with a maximum length of 2048, excluding
382
+ # whitespace.
383
+ #
384
+ # @return [Types::CreatePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
385
+ #
386
+ # * {Types::CreatePolicyResponse#policy_name #policy_name} => String
387
+ # * {Types::CreatePolicyResponse#policy_arn #policy_arn} => String
388
+ # * {Types::CreatePolicyResponse#policy_document #policy_document} => String
389
+ # * {Types::CreatePolicyResponse#policy_version_id #policy_version_id} => String
390
+ #
391
+ # @example Request syntax with placeholder values
392
+ #
393
+ # resp = client.create_policy({
394
+ # policy_name: "PolicyName", # required
395
+ # policy_document: "PolicyDocument", # required
396
+ # })
397
+ #
398
+ # @example Response structure
399
+ #
400
+ # resp.policy_name #=> String
401
+ # resp.policy_arn #=> String
402
+ # resp.policy_document #=> String
403
+ # resp.policy_version_id #=> String
404
+ #
405
+ # @overload create_policy(params = {})
406
+ # @param [Hash] params ({})
407
+ def create_policy(params = {}, options = {})
408
+ req = build_request(:create_policy, params)
409
+ req.send_request(options)
410
+ end
360
411
 
361
- # Creates a new version of the specified AWS IoT policy. To update a
362
- # policy, create a new policy version. A managed policy can have up to
363
- # five versions. If the policy has five versions, you must use
364
- # DeletePolicyVersion to delete an existing version before you create a
365
- # new one.
366
- #
367
- # Optionally, you can set the new version as the policy's default
368
- # version. The default version is the operative version (that is, the
369
- # version that is in effect for the certificates to which the policy is
370
- # attached).
371
- # @option params [required, String] :policy_name
372
- # The policy name.
373
- # @option params [required, String] :policy_document
374
- # The JSON document that describes the policy. Minimum length of 1.
375
- # Maximum length of 2048, excluding whitespaces
376
- # @option params [Boolean] :set_as_default
377
- # Specifies whether the policy version is set as the default. When this
378
- # parameter is true, the new policy version becomes the operative
379
- # version (that is, the version that is in effect for the certificates
380
- # to which the policy is attached).
381
- # @return [Types::CreatePolicyVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
382
- #
383
- # * {Types::CreatePolicyVersionResponse#policy_arn #policyArn} => String
384
- # * {Types::CreatePolicyVersionResponse#policy_document #policyDocument} => String
385
- # * {Types::CreatePolicyVersionResponse#policy_version_id #policyVersionId} => String
386
- # * {Types::CreatePolicyVersionResponse#is_default_version #isDefaultVersion} => Boolean
387
- #
388
- # @example Request syntax with placeholder values
389
- # resp = client.create_policy_version({
390
- # policy_name: "PolicyName", # required
391
- # policy_document: "PolicyDocument", # required
392
- # set_as_default: false,
393
- # })
394
- #
395
- # @example Response structure
396
- # resp.policy_arn #=> String
397
- # resp.policy_document #=> String
398
- # resp.policy_version_id #=> String
399
- # resp.is_default_version #=> Boolean
400
- # @overload create_policy_version(params = {})
401
- # @param [Hash] params ({})
402
- def create_policy_version(params = {}, options = {})
403
- req = build_request(:create_policy_version, params)
404
- req.send_request(options)
405
- end
412
+ # Creates a new version of the specified AWS IoT policy. To update a
413
+ # policy, create a new policy version. A managed policy can have up to
414
+ # five versions. If the policy has five versions, you must use
415
+ # DeletePolicyVersion to delete an existing version before you create a
416
+ # new one.
417
+ #
418
+ # Optionally, you can set the new version as the policy's default
419
+ # version. The default version is the operative version (that is, the
420
+ # version that is in effect for the certificates to which the policy is
421
+ # attached).
422
+ #
423
+ # @option params [required, String] :policy_name
424
+ # The policy name.
425
+ #
426
+ # @option params [required, String] :policy_document
427
+ # The JSON document that describes the policy. Minimum length of 1.
428
+ # Maximum length of 2048, excluding whitespaces
429
+ #
430
+ # @option params [Boolean] :set_as_default
431
+ # Specifies whether the policy version is set as the default. When this
432
+ # parameter is true, the new policy version becomes the operative
433
+ # version (that is, the version that is in effect for the certificates
434
+ # to which the policy is attached).
435
+ #
436
+ # @return [Types::CreatePolicyVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
437
+ #
438
+ # * {Types::CreatePolicyVersionResponse#policy_arn #policy_arn} => String
439
+ # * {Types::CreatePolicyVersionResponse#policy_document #policy_document} => String
440
+ # * {Types::CreatePolicyVersionResponse#policy_version_id #policy_version_id} => String
441
+ # * {Types::CreatePolicyVersionResponse#is_default_version #is_default_version} => Boolean
442
+ #
443
+ # @example Request syntax with placeholder values
444
+ #
445
+ # resp = client.create_policy_version({
446
+ # policy_name: "PolicyName", # required
447
+ # policy_document: "PolicyDocument", # required
448
+ # set_as_default: false,
449
+ # })
450
+ #
451
+ # @example Response structure
452
+ #
453
+ # resp.policy_arn #=> String
454
+ # resp.policy_document #=> String
455
+ # resp.policy_version_id #=> String
456
+ # resp.is_default_version #=> Boolean
457
+ #
458
+ # @overload create_policy_version(params = {})
459
+ # @param [Hash] params ({})
460
+ def create_policy_version(params = {}, options = {})
461
+ req = build_request(:create_policy_version, params)
462
+ req.send_request(options)
463
+ end
406
464
 
407
- # Creates a thing record in the thing registry.
408
- # @option params [required, String] :thing_name
409
- # The name of the thing to create.
410
- # @option params [String] :thing_type_name
411
- # The name of the thing type associated with the new thing.
412
- # @option params [Types::AttributePayload] :attribute_payload
413
- # The attribute payload, which consists of up to three name/value pairs
414
- # in a JSON document. For example:
415
- #
416
- # `\{"attributes":\{"string1":"string2"\}\})`
417
- # @return [Types::CreateThingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
418
- #
419
- # * {Types::CreateThingResponse#thing_name #thingName} => String
420
- # * {Types::CreateThingResponse#thing_arn #thingArn} => String
421
- #
422
- # @example Request syntax with placeholder values
423
- # resp = client.create_thing({
424
- # thing_name: "ThingName", # required
425
- # thing_type_name: "ThingTypeName",
426
- # attribute_payload: {
427
- # attributes: {
428
- # "AttributeName" => "AttributeValue",
429
- # },
430
- # merge: false,
431
- # },
432
- # })
433
- #
434
- # @example Response structure
435
- # resp.thing_name #=> String
436
- # resp.thing_arn #=> String
437
- # @overload create_thing(params = {})
438
- # @param [Hash] params ({})
439
- def create_thing(params = {}, options = {})
440
- req = build_request(:create_thing, params)
441
- req.send_request(options)
442
- end
465
+ # Creates a thing record in the thing registry.
466
+ #
467
+ # @option params [required, String] :thing_name
468
+ # The name of the thing to create.
469
+ #
470
+ # @option params [String] :thing_type_name
471
+ # The name of the thing type associated with the new thing.
472
+ #
473
+ # @option params [Types::AttributePayload] :attribute_payload
474
+ # The attribute payload, which consists of up to three name/value pairs
475
+ # in a JSON document. For example:
476
+ #
477
+ # `\{"attributes":\{"string1":"string2"\}\})`
478
+ #
479
+ # @return [Types::CreateThingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
480
+ #
481
+ # * {Types::CreateThingResponse#thing_name #thing_name} => String
482
+ # * {Types::CreateThingResponse#thing_arn #thing_arn} => String
483
+ #
484
+ # @example Request syntax with placeholder values
485
+ #
486
+ # resp = client.create_thing({
487
+ # thing_name: "ThingName", # required
488
+ # thing_type_name: "ThingTypeName",
489
+ # attribute_payload: {
490
+ # attributes: {
491
+ # "AttributeName" => "AttributeValue",
492
+ # },
493
+ # merge: false,
494
+ # },
495
+ # })
496
+ #
497
+ # @example Response structure
498
+ #
499
+ # resp.thing_name #=> String
500
+ # resp.thing_arn #=> String
501
+ #
502
+ # @overload create_thing(params = {})
503
+ # @param [Hash] params ({})
504
+ def create_thing(params = {}, options = {})
505
+ req = build_request(:create_thing, params)
506
+ req.send_request(options)
507
+ end
443
508
 
444
- # Creates a new thing type.
445
- # @option params [required, String] :thing_type_name
446
- # The name of the thing type.
447
- # @option params [Types::ThingTypeProperties] :thing_type_properties
448
- # The ThingTypeProperties for the thing type to create. It contains
449
- # information about the new thing type including a description, and a
450
- # list of searchable thing attribute names.
451
- # @return [Types::CreateThingTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
452
- #
453
- # * {Types::CreateThingTypeResponse#thing_type_name #thingTypeName} => String
454
- # * {Types::CreateThingTypeResponse#thing_type_arn #thingTypeArn} => String
455
- #
456
- # @example Request syntax with placeholder values
457
- # resp = client.create_thing_type({
458
- # thing_type_name: "ThingTypeName", # required
459
- # thing_type_properties: {
460
- # thing_type_description: "ThingTypeDescription",
461
- # searchable_attributes: ["AttributeName"],
462
- # },
463
- # })
464
- #
465
- # @example Response structure
466
- # resp.thing_type_name #=> String
467
- # resp.thing_type_arn #=> String
468
- # @overload create_thing_type(params = {})
469
- # @param [Hash] params ({})
470
- def create_thing_type(params = {}, options = {})
471
- req = build_request(:create_thing_type, params)
472
- req.send_request(options)
473
- end
509
+ # Creates a new thing type.
510
+ #
511
+ # @option params [required, String] :thing_type_name
512
+ # The name of the thing type.
513
+ #
514
+ # @option params [Types::ThingTypeProperties] :thing_type_properties
515
+ # The ThingTypeProperties for the thing type to create. It contains
516
+ # information about the new thing type including a description, and a
517
+ # list of searchable thing attribute names.
518
+ #
519
+ # @return [Types::CreateThingTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
520
+ #
521
+ # * {Types::CreateThingTypeResponse#thing_type_name #thing_type_name} => String
522
+ # * {Types::CreateThingTypeResponse#thing_type_arn #thing_type_arn} => String
523
+ #
524
+ # @example Request syntax with placeholder values
525
+ #
526
+ # resp = client.create_thing_type({
527
+ # thing_type_name: "ThingTypeName", # required
528
+ # thing_type_properties: {
529
+ # thing_type_description: "ThingTypeDescription",
530
+ # searchable_attributes: ["AttributeName"],
531
+ # },
532
+ # })
533
+ #
534
+ # @example Response structure
535
+ #
536
+ # resp.thing_type_name #=> String
537
+ # resp.thing_type_arn #=> String
538
+ #
539
+ # @overload create_thing_type(params = {})
540
+ # @param [Hash] params ({})
541
+ def create_thing_type(params = {}, options = {})
542
+ req = build_request(:create_thing_type, params)
543
+ req.send_request(options)
544
+ end
474
545
 
475
- # Creates a rule. Creating rules is an administrator-level action. Any
476
- # user who has permission to create rules will be able to access data
477
- # processed by the rule.
478
- # @option params [required, String] :rule_name
479
- # The name of the rule.
480
- # @option params [required, Types::TopicRulePayload] :topic_rule_payload
481
- # The rule payload.
482
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
483
- #
484
- # @example Request syntax with placeholder values
485
- # resp = client.create_topic_rule({
486
- # rule_name: "RuleName", # required
487
- # topic_rule_payload: { # required
488
- # sql: "SQL", # required
489
- # description: "Description",
490
- # actions: [ # required
491
- # {
492
- # dynamo_db: {
493
- # table_name: "TableName", # required
494
- # role_arn: "AwsArn", # required
495
- # operation: "DynamoOperation",
496
- # hash_key_field: "HashKeyField", # required
497
- # hash_key_value: "HashKeyValue", # required
498
- # hash_key_type: "STRING", # accepts STRING, NUMBER
499
- # range_key_field: "RangeKeyField",
500
- # range_key_value: "RangeKeyValue",
501
- # range_key_type: "STRING", # accepts STRING, NUMBER
502
- # payload_field: "PayloadField",
503
- # },
504
- # dynamo_d_bv_2: {
505
- # role_arn: "AwsArn",
506
- # put_item: {
507
- # table_name: "TableName", # required
508
- # },
509
- # },
510
- # lambda: {
511
- # function_arn: "FunctionArn", # required
512
- # },
513
- # sns: {
514
- # target_arn: "AwsArn", # required
515
- # role_arn: "AwsArn", # required
516
- # message_format: "RAW", # accepts RAW, JSON
517
- # },
518
- # sqs: {
519
- # role_arn: "AwsArn", # required
520
- # queue_url: "QueueUrl", # required
521
- # use_base_64: false,
522
- # },
523
- # kinesis: {
524
- # role_arn: "AwsArn", # required
525
- # stream_name: "StreamName", # required
526
- # partition_key: "PartitionKey",
527
- # },
528
- # republish: {
529
- # role_arn: "AwsArn", # required
530
- # topic: "TopicPattern", # required
531
- # },
532
- # s3: {
533
- # role_arn: "AwsArn", # required
534
- # bucket_name: "BucketName", # required
535
- # key: "Key", # required
536
- # canned_acl: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write
537
- # },
538
- # firehose: {
539
- # role_arn: "AwsArn", # required
540
- # delivery_stream_name: "DeliveryStreamName", # required
541
- # separator: "FirehoseSeparator",
542
- # },
543
- # cloudwatch_metric: {
544
- # role_arn: "AwsArn", # required
545
- # metric_namespace: "MetricNamespace", # required
546
- # metric_name: "MetricName", # required
547
- # metric_value: "MetricValue", # required
548
- # metric_unit: "MetricUnit", # required
549
- # metric_timestamp: "MetricTimestamp",
550
- # },
551
- # cloudwatch_alarm: {
552
- # role_arn: "AwsArn", # required
553
- # alarm_name: "AlarmName", # required
554
- # state_reason: "StateReason", # required
555
- # state_value: "StateValue", # required
556
- # },
557
- # elasticsearch: {
558
- # role_arn: "AwsArn", # required
559
- # endpoint: "ElasticsearchEndpoint", # required
560
- # index: "ElasticsearchIndex", # required
561
- # type: "ElasticsearchType", # required
562
- # id: "ElasticsearchId", # required
563
- # },
564
- # },
565
- # ],
566
- # rule_disabled: false,
567
- # aws_iot_sql_version: "AwsIotSqlVersion",
568
- # },
569
- # })
570
- # @overload create_topic_rule(params = {})
571
- # @param [Hash] params ({})
572
- def create_topic_rule(params = {}, options = {})
573
- req = build_request(:create_topic_rule, params)
574
- req.send_request(options)
575
- end
546
+ # Creates a rule. Creating rules is an administrator-level action. Any
547
+ # user who has permission to create rules will be able to access data
548
+ # processed by the rule.
549
+ #
550
+ # @option params [required, String] :rule_name
551
+ # The name of the rule.
552
+ #
553
+ # @option params [required, Types::TopicRulePayload] :topic_rule_payload
554
+ # The rule payload.
555
+ #
556
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
557
+ #
558
+ # @example Request syntax with placeholder values
559
+ #
560
+ # resp = client.create_topic_rule({
561
+ # rule_name: "RuleName", # required
562
+ # topic_rule_payload: { # required
563
+ # sql: "SQL", # required
564
+ # description: "Description",
565
+ # actions: [ # required
566
+ # {
567
+ # dynamo_db: {
568
+ # table_name: "TableName", # required
569
+ # role_arn: "AwsArn", # required
570
+ # operation: "DynamoOperation",
571
+ # hash_key_field: "HashKeyField", # required
572
+ # hash_key_value: "HashKeyValue", # required
573
+ # hash_key_type: "STRING", # accepts STRING, NUMBER
574
+ # range_key_field: "RangeKeyField",
575
+ # range_key_value: "RangeKeyValue",
576
+ # range_key_type: "STRING", # accepts STRING, NUMBER
577
+ # payload_field: "PayloadField",
578
+ # },
579
+ # dynamo_d_bv_2: {
580
+ # role_arn: "AwsArn",
581
+ # put_item: {
582
+ # table_name: "TableName", # required
583
+ # },
584
+ # },
585
+ # lambda: {
586
+ # function_arn: "FunctionArn", # required
587
+ # },
588
+ # sns: {
589
+ # target_arn: "AwsArn", # required
590
+ # role_arn: "AwsArn", # required
591
+ # message_format: "RAW", # accepts RAW, JSON
592
+ # },
593
+ # sqs: {
594
+ # role_arn: "AwsArn", # required
595
+ # queue_url: "QueueUrl", # required
596
+ # use_base_64: false,
597
+ # },
598
+ # kinesis: {
599
+ # role_arn: "AwsArn", # required
600
+ # stream_name: "StreamName", # required
601
+ # partition_key: "PartitionKey",
602
+ # },
603
+ # republish: {
604
+ # role_arn: "AwsArn", # required
605
+ # topic: "TopicPattern", # required
606
+ # },
607
+ # s3: {
608
+ # role_arn: "AwsArn", # required
609
+ # bucket_name: "BucketName", # required
610
+ # key: "Key", # required
611
+ # canned_acl: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write
612
+ # },
613
+ # firehose: {
614
+ # role_arn: "AwsArn", # required
615
+ # delivery_stream_name: "DeliveryStreamName", # required
616
+ # separator: "FirehoseSeparator",
617
+ # },
618
+ # cloudwatch_metric: {
619
+ # role_arn: "AwsArn", # required
620
+ # metric_namespace: "MetricNamespace", # required
621
+ # metric_name: "MetricName", # required
622
+ # metric_value: "MetricValue", # required
623
+ # metric_unit: "MetricUnit", # required
624
+ # metric_timestamp: "MetricTimestamp",
625
+ # },
626
+ # cloudwatch_alarm: {
627
+ # role_arn: "AwsArn", # required
628
+ # alarm_name: "AlarmName", # required
629
+ # state_reason: "StateReason", # required
630
+ # state_value: "StateValue", # required
631
+ # },
632
+ # elasticsearch: {
633
+ # role_arn: "AwsArn", # required
634
+ # endpoint: "ElasticsearchEndpoint", # required
635
+ # index: "ElasticsearchIndex", # required
636
+ # type: "ElasticsearchType", # required
637
+ # id: "ElasticsearchId", # required
638
+ # },
639
+ # },
640
+ # ],
641
+ # rule_disabled: false,
642
+ # aws_iot_sql_version: "AwsIotSqlVersion",
643
+ # },
644
+ # })
645
+ #
646
+ # @overload create_topic_rule(params = {})
647
+ # @param [Hash] params ({})
648
+ def create_topic_rule(params = {}, options = {})
649
+ req = build_request(:create_topic_rule, params)
650
+ req.send_request(options)
651
+ end
576
652
 
577
- # Deletes a registered CA certificate.
578
- # @option params [required, String] :certificate_id
579
- # The ID of the certificate to delete.
580
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
581
- #
582
- # @example Request syntax with placeholder values
583
- # resp = client.delete_ca_certificate({
584
- # certificate_id: "CertificateId", # required
585
- # })
586
- # @overload delete_ca_certificate(params = {})
587
- # @param [Hash] params ({})
588
- def delete_ca_certificate(params = {}, options = {})
589
- req = build_request(:delete_ca_certificate, params)
590
- req.send_request(options)
591
- end
653
+ # Deletes a registered CA certificate.
654
+ #
655
+ # @option params [required, String] :certificate_id
656
+ # The ID of the certificate to delete.
657
+ #
658
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
659
+ #
660
+ # @example Request syntax with placeholder values
661
+ #
662
+ # resp = client.delete_ca_certificate({
663
+ # certificate_id: "CertificateId", # required
664
+ # })
665
+ #
666
+ # @overload delete_ca_certificate(params = {})
667
+ # @param [Hash] params ({})
668
+ def delete_ca_certificate(params = {}, options = {})
669
+ req = build_request(:delete_ca_certificate, params)
670
+ req.send_request(options)
671
+ end
592
672
 
593
- # Deletes the specified certificate.
594
- #
595
- # A certificate cannot be deleted if it has a policy attached to it or
596
- # if its status is set to ACTIVE. To delete a certificate, first use the
597
- # DetachPrincipalPolicy API to detach all policies. Next, use the
598
- # UpdateCertificate API to set the certificate to the INACTIVE status.
599
- # @option params [required, String] :certificate_id
600
- # The ID of the certificate.
601
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
602
- #
603
- # @example Request syntax with placeholder values
604
- # resp = client.delete_certificate({
605
- # certificate_id: "CertificateId", # required
606
- # })
607
- # @overload delete_certificate(params = {})
608
- # @param [Hash] params ({})
609
- def delete_certificate(params = {}, options = {})
610
- req = build_request(:delete_certificate, params)
611
- req.send_request(options)
612
- end
673
+ # Deletes the specified certificate.
674
+ #
675
+ # A certificate cannot be deleted if it has a policy attached to it or
676
+ # if its status is set to ACTIVE. To delete a certificate, first use the
677
+ # DetachPrincipalPolicy API to detach all policies. Next, use the
678
+ # UpdateCertificate API to set the certificate to the INACTIVE status.
679
+ #
680
+ # @option params [required, String] :certificate_id
681
+ # The ID of the certificate.
682
+ #
683
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
684
+ #
685
+ # @example Request syntax with placeholder values
686
+ #
687
+ # resp = client.delete_certificate({
688
+ # certificate_id: "CertificateId", # required
689
+ # })
690
+ #
691
+ # @overload delete_certificate(params = {})
692
+ # @param [Hash] params ({})
693
+ def delete_certificate(params = {}, options = {})
694
+ req = build_request(:delete_certificate, params)
695
+ req.send_request(options)
696
+ end
613
697
 
614
- # Deletes the specified policy.
615
- #
616
- # A policy cannot be deleted if it has non-default versions or it is
617
- # attached to any certificate.
618
- #
619
- # To delete a policy, use the DeletePolicyVersion API to delete all
620
- # non-default versions of the policy; use the DetachPrincipalPolicy API
621
- # to detach the policy from any certificate; and then use the
622
- # DeletePolicy API to delete the policy.
623
- #
624
- # When a policy is deleted using DeletePolicy, its default version is
625
- # deleted with it.
626
- # @option params [required, String] :policy_name
627
- # The name of the policy to delete.
628
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
629
- #
630
- # @example Request syntax with placeholder values
631
- # resp = client.delete_policy({
632
- # policy_name: "PolicyName", # required
633
- # })
634
- # @overload delete_policy(params = {})
635
- # @param [Hash] params ({})
636
- def delete_policy(params = {}, options = {})
637
- req = build_request(:delete_policy, params)
638
- req.send_request(options)
639
- end
698
+ # Deletes the specified policy.
699
+ #
700
+ # A policy cannot be deleted if it has non-default versions or it is
701
+ # attached to any certificate.
702
+ #
703
+ # To delete a policy, use the DeletePolicyVersion API to delete all
704
+ # non-default versions of the policy; use the DetachPrincipalPolicy API
705
+ # to detach the policy from any certificate; and then use the
706
+ # DeletePolicy API to delete the policy.
707
+ #
708
+ # When a policy is deleted using DeletePolicy, its default version is
709
+ # deleted with it.
710
+ #
711
+ # @option params [required, String] :policy_name
712
+ # The name of the policy to delete.
713
+ #
714
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
715
+ #
716
+ # @example Request syntax with placeholder values
717
+ #
718
+ # resp = client.delete_policy({
719
+ # policy_name: "PolicyName", # required
720
+ # })
721
+ #
722
+ # @overload delete_policy(params = {})
723
+ # @param [Hash] params ({})
724
+ def delete_policy(params = {}, options = {})
725
+ req = build_request(:delete_policy, params)
726
+ req.send_request(options)
727
+ end
640
728
 
641
- # Deletes the specified version of the specified policy. You cannot
642
- # delete the default version of a policy using this API. To delete the
643
- # default version of a policy, use DeletePolicy. To find out which
644
- # version of a policy is marked as the default version, use
645
- # ListPolicyVersions.
646
- # @option params [required, String] :policy_name
647
- # The name of the policy.
648
- # @option params [required, String] :policy_version_id
649
- # The policy version ID.
650
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
651
- #
652
- # @example Request syntax with placeholder values
653
- # resp = client.delete_policy_version({
654
- # policy_name: "PolicyName", # required
655
- # policy_version_id: "PolicyVersionId", # required
656
- # })
657
- # @overload delete_policy_version(params = {})
658
- # @param [Hash] params ({})
659
- def delete_policy_version(params = {}, options = {})
660
- req = build_request(:delete_policy_version, params)
661
- req.send_request(options)
662
- end
729
+ # Deletes the specified version of the specified policy. You cannot
730
+ # delete the default version of a policy using this API. To delete the
731
+ # default version of a policy, use DeletePolicy. To find out which
732
+ # version of a policy is marked as the default version, use
733
+ # ListPolicyVersions.
734
+ #
735
+ # @option params [required, String] :policy_name
736
+ # The name of the policy.
737
+ #
738
+ # @option params [required, String] :policy_version_id
739
+ # The policy version ID.
740
+ #
741
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
742
+ #
743
+ # @example Request syntax with placeholder values
744
+ #
745
+ # resp = client.delete_policy_version({
746
+ # policy_name: "PolicyName", # required
747
+ # policy_version_id: "PolicyVersionId", # required
748
+ # })
749
+ #
750
+ # @overload delete_policy_version(params = {})
751
+ # @param [Hash] params ({})
752
+ def delete_policy_version(params = {}, options = {})
753
+ req = build_request(:delete_policy_version, params)
754
+ req.send_request(options)
755
+ end
663
756
 
664
- # Deletes a CA certificate registration code.
665
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
666
- #
667
- # @example Request syntax with placeholder values
668
- # resp = client.delete_registration_code()
669
- # @overload delete_registration_code(params = {})
670
- # @param [Hash] params ({})
671
- def delete_registration_code(params = {}, options = {})
672
- req = build_request(:delete_registration_code, params)
673
- req.send_request(options)
674
- end
757
+ # Deletes a CA certificate registration code.
758
+ #
759
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
760
+ #
761
+ # @overload delete_registration_code(params = {})
762
+ # @param [Hash] params ({})
763
+ def delete_registration_code(params = {}, options = {})
764
+ req = build_request(:delete_registration_code, params)
765
+ req.send_request(options)
766
+ end
675
767
 
676
- # Deletes the specified thing.
677
- # @option params [required, String] :thing_name
678
- # The name of the thing to delete.
679
- # @option params [Integer] :expected_version
680
- # The expected version of the thing record in the registry. If the
681
- # version of the record in the registry does not match the expected
682
- # version specified in the request, the `DeleteThing` request is
683
- # rejected with a `VersionConflictException`.
684
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
685
- #
686
- # @example Request syntax with placeholder values
687
- # resp = client.delete_thing({
688
- # thing_name: "ThingName", # required
689
- # expected_version: 1,
690
- # })
691
- # @overload delete_thing(params = {})
692
- # @param [Hash] params ({})
693
- def delete_thing(params = {}, options = {})
694
- req = build_request(:delete_thing, params)
695
- req.send_request(options)
696
- end
768
+ # Deletes the specified thing.
769
+ #
770
+ # @option params [required, String] :thing_name
771
+ # The name of the thing to delete.
772
+ #
773
+ # @option params [Integer] :expected_version
774
+ # The expected version of the thing record in the registry. If the
775
+ # version of the record in the registry does not match the expected
776
+ # version specified in the request, the `DeleteThing` request is
777
+ # rejected with a `VersionConflictException`.
778
+ #
779
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
780
+ #
781
+ # @example Request syntax with placeholder values
782
+ #
783
+ # resp = client.delete_thing({
784
+ # thing_name: "ThingName", # required
785
+ # expected_version: 1,
786
+ # })
787
+ #
788
+ # @overload delete_thing(params = {})
789
+ # @param [Hash] params ({})
790
+ def delete_thing(params = {}, options = {})
791
+ req = build_request(:delete_thing, params)
792
+ req.send_request(options)
793
+ end
697
794
 
698
- # Deletes the specified thing type . You cannot delete a thing type if
699
- # it has things associated with it. To delete a thing type, first mark
700
- # it as deprecated by calling DeprecateThingType, then remove any
701
- # associated things by calling UpdateThing to change the thing type on
702
- # any associated thing, and finally use DeleteThingType to delete the
703
- # thing type.
704
- # @option params [required, String] :thing_type_name
705
- # The name of the thing type.
706
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
707
- #
708
- # @example Request syntax with placeholder values
709
- # resp = client.delete_thing_type({
710
- # thing_type_name: "ThingTypeName", # required
711
- # })
712
- # @overload delete_thing_type(params = {})
713
- # @param [Hash] params ({})
714
- def delete_thing_type(params = {}, options = {})
715
- req = build_request(:delete_thing_type, params)
716
- req.send_request(options)
717
- end
795
+ # Deletes the specified thing type . You cannot delete a thing type if
796
+ # it has things associated with it. To delete a thing type, first mark
797
+ # it as deprecated by calling DeprecateThingType, then remove any
798
+ # associated things by calling UpdateThing to change the thing type on
799
+ # any associated thing, and finally use DeleteThingType to delete the
800
+ # thing type.
801
+ #
802
+ # @option params [required, String] :thing_type_name
803
+ # The name of the thing type.
804
+ #
805
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
806
+ #
807
+ # @example Request syntax with placeholder values
808
+ #
809
+ # resp = client.delete_thing_type({
810
+ # thing_type_name: "ThingTypeName", # required
811
+ # })
812
+ #
813
+ # @overload delete_thing_type(params = {})
814
+ # @param [Hash] params ({})
815
+ def delete_thing_type(params = {}, options = {})
816
+ req = build_request(:delete_thing_type, params)
817
+ req.send_request(options)
818
+ end
718
819
 
719
- # Deletes the specified rule.
720
- # @option params [required, String] :rule_name
721
- # The name of the rule.
722
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
723
- #
724
- # @example Request syntax with placeholder values
725
- # resp = client.delete_topic_rule({
726
- # rule_name: "RuleName", # required
727
- # })
728
- # @overload delete_topic_rule(params = {})
729
- # @param [Hash] params ({})
730
- def delete_topic_rule(params = {}, options = {})
731
- req = build_request(:delete_topic_rule, params)
732
- req.send_request(options)
733
- end
820
+ # Deletes the specified rule.
821
+ #
822
+ # @option params [required, String] :rule_name
823
+ # The name of the rule.
824
+ #
825
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
826
+ #
827
+ # @example Request syntax with placeholder values
828
+ #
829
+ # resp = client.delete_topic_rule({
830
+ # rule_name: "RuleName", # required
831
+ # })
832
+ #
833
+ # @overload delete_topic_rule(params = {})
834
+ # @param [Hash] params ({})
835
+ def delete_topic_rule(params = {}, options = {})
836
+ req = build_request(:delete_topic_rule, params)
837
+ req.send_request(options)
838
+ end
734
839
 
735
- # Deprecates a thing type. You can not associate new things with
736
- # deprecated thing type.
737
- # @option params [required, String] :thing_type_name
738
- # The name of the thing type to deprecate.
739
- # @option params [Boolean] :undo_deprecate
740
- # Whether to undeprecate a deprecated thing type. If **true**, the thing
741
- # type will not be deprecated anymore and you can associate it with
742
- # things.
743
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
744
- #
745
- # @example Request syntax with placeholder values
746
- # resp = client.deprecate_thing_type({
747
- # thing_type_name: "ThingTypeName", # required
748
- # undo_deprecate: false,
749
- # })
750
- # @overload deprecate_thing_type(params = {})
751
- # @param [Hash] params ({})
752
- def deprecate_thing_type(params = {}, options = {})
753
- req = build_request(:deprecate_thing_type, params)
754
- req.send_request(options)
755
- end
840
+ # Deprecates a thing type. You can not associate new things with
841
+ # deprecated thing type.
842
+ #
843
+ # @option params [required, String] :thing_type_name
844
+ # The name of the thing type to deprecate.
845
+ #
846
+ # @option params [Boolean] :undo_deprecate
847
+ # Whether to undeprecate a deprecated thing type. If **true**, the thing
848
+ # type will not be deprecated anymore and you can associate it with
849
+ # things.
850
+ #
851
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
852
+ #
853
+ # @example Request syntax with placeholder values
854
+ #
855
+ # resp = client.deprecate_thing_type({
856
+ # thing_type_name: "ThingTypeName", # required
857
+ # undo_deprecate: false,
858
+ # })
859
+ #
860
+ # @overload deprecate_thing_type(params = {})
861
+ # @param [Hash] params ({})
862
+ def deprecate_thing_type(params = {}, options = {})
863
+ req = build_request(:deprecate_thing_type, params)
864
+ req.send_request(options)
865
+ end
756
866
 
757
- # Describes a registered CA certificate.
758
- # @option params [required, String] :certificate_id
759
- # The CA certificate identifier.
760
- # @return [Types::DescribeCACertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
761
- #
762
- # * {Types::DescribeCACertificateResponse#certificate_description #certificateDescription} => Types::CACertificateDescription
763
- #
764
- # @example Request syntax with placeholder values
765
- # resp = client.describe_ca_certificate({
766
- # certificate_id: "CertificateId", # required
767
- # })
768
- #
769
- # @example Response structure
770
- # resp.certificate_description.certificate_arn #=> String
771
- # resp.certificate_description.certificate_id #=> String
772
- # resp.certificate_description.status #=> String, one of "ACTIVE", "INACTIVE"
773
- # resp.certificate_description.certificate_pem #=> String
774
- # resp.certificate_description.owned_by #=> String
775
- # resp.certificate_description.creation_date #=> Time
776
- # resp.certificate_description.auto_registration_status #=> String, one of "ENABLE", "DISABLE"
777
- # @overload describe_ca_certificate(params = {})
778
- # @param [Hash] params ({})
779
- def describe_ca_certificate(params = {}, options = {})
780
- req = build_request(:describe_ca_certificate, params)
781
- req.send_request(options)
782
- end
867
+ # Describes a registered CA certificate.
868
+ #
869
+ # @option params [required, String] :certificate_id
870
+ # The CA certificate identifier.
871
+ #
872
+ # @return [Types::DescribeCACertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
873
+ #
874
+ # * {Types::DescribeCACertificateResponse#certificate_description #certificate_description} => Types::CACertificateDescription
875
+ #
876
+ # @example Request syntax with placeholder values
877
+ #
878
+ # resp = client.describe_ca_certificate({
879
+ # certificate_id: "CertificateId", # required
880
+ # })
881
+ #
882
+ # @example Response structure
883
+ #
884
+ # resp.certificate_description.certificate_arn #=> String
885
+ # resp.certificate_description.certificate_id #=> String
886
+ # resp.certificate_description.status #=> String, one of "ACTIVE", "INACTIVE"
887
+ # resp.certificate_description.certificate_pem #=> String
888
+ # resp.certificate_description.owned_by #=> String
889
+ # resp.certificate_description.creation_date #=> Time
890
+ # resp.certificate_description.auto_registration_status #=> String, one of "ENABLE", "DISABLE"
891
+ #
892
+ # @overload describe_ca_certificate(params = {})
893
+ # @param [Hash] params ({})
894
+ def describe_ca_certificate(params = {}, options = {})
895
+ req = build_request(:describe_ca_certificate, params)
896
+ req.send_request(options)
897
+ end
783
898
 
784
- # Gets information about the specified certificate.
785
- # @option params [required, String] :certificate_id
786
- # The ID of the certificate.
787
- # @return [Types::DescribeCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
788
- #
789
- # * {Types::DescribeCertificateResponse#certificate_description #certificateDescription} => Types::CertificateDescription
790
- #
791
- # @example Request syntax with placeholder values
792
- # resp = client.describe_certificate({
793
- # certificate_id: "CertificateId", # required
794
- # })
795
- #
796
- # @example Response structure
797
- # resp.certificate_description.certificate_arn #=> String
798
- # resp.certificate_description.certificate_id #=> String
799
- # resp.certificate_description.ca_certificate_id #=> String
800
- # resp.certificate_description.status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
801
- # resp.certificate_description.certificate_pem #=> String
802
- # resp.certificate_description.owned_by #=> String
803
- # resp.certificate_description.previous_owned_by #=> String
804
- # resp.certificate_description.creation_date #=> Time
805
- # resp.certificate_description.last_modified_date #=> Time
806
- # resp.certificate_description.transfer_data.transfer_message #=> String
807
- # resp.certificate_description.transfer_data.reject_reason #=> String
808
- # resp.certificate_description.transfer_data.transfer_date #=> Time
809
- # resp.certificate_description.transfer_data.accept_date #=> Time
810
- # resp.certificate_description.transfer_data.reject_date #=> Time
811
- # @overload describe_certificate(params = {})
812
- # @param [Hash] params ({})
813
- def describe_certificate(params = {}, options = {})
814
- req = build_request(:describe_certificate, params)
815
- req.send_request(options)
816
- end
899
+ # Gets information about the specified certificate.
900
+ #
901
+ # @option params [required, String] :certificate_id
902
+ # The ID of the certificate.
903
+ #
904
+ # @return [Types::DescribeCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
905
+ #
906
+ # * {Types::DescribeCertificateResponse#certificate_description #certificate_description} => Types::CertificateDescription
907
+ #
908
+ # @example Request syntax with placeholder values
909
+ #
910
+ # resp = client.describe_certificate({
911
+ # certificate_id: "CertificateId", # required
912
+ # })
913
+ #
914
+ # @example Response structure
915
+ #
916
+ # resp.certificate_description.certificate_arn #=> String
917
+ # resp.certificate_description.certificate_id #=> String
918
+ # resp.certificate_description.ca_certificate_id #=> String
919
+ # resp.certificate_description.status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
920
+ # resp.certificate_description.certificate_pem #=> String
921
+ # resp.certificate_description.owned_by #=> String
922
+ # resp.certificate_description.previous_owned_by #=> String
923
+ # resp.certificate_description.creation_date #=> Time
924
+ # resp.certificate_description.last_modified_date #=> Time
925
+ # resp.certificate_description.transfer_data.transfer_message #=> String
926
+ # resp.certificate_description.transfer_data.reject_reason #=> String
927
+ # resp.certificate_description.transfer_data.transfer_date #=> Time
928
+ # resp.certificate_description.transfer_data.accept_date #=> Time
929
+ # resp.certificate_description.transfer_data.reject_date #=> Time
930
+ #
931
+ # @overload describe_certificate(params = {})
932
+ # @param [Hash] params ({})
933
+ def describe_certificate(params = {}, options = {})
934
+ req = build_request(:describe_certificate, params)
935
+ req.send_request(options)
936
+ end
817
937
 
818
- # Returns a unique endpoint specific to the AWS account making the call.
819
- # @return [Types::DescribeEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
820
- #
821
- # * {Types::DescribeEndpointResponse#endpoint_address #endpointAddress} => String
822
- #
823
- # @example Request syntax with placeholder values
824
- # resp = client.describe_endpoint()
825
- #
826
- # @example Response structure
827
- # resp.endpoint_address #=> String
828
- # @overload describe_endpoint(params = {})
829
- # @param [Hash] params ({})
830
- def describe_endpoint(params = {}, options = {})
831
- req = build_request(:describe_endpoint, params)
832
- req.send_request(options)
833
- end
938
+ # Returns a unique endpoint specific to the AWS account making the call.
939
+ #
940
+ # @return [Types::DescribeEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
941
+ #
942
+ # * {Types::DescribeEndpointResponse#endpoint_address #endpoint_address} => String
943
+ #
944
+ # @example Response structure
945
+ #
946
+ # resp.endpoint_address #=> String
947
+ #
948
+ # @overload describe_endpoint(params = {})
949
+ # @param [Hash] params ({})
950
+ def describe_endpoint(params = {}, options = {})
951
+ req = build_request(:describe_endpoint, params)
952
+ req.send_request(options)
953
+ end
834
954
 
835
- # Gets information about the specified thing.
836
- # @option params [required, String] :thing_name
837
- # The name of the thing.
838
- # @return [Types::DescribeThingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
839
- #
840
- # * {Types::DescribeThingResponse#default_client_id #defaultClientId} => String
841
- # * {Types::DescribeThingResponse#thing_name #thingName} => String
842
- # * {Types::DescribeThingResponse#thing_type_name #thingTypeName} => String
843
- # * {Types::DescribeThingResponse#attributes #attributes} => Hash&lt;String,String&gt;
844
- # * {Types::DescribeThingResponse#version #version} => Integer
845
- #
846
- # @example Request syntax with placeholder values
847
- # resp = client.describe_thing({
848
- # thing_name: "ThingName", # required
849
- # })
850
- #
851
- # @example Response structure
852
- # resp.default_client_id #=> String
853
- # resp.thing_name #=> String
854
- # resp.thing_type_name #=> String
855
- # resp.attributes #=> Hash
856
- # resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
857
- # resp.version #=> Integer
858
- # @overload describe_thing(params = {})
859
- # @param [Hash] params ({})
860
- def describe_thing(params = {}, options = {})
861
- req = build_request(:describe_thing, params)
862
- req.send_request(options)
863
- end
955
+ # Gets information about the specified thing.
956
+ #
957
+ # @option params [required, String] :thing_name
958
+ # The name of the thing.
959
+ #
960
+ # @return [Types::DescribeThingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
961
+ #
962
+ # * {Types::DescribeThingResponse#default_client_id #default_client_id} => String
963
+ # * {Types::DescribeThingResponse#thing_name #thing_name} => String
964
+ # * {Types::DescribeThingResponse#thing_type_name #thing_type_name} => String
965
+ # * {Types::DescribeThingResponse#attributes #attributes} => Hash&lt;String,String&gt;
966
+ # * {Types::DescribeThingResponse#version #version} => Integer
967
+ #
968
+ # @example Request syntax with placeholder values
969
+ #
970
+ # resp = client.describe_thing({
971
+ # thing_name: "ThingName", # required
972
+ # })
973
+ #
974
+ # @example Response structure
975
+ #
976
+ # resp.default_client_id #=> String
977
+ # resp.thing_name #=> String
978
+ # resp.thing_type_name #=> String
979
+ # resp.attributes #=> Hash
980
+ # resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
981
+ # resp.version #=> Integer
982
+ #
983
+ # @overload describe_thing(params = {})
984
+ # @param [Hash] params ({})
985
+ def describe_thing(params = {}, options = {})
986
+ req = build_request(:describe_thing, params)
987
+ req.send_request(options)
988
+ end
864
989
 
865
- # Gets information about the specified thing type.
866
- # @option params [required, String] :thing_type_name
867
- # The name of the thing type.
868
- # @return [Types::DescribeThingTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
869
- #
870
- # * {Types::DescribeThingTypeResponse#thing_type_name #thingTypeName} => String
871
- # * {Types::DescribeThingTypeResponse#thing_type_properties #thingTypeProperties} => Types::ThingTypeProperties
872
- # * {Types::DescribeThingTypeResponse#thing_type_metadata #thingTypeMetadata} => Types::ThingTypeMetadata
873
- #
874
- # @example Request syntax with placeholder values
875
- # resp = client.describe_thing_type({
876
- # thing_type_name: "ThingTypeName", # required
877
- # })
878
- #
879
- # @example Response structure
880
- # resp.thing_type_name #=> String
881
- # resp.thing_type_properties.thing_type_description #=> String
882
- # resp.thing_type_properties.searchable_attributes #=> Array
883
- # resp.thing_type_properties.searchable_attributes[0] #=> String
884
- # resp.thing_type_metadata.deprecated #=> Boolean
885
- # resp.thing_type_metadata.deprecation_date #=> Time
886
- # resp.thing_type_metadata.creation_date #=> Time
887
- # @overload describe_thing_type(params = {})
888
- # @param [Hash] params ({})
889
- def describe_thing_type(params = {}, options = {})
890
- req = build_request(:describe_thing_type, params)
891
- req.send_request(options)
892
- end
990
+ # Gets information about the specified thing type.
991
+ #
992
+ # @option params [required, String] :thing_type_name
993
+ # The name of the thing type.
994
+ #
995
+ # @return [Types::DescribeThingTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
996
+ #
997
+ # * {Types::DescribeThingTypeResponse#thing_type_name #thing_type_name} => String
998
+ # * {Types::DescribeThingTypeResponse#thing_type_properties #thing_type_properties} => Types::ThingTypeProperties
999
+ # * {Types::DescribeThingTypeResponse#thing_type_metadata #thing_type_metadata} => Types::ThingTypeMetadata
1000
+ #
1001
+ # @example Request syntax with placeholder values
1002
+ #
1003
+ # resp = client.describe_thing_type({
1004
+ # thing_type_name: "ThingTypeName", # required
1005
+ # })
1006
+ #
1007
+ # @example Response structure
1008
+ #
1009
+ # resp.thing_type_name #=> String
1010
+ # resp.thing_type_properties.thing_type_description #=> String
1011
+ # resp.thing_type_properties.searchable_attributes #=> Array
1012
+ # resp.thing_type_properties.searchable_attributes[0] #=> String
1013
+ # resp.thing_type_metadata.deprecated #=> Boolean
1014
+ # resp.thing_type_metadata.deprecation_date #=> Time
1015
+ # resp.thing_type_metadata.creation_date #=> Time
1016
+ #
1017
+ # @overload describe_thing_type(params = {})
1018
+ # @param [Hash] params ({})
1019
+ def describe_thing_type(params = {}, options = {})
1020
+ req = build_request(:describe_thing_type, params)
1021
+ req.send_request(options)
1022
+ end
893
1023
 
894
- # Removes the specified policy from the specified certificate.
895
- # @option params [required, String] :policy_name
896
- # The name of the policy to detach.
897
- # @option params [required, String] :principal
898
- # The principal.
899
- #
900
- # If the principal is a certificate, specify the certificate ARN. If the
901
- # principal is an Amazon Cognito identity, specify the identity ID.
902
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
903
- #
904
- # @example Request syntax with placeholder values
905
- # resp = client.detach_principal_policy({
906
- # policy_name: "PolicyName", # required
907
- # principal: "Principal", # required
908
- # })
909
- # @overload detach_principal_policy(params = {})
910
- # @param [Hash] params ({})
911
- def detach_principal_policy(params = {}, options = {})
912
- req = build_request(:detach_principal_policy, params)
913
- req.send_request(options)
914
- end
1024
+ # Removes the specified policy from the specified certificate.
1025
+ #
1026
+ # @option params [required, String] :policy_name
1027
+ # The name of the policy to detach.
1028
+ #
1029
+ # @option params [required, String] :principal
1030
+ # The principal.
1031
+ #
1032
+ # If the principal is a certificate, specify the certificate ARN. If the
1033
+ # principal is an Amazon Cognito identity, specify the identity ID.
1034
+ #
1035
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1036
+ #
1037
+ # @example Request syntax with placeholder values
1038
+ #
1039
+ # resp = client.detach_principal_policy({
1040
+ # policy_name: "PolicyName", # required
1041
+ # principal: "Principal", # required
1042
+ # })
1043
+ #
1044
+ # @overload detach_principal_policy(params = {})
1045
+ # @param [Hash] params ({})
1046
+ def detach_principal_policy(params = {}, options = {})
1047
+ req = build_request(:detach_principal_policy, params)
1048
+ req.send_request(options)
1049
+ end
915
1050
 
916
- # Detaches the specified principal from the specified thing.
917
- # @option params [required, String] :thing_name
918
- # The name of the thing.
919
- # @option params [required, String] :principal
920
- # If the principal is a certificate, this value must be ARN of the
921
- # certificate. If the principal is an Amazon Cognito identity, this
922
- # value must be the ID of the Amazon Cognito identity.
923
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
924
- #
925
- # @example Request syntax with placeholder values
926
- # resp = client.detach_thing_principal({
927
- # thing_name: "ThingName", # required
928
- # principal: "Principal", # required
929
- # })
930
- # @overload detach_thing_principal(params = {})
931
- # @param [Hash] params ({})
932
- def detach_thing_principal(params = {}, options = {})
933
- req = build_request(:detach_thing_principal, params)
934
- req.send_request(options)
935
- end
1051
+ # Detaches the specified principal from the specified thing.
1052
+ #
1053
+ # @option params [required, String] :thing_name
1054
+ # The name of the thing.
1055
+ #
1056
+ # @option params [required, String] :principal
1057
+ # If the principal is a certificate, this value must be ARN of the
1058
+ # certificate. If the principal is an Amazon Cognito identity, this
1059
+ # value must be the ID of the Amazon Cognito identity.
1060
+ #
1061
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1062
+ #
1063
+ # @example Request syntax with placeholder values
1064
+ #
1065
+ # resp = client.detach_thing_principal({
1066
+ # thing_name: "ThingName", # required
1067
+ # principal: "Principal", # required
1068
+ # })
1069
+ #
1070
+ # @overload detach_thing_principal(params = {})
1071
+ # @param [Hash] params ({})
1072
+ def detach_thing_principal(params = {}, options = {})
1073
+ req = build_request(:detach_thing_principal, params)
1074
+ req.send_request(options)
1075
+ end
936
1076
 
937
- # Disables the specified rule.
938
- # @option params [required, String] :rule_name
939
- # The name of the rule to disable.
940
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
941
- #
942
- # @example Request syntax with placeholder values
943
- # resp = client.disable_topic_rule({
944
- # rule_name: "RuleName", # required
945
- # })
946
- # @overload disable_topic_rule(params = {})
947
- # @param [Hash] params ({})
948
- def disable_topic_rule(params = {}, options = {})
949
- req = build_request(:disable_topic_rule, params)
950
- req.send_request(options)
951
- end
1077
+ # Disables the specified rule.
1078
+ #
1079
+ # @option params [required, String] :rule_name
1080
+ # The name of the rule to disable.
1081
+ #
1082
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1083
+ #
1084
+ # @example Request syntax with placeholder values
1085
+ #
1086
+ # resp = client.disable_topic_rule({
1087
+ # rule_name: "RuleName", # required
1088
+ # })
1089
+ #
1090
+ # @overload disable_topic_rule(params = {})
1091
+ # @param [Hash] params ({})
1092
+ def disable_topic_rule(params = {}, options = {})
1093
+ req = build_request(:disable_topic_rule, params)
1094
+ req.send_request(options)
1095
+ end
952
1096
 
953
- # Enables the specified rule.
954
- # @option params [required, String] :rule_name
955
- # The name of the topic rule to enable.
956
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
957
- #
958
- # @example Request syntax with placeholder values
959
- # resp = client.enable_topic_rule({
960
- # rule_name: "RuleName", # required
961
- # })
962
- # @overload enable_topic_rule(params = {})
963
- # @param [Hash] params ({})
964
- def enable_topic_rule(params = {}, options = {})
965
- req = build_request(:enable_topic_rule, params)
966
- req.send_request(options)
967
- end
1097
+ # Enables the specified rule.
1098
+ #
1099
+ # @option params [required, String] :rule_name
1100
+ # The name of the topic rule to enable.
1101
+ #
1102
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1103
+ #
1104
+ # @example Request syntax with placeholder values
1105
+ #
1106
+ # resp = client.enable_topic_rule({
1107
+ # rule_name: "RuleName", # required
1108
+ # })
1109
+ #
1110
+ # @overload enable_topic_rule(params = {})
1111
+ # @param [Hash] params ({})
1112
+ def enable_topic_rule(params = {}, options = {})
1113
+ req = build_request(:enable_topic_rule, params)
1114
+ req.send_request(options)
1115
+ end
968
1116
 
969
- # Gets the logging options.
970
- # @return [Types::GetLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
971
- #
972
- # * {Types::GetLoggingOptionsResponse#role_arn #roleArn} => String
973
- # * {Types::GetLoggingOptionsResponse#log_level #logLevel} => String
974
- #
975
- # @example Request syntax with placeholder values
976
- # resp = client.get_logging_options()
977
- #
978
- # @example Response structure
979
- # resp.role_arn #=> String
980
- # resp.log_level #=> String, one of "DEBUG", "INFO", "ERROR", "WARN", "DISABLED"
981
- # @overload get_logging_options(params = {})
982
- # @param [Hash] params ({})
983
- def get_logging_options(params = {}, options = {})
984
- req = build_request(:get_logging_options, params)
985
- req.send_request(options)
986
- end
1117
+ # Gets the logging options.
1118
+ #
1119
+ # @return [Types::GetLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1120
+ #
1121
+ # * {Types::GetLoggingOptionsResponse#role_arn #role_arn} => String
1122
+ # * {Types::GetLoggingOptionsResponse#log_level #log_level} => String
1123
+ #
1124
+ # @example Response structure
1125
+ #
1126
+ # resp.role_arn #=> String
1127
+ # resp.log_level #=> String, one of "DEBUG", "INFO", "ERROR", "WARN", "DISABLED"
1128
+ #
1129
+ # @overload get_logging_options(params = {})
1130
+ # @param [Hash] params ({})
1131
+ def get_logging_options(params = {}, options = {})
1132
+ req = build_request(:get_logging_options, params)
1133
+ req.send_request(options)
1134
+ end
987
1135
 
988
- # Gets information about the specified policy with the policy document
989
- # of the default version.
990
- # @option params [required, String] :policy_name
991
- # The name of the policy.
992
- # @return [Types::GetPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
993
- #
994
- # * {Types::GetPolicyResponse#policy_name #policyName} => String
995
- # * {Types::GetPolicyResponse#policy_arn #policyArn} => String
996
- # * {Types::GetPolicyResponse#policy_document #policyDocument} => String
997
- # * {Types::GetPolicyResponse#default_version_id #defaultVersionId} => String
998
- #
999
- # @example Request syntax with placeholder values
1000
- # resp = client.get_policy({
1001
- # policy_name: "PolicyName", # required
1002
- # })
1003
- #
1004
- # @example Response structure
1005
- # resp.policy_name #=> String
1006
- # resp.policy_arn #=> String
1007
- # resp.policy_document #=> String
1008
- # resp.default_version_id #=> String
1009
- # @overload get_policy(params = {})
1010
- # @param [Hash] params ({})
1011
- def get_policy(params = {}, options = {})
1012
- req = build_request(:get_policy, params)
1013
- req.send_request(options)
1014
- end
1136
+ # Gets information about the specified policy with the policy document
1137
+ # of the default version.
1138
+ #
1139
+ # @option params [required, String] :policy_name
1140
+ # The name of the policy.
1141
+ #
1142
+ # @return [Types::GetPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1143
+ #
1144
+ # * {Types::GetPolicyResponse#policy_name #policy_name} => String
1145
+ # * {Types::GetPolicyResponse#policy_arn #policy_arn} => String
1146
+ # * {Types::GetPolicyResponse#policy_document #policy_document} => String
1147
+ # * {Types::GetPolicyResponse#default_version_id #default_version_id} => String
1148
+ #
1149
+ # @example Request syntax with placeholder values
1150
+ #
1151
+ # resp = client.get_policy({
1152
+ # policy_name: "PolicyName", # required
1153
+ # })
1154
+ #
1155
+ # @example Response structure
1156
+ #
1157
+ # resp.policy_name #=> String
1158
+ # resp.policy_arn #=> String
1159
+ # resp.policy_document #=> String
1160
+ # resp.default_version_id #=> String
1161
+ #
1162
+ # @overload get_policy(params = {})
1163
+ # @param [Hash] params ({})
1164
+ def get_policy(params = {}, options = {})
1165
+ req = build_request(:get_policy, params)
1166
+ req.send_request(options)
1167
+ end
1015
1168
 
1016
- # Gets information about the specified policy version.
1017
- # @option params [required, String] :policy_name
1018
- # The name of the policy.
1019
- # @option params [required, String] :policy_version_id
1020
- # The policy version ID.
1021
- # @return [Types::GetPolicyVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1022
- #
1023
- # * {Types::GetPolicyVersionResponse#policy_arn #policyArn} => String
1024
- # * {Types::GetPolicyVersionResponse#policy_name #policyName} => String
1025
- # * {Types::GetPolicyVersionResponse#policy_document #policyDocument} => String
1026
- # * {Types::GetPolicyVersionResponse#policy_version_id #policyVersionId} => String
1027
- # * {Types::GetPolicyVersionResponse#is_default_version #isDefaultVersion} => Boolean
1028
- #
1029
- # @example Request syntax with placeholder values
1030
- # resp = client.get_policy_version({
1031
- # policy_name: "PolicyName", # required
1032
- # policy_version_id: "PolicyVersionId", # required
1033
- # })
1034
- #
1035
- # @example Response structure
1036
- # resp.policy_arn #=> String
1037
- # resp.policy_name #=> String
1038
- # resp.policy_document #=> String
1039
- # resp.policy_version_id #=> String
1040
- # resp.is_default_version #=> Boolean
1041
- # @overload get_policy_version(params = {})
1042
- # @param [Hash] params ({})
1043
- def get_policy_version(params = {}, options = {})
1044
- req = build_request(:get_policy_version, params)
1045
- req.send_request(options)
1046
- end
1169
+ # Gets information about the specified policy version.
1170
+ #
1171
+ # @option params [required, String] :policy_name
1172
+ # The name of the policy.
1173
+ #
1174
+ # @option params [required, String] :policy_version_id
1175
+ # The policy version ID.
1176
+ #
1177
+ # @return [Types::GetPolicyVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1178
+ #
1179
+ # * {Types::GetPolicyVersionResponse#policy_arn #policy_arn} => String
1180
+ # * {Types::GetPolicyVersionResponse#policy_name #policy_name} => String
1181
+ # * {Types::GetPolicyVersionResponse#policy_document #policy_document} => String
1182
+ # * {Types::GetPolicyVersionResponse#policy_version_id #policy_version_id} => String
1183
+ # * {Types::GetPolicyVersionResponse#is_default_version #is_default_version} => Boolean
1184
+ #
1185
+ # @example Request syntax with placeholder values
1186
+ #
1187
+ # resp = client.get_policy_version({
1188
+ # policy_name: "PolicyName", # required
1189
+ # policy_version_id: "PolicyVersionId", # required
1190
+ # })
1191
+ #
1192
+ # @example Response structure
1193
+ #
1194
+ # resp.policy_arn #=> String
1195
+ # resp.policy_name #=> String
1196
+ # resp.policy_document #=> String
1197
+ # resp.policy_version_id #=> String
1198
+ # resp.is_default_version #=> Boolean
1199
+ #
1200
+ # @overload get_policy_version(params = {})
1201
+ # @param [Hash] params ({})
1202
+ def get_policy_version(params = {}, options = {})
1203
+ req = build_request(:get_policy_version, params)
1204
+ req.send_request(options)
1205
+ end
1047
1206
 
1048
- # Gets a registration code used to register a CA certificate with AWS
1049
- # IoT.
1050
- # @return [Types::GetRegistrationCodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1051
- #
1052
- # * {Types::GetRegistrationCodeResponse#registration_code #registrationCode} => String
1053
- #
1054
- # @example Request syntax with placeholder values
1055
- # resp = client.get_registration_code()
1056
- #
1057
- # @example Response structure
1058
- # resp.registration_code #=> String
1059
- # @overload get_registration_code(params = {})
1060
- # @param [Hash] params ({})
1061
- def get_registration_code(params = {}, options = {})
1062
- req = build_request(:get_registration_code, params)
1063
- req.send_request(options)
1064
- end
1207
+ # Gets a registration code used to register a CA certificate with AWS
1208
+ # IoT.
1209
+ #
1210
+ # @return [Types::GetRegistrationCodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1211
+ #
1212
+ # * {Types::GetRegistrationCodeResponse#registration_code #registration_code} => String
1213
+ #
1214
+ # @example Response structure
1215
+ #
1216
+ # resp.registration_code #=> String
1217
+ #
1218
+ # @overload get_registration_code(params = {})
1219
+ # @param [Hash] params ({})
1220
+ def get_registration_code(params = {}, options = {})
1221
+ req = build_request(:get_registration_code, params)
1222
+ req.send_request(options)
1223
+ end
1065
1224
 
1066
- # Gets information about the specified rule.
1067
- # @option params [required, String] :rule_name
1068
- # The name of the rule.
1069
- # @return [Types::GetTopicRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1070
- #
1071
- # * {Types::GetTopicRuleResponse#rule_arn #ruleArn} => String
1072
- # * {Types::GetTopicRuleResponse#rule #rule} => Types::TopicRule
1073
- #
1074
- # @example Request syntax with placeholder values
1075
- # resp = client.get_topic_rule({
1076
- # rule_name: "RuleName", # required
1077
- # })
1078
- #
1079
- # @example Response structure
1080
- # resp.rule_arn #=> String
1081
- # resp.rule.rule_name #=> String
1082
- # resp.rule.sql #=> String
1083
- # resp.rule.description #=> String
1084
- # resp.rule.created_at #=> Time
1085
- # resp.rule.actions #=> Array
1086
- # resp.rule.actions[0].dynamo_db.table_name #=> String
1087
- # resp.rule.actions[0].dynamo_db.role_arn #=> String
1088
- # resp.rule.actions[0].dynamo_db.operation #=> String
1089
- # resp.rule.actions[0].dynamo_db.hash_key_field #=> String
1090
- # resp.rule.actions[0].dynamo_db.hash_key_value #=> String
1091
- # resp.rule.actions[0].dynamo_db.hash_key_type #=> String, one of "STRING", "NUMBER"
1092
- # resp.rule.actions[0].dynamo_db.range_key_field #=> String
1093
- # resp.rule.actions[0].dynamo_db.range_key_value #=> String
1094
- # resp.rule.actions[0].dynamo_db.range_key_type #=> String, one of "STRING", "NUMBER"
1095
- # resp.rule.actions[0].dynamo_db.payload_field #=> String
1096
- # resp.rule.actions[0].dynamo_d_bv_2.role_arn #=> String
1097
- # resp.rule.actions[0].dynamo_d_bv_2.put_item.table_name #=> String
1098
- # resp.rule.actions[0].lambda.function_arn #=> String
1099
- # resp.rule.actions[0].sns.target_arn #=> String
1100
- # resp.rule.actions[0].sns.role_arn #=> String
1101
- # resp.rule.actions[0].sns.message_format #=> String, one of "RAW", "JSON"
1102
- # resp.rule.actions[0].sqs.role_arn #=> String
1103
- # resp.rule.actions[0].sqs.queue_url #=> String
1104
- # resp.rule.actions[0].sqs.use_base_64 #=> Boolean
1105
- # resp.rule.actions[0].kinesis.role_arn #=> String
1106
- # resp.rule.actions[0].kinesis.stream_name #=> String
1107
- # resp.rule.actions[0].kinesis.partition_key #=> String
1108
- # resp.rule.actions[0].republish.role_arn #=> String
1109
- # resp.rule.actions[0].republish.topic #=> String
1110
- # resp.rule.actions[0].s3.role_arn #=> String
1111
- # resp.rule.actions[0].s3.bucket_name #=> String
1112
- # resp.rule.actions[0].s3.key #=> String
1113
- # resp.rule.actions[0].s3.canned_acl #=> String, one of "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control", "log-delivery-write"
1114
- # resp.rule.actions[0].firehose.role_arn #=> String
1115
- # resp.rule.actions[0].firehose.delivery_stream_name #=> String
1116
- # resp.rule.actions[0].firehose.separator #=> String
1117
- # resp.rule.actions[0].cloudwatch_metric.role_arn #=> String
1118
- # resp.rule.actions[0].cloudwatch_metric.metric_namespace #=> String
1119
- # resp.rule.actions[0].cloudwatch_metric.metric_name #=> String
1120
- # resp.rule.actions[0].cloudwatch_metric.metric_value #=> String
1121
- # resp.rule.actions[0].cloudwatch_metric.metric_unit #=> String
1122
- # resp.rule.actions[0].cloudwatch_metric.metric_timestamp #=> String
1123
- # resp.rule.actions[0].cloudwatch_alarm.role_arn #=> String
1124
- # resp.rule.actions[0].cloudwatch_alarm.alarm_name #=> String
1125
- # resp.rule.actions[0].cloudwatch_alarm.state_reason #=> String
1126
- # resp.rule.actions[0].cloudwatch_alarm.state_value #=> String
1127
- # resp.rule.actions[0].elasticsearch.role_arn #=> String
1128
- # resp.rule.actions[0].elasticsearch.endpoint #=> String
1129
- # resp.rule.actions[0].elasticsearch.index #=> String
1130
- # resp.rule.actions[0].elasticsearch.type #=> String
1131
- # resp.rule.actions[0].elasticsearch.id #=> String
1132
- # resp.rule.rule_disabled #=> Boolean
1133
- # resp.rule.aws_iot_sql_version #=> String
1134
- # @overload get_topic_rule(params = {})
1135
- # @param [Hash] params ({})
1136
- def get_topic_rule(params = {}, options = {})
1137
- req = build_request(:get_topic_rule, params)
1138
- req.send_request(options)
1139
- end
1225
+ # Gets information about the specified rule.
1226
+ #
1227
+ # @option params [required, String] :rule_name
1228
+ # The name of the rule.
1229
+ #
1230
+ # @return [Types::GetTopicRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1231
+ #
1232
+ # * {Types::GetTopicRuleResponse#rule_arn #rule_arn} => String
1233
+ # * {Types::GetTopicRuleResponse#rule #rule} => Types::TopicRule
1234
+ #
1235
+ # @example Request syntax with placeholder values
1236
+ #
1237
+ # resp = client.get_topic_rule({
1238
+ # rule_name: "RuleName", # required
1239
+ # })
1240
+ #
1241
+ # @example Response structure
1242
+ #
1243
+ # resp.rule_arn #=> String
1244
+ # resp.rule.rule_name #=> String
1245
+ # resp.rule.sql #=> String
1246
+ # resp.rule.description #=> String
1247
+ # resp.rule.created_at #=> Time
1248
+ # resp.rule.actions #=> Array
1249
+ # resp.rule.actions[0].dynamo_db.table_name #=> String
1250
+ # resp.rule.actions[0].dynamo_db.role_arn #=> String
1251
+ # resp.rule.actions[0].dynamo_db.operation #=> String
1252
+ # resp.rule.actions[0].dynamo_db.hash_key_field #=> String
1253
+ # resp.rule.actions[0].dynamo_db.hash_key_value #=> String
1254
+ # resp.rule.actions[0].dynamo_db.hash_key_type #=> String, one of "STRING", "NUMBER"
1255
+ # resp.rule.actions[0].dynamo_db.range_key_field #=> String
1256
+ # resp.rule.actions[0].dynamo_db.range_key_value #=> String
1257
+ # resp.rule.actions[0].dynamo_db.range_key_type #=> String, one of "STRING", "NUMBER"
1258
+ # resp.rule.actions[0].dynamo_db.payload_field #=> String
1259
+ # resp.rule.actions[0].dynamo_d_bv_2.role_arn #=> String
1260
+ # resp.rule.actions[0].dynamo_d_bv_2.put_item.table_name #=> String
1261
+ # resp.rule.actions[0].lambda.function_arn #=> String
1262
+ # resp.rule.actions[0].sns.target_arn #=> String
1263
+ # resp.rule.actions[0].sns.role_arn #=> String
1264
+ # resp.rule.actions[0].sns.message_format #=> String, one of "RAW", "JSON"
1265
+ # resp.rule.actions[0].sqs.role_arn #=> String
1266
+ # resp.rule.actions[0].sqs.queue_url #=> String
1267
+ # resp.rule.actions[0].sqs.use_base_64 #=> Boolean
1268
+ # resp.rule.actions[0].kinesis.role_arn #=> String
1269
+ # resp.rule.actions[0].kinesis.stream_name #=> String
1270
+ # resp.rule.actions[0].kinesis.partition_key #=> String
1271
+ # resp.rule.actions[0].republish.role_arn #=> String
1272
+ # resp.rule.actions[0].republish.topic #=> String
1273
+ # resp.rule.actions[0].s3.role_arn #=> String
1274
+ # resp.rule.actions[0].s3.bucket_name #=> String
1275
+ # resp.rule.actions[0].s3.key #=> String
1276
+ # resp.rule.actions[0].s3.canned_acl #=> String, one of "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control", "log-delivery-write"
1277
+ # resp.rule.actions[0].firehose.role_arn #=> String
1278
+ # resp.rule.actions[0].firehose.delivery_stream_name #=> String
1279
+ # resp.rule.actions[0].firehose.separator #=> String
1280
+ # resp.rule.actions[0].cloudwatch_metric.role_arn #=> String
1281
+ # resp.rule.actions[0].cloudwatch_metric.metric_namespace #=> String
1282
+ # resp.rule.actions[0].cloudwatch_metric.metric_name #=> String
1283
+ # resp.rule.actions[0].cloudwatch_metric.metric_value #=> String
1284
+ # resp.rule.actions[0].cloudwatch_metric.metric_unit #=> String
1285
+ # resp.rule.actions[0].cloudwatch_metric.metric_timestamp #=> String
1286
+ # resp.rule.actions[0].cloudwatch_alarm.role_arn #=> String
1287
+ # resp.rule.actions[0].cloudwatch_alarm.alarm_name #=> String
1288
+ # resp.rule.actions[0].cloudwatch_alarm.state_reason #=> String
1289
+ # resp.rule.actions[0].cloudwatch_alarm.state_value #=> String
1290
+ # resp.rule.actions[0].elasticsearch.role_arn #=> String
1291
+ # resp.rule.actions[0].elasticsearch.endpoint #=> String
1292
+ # resp.rule.actions[0].elasticsearch.index #=> String
1293
+ # resp.rule.actions[0].elasticsearch.type #=> String
1294
+ # resp.rule.actions[0].elasticsearch.id #=> String
1295
+ # resp.rule.rule_disabled #=> Boolean
1296
+ # resp.rule.aws_iot_sql_version #=> String
1297
+ #
1298
+ # @overload get_topic_rule(params = {})
1299
+ # @param [Hash] params ({})
1300
+ def get_topic_rule(params = {}, options = {})
1301
+ req = build_request(:get_topic_rule, params)
1302
+ req.send_request(options)
1303
+ end
1140
1304
 
1141
- # Lists the CA certificates registered for your AWS account.
1142
- #
1143
- # The results are paginated with a default page size of 25. You can use
1144
- # the returned marker to retrieve additional results.
1145
- # @option params [Integer] :page_size
1146
- # The result page size.
1147
- # @option params [String] :marker
1148
- # The marker for the next set of results.
1149
- # @option params [Boolean] :ascending_order
1150
- # Determines the order of the results.
1151
- # @return [Types::ListCACertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1152
- #
1153
- # * {Types::ListCACertificatesResponse#certificates #certificates} => Array&lt;Types::CACertificate&gt;
1154
- # * {Types::ListCACertificatesResponse#next_marker #nextMarker} => String
1155
- #
1156
- # @example Request syntax with placeholder values
1157
- # resp = client.list_ca_certificates({
1158
- # page_size: 1,
1159
- # marker: "Marker",
1160
- # ascending_order: false,
1161
- # })
1162
- #
1163
- # @example Response structure
1164
- # resp.certificates #=> Array
1165
- # resp.certificates[0].certificate_arn #=> String
1166
- # resp.certificates[0].certificate_id #=> String
1167
- # resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE"
1168
- # resp.certificates[0].creation_date #=> Time
1169
- # resp.next_marker #=> String
1170
- # @overload list_ca_certificates(params = {})
1171
- # @param [Hash] params ({})
1172
- def list_ca_certificates(params = {}, options = {})
1173
- req = build_request(:list_ca_certificates, params)
1174
- req.send_request(options)
1175
- end
1305
+ # Lists the CA certificates registered for your AWS account.
1306
+ #
1307
+ # The results are paginated with a default page size of 25. You can use
1308
+ # the returned marker to retrieve additional results.
1309
+ #
1310
+ # @option params [Integer] :page_size
1311
+ # The result page size.
1312
+ #
1313
+ # @option params [String] :marker
1314
+ # The marker for the next set of results.
1315
+ #
1316
+ # @option params [Boolean] :ascending_order
1317
+ # Determines the order of the results.
1318
+ #
1319
+ # @return [Types::ListCACertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1320
+ #
1321
+ # * {Types::ListCACertificatesResponse#certificates #certificates} => Array&lt;Types::CACertificate&gt;
1322
+ # * {Types::ListCACertificatesResponse#next_marker #next_marker} => String
1323
+ #
1324
+ # @example Request syntax with placeholder values
1325
+ #
1326
+ # resp = client.list_ca_certificates({
1327
+ # page_size: 1,
1328
+ # marker: "Marker",
1329
+ # ascending_order: false,
1330
+ # })
1331
+ #
1332
+ # @example Response structure
1333
+ #
1334
+ # resp.certificates #=> Array
1335
+ # resp.certificates[0].certificate_arn #=> String
1336
+ # resp.certificates[0].certificate_id #=> String
1337
+ # resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE"
1338
+ # resp.certificates[0].creation_date #=> Time
1339
+ # resp.next_marker #=> String
1340
+ #
1341
+ # @overload list_ca_certificates(params = {})
1342
+ # @param [Hash] params ({})
1343
+ def list_ca_certificates(params = {}, options = {})
1344
+ req = build_request(:list_ca_certificates, params)
1345
+ req.send_request(options)
1346
+ end
1176
1347
 
1177
- # Lists the certificates registered in your AWS account.
1178
- #
1179
- # The results are paginated with a default page size of 25. You can use
1180
- # the returned marker to retrieve additional results.
1181
- # @option params [Integer] :page_size
1182
- # The result page size.
1183
- # @option params [String] :marker
1184
- # The marker for the next set of results.
1185
- # @option params [Boolean] :ascending_order
1186
- # Specifies the order for results. If True, the results are returned in
1187
- # ascending order, based on the creation date.
1188
- # @return [Types::ListCertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1189
- #
1190
- # * {Types::ListCertificatesResponse#certificates #certificates} => Array&lt;Types::Certificate&gt;
1191
- # * {Types::ListCertificatesResponse#next_marker #nextMarker} => String
1192
- #
1193
- # @example Request syntax with placeholder values
1194
- # resp = client.list_certificates({
1195
- # page_size: 1,
1196
- # marker: "Marker",
1197
- # ascending_order: false,
1198
- # })
1199
- #
1200
- # @example Response structure
1201
- # resp.certificates #=> Array
1202
- # resp.certificates[0].certificate_arn #=> String
1203
- # resp.certificates[0].certificate_id #=> String
1204
- # resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
1205
- # resp.certificates[0].creation_date #=> Time
1206
- # resp.next_marker #=> String
1207
- # @overload list_certificates(params = {})
1208
- # @param [Hash] params ({})
1209
- def list_certificates(params = {}, options = {})
1210
- req = build_request(:list_certificates, params)
1211
- req.send_request(options)
1212
- end
1348
+ # Lists the certificates registered in your AWS account.
1349
+ #
1350
+ # The results are paginated with a default page size of 25. You can use
1351
+ # the returned marker to retrieve additional results.
1352
+ #
1353
+ # @option params [Integer] :page_size
1354
+ # The result page size.
1355
+ #
1356
+ # @option params [String] :marker
1357
+ # The marker for the next set of results.
1358
+ #
1359
+ # @option params [Boolean] :ascending_order
1360
+ # Specifies the order for results. If True, the results are returned in
1361
+ # ascending order, based on the creation date.
1362
+ #
1363
+ # @return [Types::ListCertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1364
+ #
1365
+ # * {Types::ListCertificatesResponse#certificates #certificates} => Array&lt;Types::Certificate&gt;
1366
+ # * {Types::ListCertificatesResponse#next_marker #next_marker} => String
1367
+ #
1368
+ # @example Request syntax with placeholder values
1369
+ #
1370
+ # resp = client.list_certificates({
1371
+ # page_size: 1,
1372
+ # marker: "Marker",
1373
+ # ascending_order: false,
1374
+ # })
1375
+ #
1376
+ # @example Response structure
1377
+ #
1378
+ # resp.certificates #=> Array
1379
+ # resp.certificates[0].certificate_arn #=> String
1380
+ # resp.certificates[0].certificate_id #=> String
1381
+ # resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
1382
+ # resp.certificates[0].creation_date #=> Time
1383
+ # resp.next_marker #=> String
1384
+ #
1385
+ # @overload list_certificates(params = {})
1386
+ # @param [Hash] params ({})
1387
+ def list_certificates(params = {}, options = {})
1388
+ req = build_request(:list_certificates, params)
1389
+ req.send_request(options)
1390
+ end
1213
1391
 
1214
- # List the device certificates signed by the specified CA certificate.
1215
- # @option params [required, String] :ca_certificate_id
1216
- # The ID of the CA certificate. This operation will list all registered
1217
- # device certificate that were signed by this CA certificate.
1218
- # @option params [Integer] :page_size
1219
- # The result page size.
1220
- # @option params [String] :marker
1221
- # The marker for the next set of results.
1222
- # @option params [Boolean] :ascending_order
1223
- # Specifies the order for results. If True, the results are returned in
1224
- # ascending order, based on the creation date.
1225
- # @return [Types::ListCertificatesByCAResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1226
- #
1227
- # * {Types::ListCertificatesByCAResponse#certificates #certificates} => Array&lt;Types::Certificate&gt;
1228
- # * {Types::ListCertificatesByCAResponse#next_marker #nextMarker} => String
1229
- #
1230
- # @example Request syntax with placeholder values
1231
- # resp = client.list_certificates_by_ca({
1232
- # ca_certificate_id: "CertificateId", # required
1233
- # page_size: 1,
1234
- # marker: "Marker",
1235
- # ascending_order: false,
1236
- # })
1237
- #
1238
- # @example Response structure
1239
- # resp.certificates #=> Array
1240
- # resp.certificates[0].certificate_arn #=> String
1241
- # resp.certificates[0].certificate_id #=> String
1242
- # resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
1243
- # resp.certificates[0].creation_date #=> Time
1244
- # resp.next_marker #=> String
1245
- # @overload list_certificates_by_ca(params = {})
1246
- # @param [Hash] params ({})
1247
- def list_certificates_by_ca(params = {}, options = {})
1248
- req = build_request(:list_certificates_by_ca, params)
1249
- req.send_request(options)
1250
- end
1392
+ # List the device certificates signed by the specified CA certificate.
1393
+ #
1394
+ # @option params [required, String] :ca_certificate_id
1395
+ # The ID of the CA certificate. This operation will list all registered
1396
+ # device certificate that were signed by this CA certificate.
1397
+ #
1398
+ # @option params [Integer] :page_size
1399
+ # The result page size.
1400
+ #
1401
+ # @option params [String] :marker
1402
+ # The marker for the next set of results.
1403
+ #
1404
+ # @option params [Boolean] :ascending_order
1405
+ # Specifies the order for results. If True, the results are returned in
1406
+ # ascending order, based on the creation date.
1407
+ #
1408
+ # @return [Types::ListCertificatesByCAResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1409
+ #
1410
+ # * {Types::ListCertificatesByCAResponse#certificates #certificates} => Array&lt;Types::Certificate&gt;
1411
+ # * {Types::ListCertificatesByCAResponse#next_marker #next_marker} => String
1412
+ #
1413
+ # @example Request syntax with placeholder values
1414
+ #
1415
+ # resp = client.list_certificates_by_ca({
1416
+ # ca_certificate_id: "CertificateId", # required
1417
+ # page_size: 1,
1418
+ # marker: "Marker",
1419
+ # ascending_order: false,
1420
+ # })
1421
+ #
1422
+ # @example Response structure
1423
+ #
1424
+ # resp.certificates #=> Array
1425
+ # resp.certificates[0].certificate_arn #=> String
1426
+ # resp.certificates[0].certificate_id #=> String
1427
+ # resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
1428
+ # resp.certificates[0].creation_date #=> Time
1429
+ # resp.next_marker #=> String
1430
+ #
1431
+ # @overload list_certificates_by_ca(params = {})
1432
+ # @param [Hash] params ({})
1433
+ def list_certificates_by_ca(params = {}, options = {})
1434
+ req = build_request(:list_certificates_by_ca, params)
1435
+ req.send_request(options)
1436
+ end
1251
1437
 
1252
- # Lists certificates that are being transfered but not yet accepted.
1253
- # @option params [Integer] :page_size
1254
- # The result page size.
1255
- # @option params [String] :marker
1256
- # The marker for the next set of results.
1257
- # @option params [Boolean] :ascending_order
1258
- # Specifies the order for results. If True, the results are returned in
1259
- # ascending order, based on the creation date.
1260
- # @return [Types::ListOutgoingCertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1261
- #
1262
- # * {Types::ListOutgoingCertificatesResponse#outgoing_certificates #outgoingCertificates} => Array&lt;Types::OutgoingCertificate&gt;
1263
- # * {Types::ListOutgoingCertificatesResponse#next_marker #nextMarker} => String
1264
- #
1265
- # @example Request syntax with placeholder values
1266
- # resp = client.list_outgoing_certificates({
1267
- # page_size: 1,
1268
- # marker: "Marker",
1269
- # ascending_order: false,
1270
- # })
1271
- #
1272
- # @example Response structure
1273
- # resp.outgoing_certificates #=> Array
1274
- # resp.outgoing_certificates[0].certificate_arn #=> String
1275
- # resp.outgoing_certificates[0].certificate_id #=> String
1276
- # resp.outgoing_certificates[0].transferred_to #=> String
1277
- # resp.outgoing_certificates[0].transfer_date #=> Time
1278
- # resp.outgoing_certificates[0].transfer_message #=> String
1279
- # resp.outgoing_certificates[0].creation_date #=> Time
1280
- # resp.next_marker #=> String
1281
- # @overload list_outgoing_certificates(params = {})
1282
- # @param [Hash] params ({})
1283
- def list_outgoing_certificates(params = {}, options = {})
1284
- req = build_request(:list_outgoing_certificates, params)
1285
- req.send_request(options)
1286
- end
1438
+ # Lists certificates that are being transfered but not yet accepted.
1439
+ #
1440
+ # @option params [Integer] :page_size
1441
+ # The result page size.
1442
+ #
1443
+ # @option params [String] :marker
1444
+ # The marker for the next set of results.
1445
+ #
1446
+ # @option params [Boolean] :ascending_order
1447
+ # Specifies the order for results. If True, the results are returned in
1448
+ # ascending order, based on the creation date.
1449
+ #
1450
+ # @return [Types::ListOutgoingCertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1451
+ #
1452
+ # * {Types::ListOutgoingCertificatesResponse#outgoing_certificates #outgoing_certificates} => Array&lt;Types::OutgoingCertificate&gt;
1453
+ # * {Types::ListOutgoingCertificatesResponse#next_marker #next_marker} => String
1454
+ #
1455
+ # @example Request syntax with placeholder values
1456
+ #
1457
+ # resp = client.list_outgoing_certificates({
1458
+ # page_size: 1,
1459
+ # marker: "Marker",
1460
+ # ascending_order: false,
1461
+ # })
1462
+ #
1463
+ # @example Response structure
1464
+ #
1465
+ # resp.outgoing_certificates #=> Array
1466
+ # resp.outgoing_certificates[0].certificate_arn #=> String
1467
+ # resp.outgoing_certificates[0].certificate_id #=> String
1468
+ # resp.outgoing_certificates[0].transferred_to #=> String
1469
+ # resp.outgoing_certificates[0].transfer_date #=> Time
1470
+ # resp.outgoing_certificates[0].transfer_message #=> String
1471
+ # resp.outgoing_certificates[0].creation_date #=> Time
1472
+ # resp.next_marker #=> String
1473
+ #
1474
+ # @overload list_outgoing_certificates(params = {})
1475
+ # @param [Hash] params ({})
1476
+ def list_outgoing_certificates(params = {}, options = {})
1477
+ req = build_request(:list_outgoing_certificates, params)
1478
+ req.send_request(options)
1479
+ end
1287
1480
 
1288
- # Lists your policies.
1289
- # @option params [String] :marker
1290
- # The marker for the next set of results.
1291
- # @option params [Integer] :page_size
1292
- # The result page size.
1293
- # @option params [Boolean] :ascending_order
1294
- # Specifies the order for results. If true, the results are returned in
1295
- # ascending creation order.
1296
- # @return [Types::ListPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1297
- #
1298
- # * {Types::ListPoliciesResponse#policies #policies} => Array&lt;Types::Policy&gt;
1299
- # * {Types::ListPoliciesResponse#next_marker #nextMarker} => String
1300
- #
1301
- # @example Request syntax with placeholder values
1302
- # resp = client.list_policies({
1303
- # marker: "Marker",
1304
- # page_size: 1,
1305
- # ascending_order: false,
1306
- # })
1307
- #
1308
- # @example Response structure
1309
- # resp.policies #=> Array
1310
- # resp.policies[0].policy_name #=> String
1311
- # resp.policies[0].policy_arn #=> String
1312
- # resp.next_marker #=> String
1313
- # @overload list_policies(params = {})
1314
- # @param [Hash] params ({})
1315
- def list_policies(params = {}, options = {})
1316
- req = build_request(:list_policies, params)
1317
- req.send_request(options)
1318
- end
1481
+ # Lists your policies.
1482
+ #
1483
+ # @option params [String] :marker
1484
+ # The marker for the next set of results.
1485
+ #
1486
+ # @option params [Integer] :page_size
1487
+ # The result page size.
1488
+ #
1489
+ # @option params [Boolean] :ascending_order
1490
+ # Specifies the order for results. If true, the results are returned in
1491
+ # ascending creation order.
1492
+ #
1493
+ # @return [Types::ListPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1494
+ #
1495
+ # * {Types::ListPoliciesResponse#policies #policies} => Array&lt;Types::Policy&gt;
1496
+ # * {Types::ListPoliciesResponse#next_marker #next_marker} => String
1497
+ #
1498
+ # @example Request syntax with placeholder values
1499
+ #
1500
+ # resp = client.list_policies({
1501
+ # marker: "Marker",
1502
+ # page_size: 1,
1503
+ # ascending_order: false,
1504
+ # })
1505
+ #
1506
+ # @example Response structure
1507
+ #
1508
+ # resp.policies #=> Array
1509
+ # resp.policies[0].policy_name #=> String
1510
+ # resp.policies[0].policy_arn #=> String
1511
+ # resp.next_marker #=> String
1512
+ #
1513
+ # @overload list_policies(params = {})
1514
+ # @param [Hash] params ({})
1515
+ def list_policies(params = {}, options = {})
1516
+ req = build_request(:list_policies, params)
1517
+ req.send_request(options)
1518
+ end
1319
1519
 
1320
- # Lists the principals associated with the specified policy.
1321
- # @option params [required, String] :policy_name
1322
- # The policy name.
1323
- # @option params [String] :marker
1324
- # The marker for the next set of results.
1325
- # @option params [Integer] :page_size
1326
- # The result page size.
1327
- # @option params [Boolean] :ascending_order
1328
- # Specifies the order for results. If true, the results are returned in
1329
- # ascending creation order.
1330
- # @return [Types::ListPolicyPrincipalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1331
- #
1332
- # * {Types::ListPolicyPrincipalsResponse#principals #principals} => Array&lt;String&gt;
1333
- # * {Types::ListPolicyPrincipalsResponse#next_marker #nextMarker} => String
1334
- #
1335
- # @example Request syntax with placeholder values
1336
- # resp = client.list_policy_principals({
1337
- # policy_name: "PolicyName", # required
1338
- # marker: "Marker",
1339
- # page_size: 1,
1340
- # ascending_order: false,
1341
- # })
1342
- #
1343
- # @example Response structure
1344
- # resp.principals #=> Array
1345
- # resp.principals[0] #=> String
1346
- # resp.next_marker #=> String
1347
- # @overload list_policy_principals(params = {})
1348
- # @param [Hash] params ({})
1349
- def list_policy_principals(params = {}, options = {})
1350
- req = build_request(:list_policy_principals, params)
1351
- req.send_request(options)
1352
- end
1520
+ # Lists the principals associated with the specified policy.
1521
+ #
1522
+ # @option params [required, String] :policy_name
1523
+ # The policy name.
1524
+ #
1525
+ # @option params [String] :marker
1526
+ # The marker for the next set of results.
1527
+ #
1528
+ # @option params [Integer] :page_size
1529
+ # The result page size.
1530
+ #
1531
+ # @option params [Boolean] :ascending_order
1532
+ # Specifies the order for results. If true, the results are returned in
1533
+ # ascending creation order.
1534
+ #
1535
+ # @return [Types::ListPolicyPrincipalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1536
+ #
1537
+ # * {Types::ListPolicyPrincipalsResponse#principals #principals} => Array&lt;String&gt;
1538
+ # * {Types::ListPolicyPrincipalsResponse#next_marker #next_marker} => String
1539
+ #
1540
+ # @example Request syntax with placeholder values
1541
+ #
1542
+ # resp = client.list_policy_principals({
1543
+ # policy_name: "PolicyName", # required
1544
+ # marker: "Marker",
1545
+ # page_size: 1,
1546
+ # ascending_order: false,
1547
+ # })
1548
+ #
1549
+ # @example Response structure
1550
+ #
1551
+ # resp.principals #=> Array
1552
+ # resp.principals[0] #=> String
1553
+ # resp.next_marker #=> String
1554
+ #
1555
+ # @overload list_policy_principals(params = {})
1556
+ # @param [Hash] params ({})
1557
+ def list_policy_principals(params = {}, options = {})
1558
+ req = build_request(:list_policy_principals, params)
1559
+ req.send_request(options)
1560
+ end
1353
1561
 
1354
- # Lists the versions of the specified policy and identifies the default
1355
- # version.
1356
- # @option params [required, String] :policy_name
1357
- # The policy name.
1358
- # @return [Types::ListPolicyVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1359
- #
1360
- # * {Types::ListPolicyVersionsResponse#policy_versions #policyVersions} => Array&lt;Types::PolicyVersion&gt;
1361
- #
1362
- # @example Request syntax with placeholder values
1363
- # resp = client.list_policy_versions({
1364
- # policy_name: "PolicyName", # required
1365
- # })
1366
- #
1367
- # @example Response structure
1368
- # resp.policy_versions #=> Array
1369
- # resp.policy_versions[0].version_id #=> String
1370
- # resp.policy_versions[0].is_default_version #=> Boolean
1371
- # resp.policy_versions[0].create_date #=> Time
1372
- # @overload list_policy_versions(params = {})
1373
- # @param [Hash] params ({})
1374
- def list_policy_versions(params = {}, options = {})
1375
- req = build_request(:list_policy_versions, params)
1376
- req.send_request(options)
1377
- end
1562
+ # Lists the versions of the specified policy and identifies the default
1563
+ # version.
1564
+ #
1565
+ # @option params [required, String] :policy_name
1566
+ # The policy name.
1567
+ #
1568
+ # @return [Types::ListPolicyVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1569
+ #
1570
+ # * {Types::ListPolicyVersionsResponse#policy_versions #policy_versions} => Array&lt;Types::PolicyVersion&gt;
1571
+ #
1572
+ # @example Request syntax with placeholder values
1573
+ #
1574
+ # resp = client.list_policy_versions({
1575
+ # policy_name: "PolicyName", # required
1576
+ # })
1577
+ #
1578
+ # @example Response structure
1579
+ #
1580
+ # resp.policy_versions #=> Array
1581
+ # resp.policy_versions[0].version_id #=> String
1582
+ # resp.policy_versions[0].is_default_version #=> Boolean
1583
+ # resp.policy_versions[0].create_date #=> Time
1584
+ #
1585
+ # @overload list_policy_versions(params = {})
1586
+ # @param [Hash] params ({})
1587
+ def list_policy_versions(params = {}, options = {})
1588
+ req = build_request(:list_policy_versions, params)
1589
+ req.send_request(options)
1590
+ end
1378
1591
 
1379
- # Lists the policies attached to the specified principal. If you use an
1380
- # Cognito identity, the ID must be in [AmazonCognito Identity
1381
- # format][1].
1382
- #
1383
- #
1384
- #
1385
- # [1]: http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax
1386
- # @option params [required, String] :principal
1387
- # The principal.
1388
- # @option params [String] :marker
1389
- # The marker for the next set of results.
1390
- # @option params [Integer] :page_size
1391
- # The result page size.
1392
- # @option params [Boolean] :ascending_order
1393
- # Specifies the order for results. If true, results are returned in
1394
- # ascending creation order.
1395
- # @return [Types::ListPrincipalPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1396
- #
1397
- # * {Types::ListPrincipalPoliciesResponse#policies #policies} => Array&lt;Types::Policy&gt;
1398
- # * {Types::ListPrincipalPoliciesResponse#next_marker #nextMarker} => String
1399
- #
1400
- # @example Request syntax with placeholder values
1401
- # resp = client.list_principal_policies({
1402
- # principal: "Principal", # required
1403
- # marker: "Marker",
1404
- # page_size: 1,
1405
- # ascending_order: false,
1406
- # })
1407
- #
1408
- # @example Response structure
1409
- # resp.policies #=> Array
1410
- # resp.policies[0].policy_name #=> String
1411
- # resp.policies[0].policy_arn #=> String
1412
- # resp.next_marker #=> String
1413
- # @overload list_principal_policies(params = {})
1414
- # @param [Hash] params ({})
1415
- def list_principal_policies(params = {}, options = {})
1416
- req = build_request(:list_principal_policies, params)
1417
- req.send_request(options)
1418
- end
1592
+ # Lists the policies attached to the specified principal. If you use an
1593
+ # Cognito identity, the ID must be in [AmazonCognito Identity
1594
+ # format][1].
1595
+ #
1596
+ #
1597
+ #
1598
+ # [1]: http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax
1599
+ #
1600
+ # @option params [required, String] :principal
1601
+ # The principal.
1602
+ #
1603
+ # @option params [String] :marker
1604
+ # The marker for the next set of results.
1605
+ #
1606
+ # @option params [Integer] :page_size
1607
+ # The result page size.
1608
+ #
1609
+ # @option params [Boolean] :ascending_order
1610
+ # Specifies the order for results. If true, results are returned in
1611
+ # ascending creation order.
1612
+ #
1613
+ # @return [Types::ListPrincipalPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1614
+ #
1615
+ # * {Types::ListPrincipalPoliciesResponse#policies #policies} => Array&lt;Types::Policy&gt;
1616
+ # * {Types::ListPrincipalPoliciesResponse#next_marker #next_marker} => String
1617
+ #
1618
+ # @example Request syntax with placeholder values
1619
+ #
1620
+ # resp = client.list_principal_policies({
1621
+ # principal: "Principal", # required
1622
+ # marker: "Marker",
1623
+ # page_size: 1,
1624
+ # ascending_order: false,
1625
+ # })
1626
+ #
1627
+ # @example Response structure
1628
+ #
1629
+ # resp.policies #=> Array
1630
+ # resp.policies[0].policy_name #=> String
1631
+ # resp.policies[0].policy_arn #=> String
1632
+ # resp.next_marker #=> String
1633
+ #
1634
+ # @overload list_principal_policies(params = {})
1635
+ # @param [Hash] params ({})
1636
+ def list_principal_policies(params = {}, options = {})
1637
+ req = build_request(:list_principal_policies, params)
1638
+ req.send_request(options)
1639
+ end
1419
1640
 
1420
- # Lists the things associated with the specified principal.
1421
- # @option params [String] :next_token
1422
- # The token for the next set of results, or **null** if there are no
1423
- # additional results.
1424
- # @option params [Integer] :max_results
1425
- # The maximum number of results to return in this operation.
1426
- # @option params [required, String] :principal
1427
- # The principal.
1428
- # @return [Types::ListPrincipalThingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1429
- #
1430
- # * {Types::ListPrincipalThingsResponse#things #things} => Array&lt;String&gt;
1431
- # * {Types::ListPrincipalThingsResponse#next_token #nextToken} => String
1432
- #
1433
- # @example Request syntax with placeholder values
1434
- # resp = client.list_principal_things({
1435
- # next_token: "NextToken",
1436
- # max_results: 1,
1437
- # principal: "Principal", # required
1438
- # })
1439
- #
1440
- # @example Response structure
1441
- # resp.things #=> Array
1442
- # resp.things[0] #=> String
1443
- # resp.next_token #=> String
1444
- # @overload list_principal_things(params = {})
1445
- # @param [Hash] params ({})
1446
- def list_principal_things(params = {}, options = {})
1447
- req = build_request(:list_principal_things, params)
1448
- req.send_request(options)
1449
- end
1641
+ # Lists the things associated with the specified principal.
1642
+ #
1643
+ # @option params [String] :next_token
1644
+ # The token for the next set of results, or **null** if there are no
1645
+ # additional results.
1646
+ #
1647
+ # @option params [Integer] :max_results
1648
+ # The maximum number of results to return in this operation.
1649
+ #
1650
+ # @option params [required, String] :principal
1651
+ # The principal.
1652
+ #
1653
+ # @return [Types::ListPrincipalThingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1654
+ #
1655
+ # * {Types::ListPrincipalThingsResponse#things #things} => Array&lt;String&gt;
1656
+ # * {Types::ListPrincipalThingsResponse#next_token #next_token} => String
1657
+ #
1658
+ # @example Request syntax with placeholder values
1659
+ #
1660
+ # resp = client.list_principal_things({
1661
+ # next_token: "NextToken",
1662
+ # max_results: 1,
1663
+ # principal: "Principal", # required
1664
+ # })
1665
+ #
1666
+ # @example Response structure
1667
+ #
1668
+ # resp.things #=> Array
1669
+ # resp.things[0] #=> String
1670
+ # resp.next_token #=> String
1671
+ #
1672
+ # @overload list_principal_things(params = {})
1673
+ # @param [Hash] params ({})
1674
+ def list_principal_things(params = {}, options = {})
1675
+ req = build_request(:list_principal_things, params)
1676
+ req.send_request(options)
1677
+ end
1450
1678
 
1451
- # Lists the principals associated with the specified thing.
1452
- # @option params [required, String] :thing_name
1453
- # The name of the thing.
1454
- # @return [Types::ListThingPrincipalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1455
- #
1456
- # * {Types::ListThingPrincipalsResponse#principals #principals} => Array&lt;String&gt;
1457
- #
1458
- # @example Request syntax with placeholder values
1459
- # resp = client.list_thing_principals({
1460
- # thing_name: "ThingName", # required
1461
- # })
1462
- #
1463
- # @example Response structure
1464
- # resp.principals #=> Array
1465
- # resp.principals[0] #=> String
1466
- # @overload list_thing_principals(params = {})
1467
- # @param [Hash] params ({})
1468
- def list_thing_principals(params = {}, options = {})
1469
- req = build_request(:list_thing_principals, params)
1470
- req.send_request(options)
1471
- end
1679
+ # Lists the principals associated with the specified thing.
1680
+ #
1681
+ # @option params [required, String] :thing_name
1682
+ # The name of the thing.
1683
+ #
1684
+ # @return [Types::ListThingPrincipalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1685
+ #
1686
+ # * {Types::ListThingPrincipalsResponse#principals #principals} => Array&lt;String&gt;
1687
+ #
1688
+ # @example Request syntax with placeholder values
1689
+ #
1690
+ # resp = client.list_thing_principals({
1691
+ # thing_name: "ThingName", # required
1692
+ # })
1693
+ #
1694
+ # @example Response structure
1695
+ #
1696
+ # resp.principals #=> Array
1697
+ # resp.principals[0] #=> String
1698
+ #
1699
+ # @overload list_thing_principals(params = {})
1700
+ # @param [Hash] params ({})
1701
+ def list_thing_principals(params = {}, options = {})
1702
+ req = build_request(:list_thing_principals, params)
1703
+ req.send_request(options)
1704
+ end
1472
1705
 
1473
- # Lists the existing thing types.
1474
- # @option params [String] :next_token
1475
- # The token for the next set of results, or **null** if there are no
1476
- # additional results.
1477
- # @option params [Integer] :max_results
1478
- # The maximum number of results to return in this operation.
1479
- # @option params [String] :thing_type_name
1480
- # The name of the thing type.
1481
- # @return [Types::ListThingTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1482
- #
1483
- # * {Types::ListThingTypesResponse#thing_types #thingTypes} => Array&lt;Types::ThingTypeDefinition&gt;
1484
- # * {Types::ListThingTypesResponse#next_token #nextToken} => String
1485
- #
1486
- # @example Request syntax with placeholder values
1487
- # resp = client.list_thing_types({
1488
- # next_token: "NextToken",
1489
- # max_results: 1,
1490
- # thing_type_name: "ThingTypeName",
1491
- # })
1492
- #
1493
- # @example Response structure
1494
- # resp.thing_types #=> Array
1495
- # resp.thing_types[0].thing_type_name #=> String
1496
- # resp.thing_types[0].thing_type_properties.thing_type_description #=> String
1497
- # resp.thing_types[0].thing_type_properties.searchable_attributes #=> Array
1498
- # resp.thing_types[0].thing_type_properties.searchable_attributes[0] #=> String
1499
- # resp.thing_types[0].thing_type_metadata.deprecated #=> Boolean
1500
- # resp.thing_types[0].thing_type_metadata.deprecation_date #=> Time
1501
- # resp.thing_types[0].thing_type_metadata.creation_date #=> Time
1502
- # resp.next_token #=> String
1503
- # @overload list_thing_types(params = {})
1504
- # @param [Hash] params ({})
1505
- def list_thing_types(params = {}, options = {})
1506
- req = build_request(:list_thing_types, params)
1507
- req.send_request(options)
1508
- end
1706
+ # Lists the existing thing types.
1707
+ #
1708
+ # @option params [String] :next_token
1709
+ # The token for the next set of results, or **null** if there are no
1710
+ # additional results.
1711
+ #
1712
+ # @option params [Integer] :max_results
1713
+ # The maximum number of results to return in this operation.
1714
+ #
1715
+ # @option params [String] :thing_type_name
1716
+ # The name of the thing type.
1717
+ #
1718
+ # @return [Types::ListThingTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1719
+ #
1720
+ # * {Types::ListThingTypesResponse#thing_types #thing_types} => Array&lt;Types::ThingTypeDefinition&gt;
1721
+ # * {Types::ListThingTypesResponse#next_token #next_token} => String
1722
+ #
1723
+ # @example Request syntax with placeholder values
1724
+ #
1725
+ # resp = client.list_thing_types({
1726
+ # next_token: "NextToken",
1727
+ # max_results: 1,
1728
+ # thing_type_name: "ThingTypeName",
1729
+ # })
1730
+ #
1731
+ # @example Response structure
1732
+ #
1733
+ # resp.thing_types #=> Array
1734
+ # resp.thing_types[0].thing_type_name #=> String
1735
+ # resp.thing_types[0].thing_type_properties.thing_type_description #=> String
1736
+ # resp.thing_types[0].thing_type_properties.searchable_attributes #=> Array
1737
+ # resp.thing_types[0].thing_type_properties.searchable_attributes[0] #=> String
1738
+ # resp.thing_types[0].thing_type_metadata.deprecated #=> Boolean
1739
+ # resp.thing_types[0].thing_type_metadata.deprecation_date #=> Time
1740
+ # resp.thing_types[0].thing_type_metadata.creation_date #=> Time
1741
+ # resp.next_token #=> String
1742
+ #
1743
+ # @overload list_thing_types(params = {})
1744
+ # @param [Hash] params ({})
1745
+ def list_thing_types(params = {}, options = {})
1746
+ req = build_request(:list_thing_types, params)
1747
+ req.send_request(options)
1748
+ end
1509
1749
 
1510
- # Lists your things. Use the **attributeName** and **attributeValue**
1511
- # parameters to filter your things. For example, calling `ListThings`
1512
- # with attributeName=Color and attributeValue=Red retrieves all things
1513
- # in the registry that contain an attribute **Color** with the value
1514
- # **Red**.
1515
- # @option params [String] :next_token
1516
- # The token for the next set of results, or **null** if there are no
1517
- # additional results.
1518
- # @option params [Integer] :max_results
1519
- # The maximum number of results to return in this operation.
1520
- # @option params [String] :attribute_name
1521
- # The attribute name used to search for things.
1522
- # @option params [String] :attribute_value
1523
- # The attribute value used to search for things.
1524
- # @option params [String] :thing_type_name
1525
- # The name of the thing type used to search for things.
1526
- # @return [Types::ListThingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1527
- #
1528
- # * {Types::ListThingsResponse#things #things} => Array&lt;Types::ThingAttribute&gt;
1529
- # * {Types::ListThingsResponse#next_token #nextToken} => String
1530
- #
1531
- # @example Request syntax with placeholder values
1532
- # resp = client.list_things({
1533
- # next_token: "NextToken",
1534
- # max_results: 1,
1535
- # attribute_name: "AttributeName",
1536
- # attribute_value: "AttributeValue",
1537
- # thing_type_name: "ThingTypeName",
1538
- # })
1539
- #
1540
- # @example Response structure
1541
- # resp.things #=> Array
1542
- # resp.things[0].thing_name #=> String
1543
- # resp.things[0].thing_type_name #=> String
1544
- # resp.things[0].attributes #=> Hash
1545
- # resp.things[0].attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1546
- # resp.things[0].version #=> Integer
1547
- # resp.next_token #=> String
1548
- # @overload list_things(params = {})
1549
- # @param [Hash] params ({})
1550
- def list_things(params = {}, options = {})
1551
- req = build_request(:list_things, params)
1552
- req.send_request(options)
1553
- end
1750
+ # Lists your things. Use the **attributeName** and **attributeValue**
1751
+ # parameters to filter your things. For example, calling `ListThings`
1752
+ # with attributeName=Color and attributeValue=Red retrieves all things
1753
+ # in the registry that contain an attribute **Color** with the value
1754
+ # **Red**.
1755
+ #
1756
+ # @option params [String] :next_token
1757
+ # The token for the next set of results, or **null** if there are no
1758
+ # additional results.
1759
+ #
1760
+ # @option params [Integer] :max_results
1761
+ # The maximum number of results to return in this operation.
1762
+ #
1763
+ # @option params [String] :attribute_name
1764
+ # The attribute name used to search for things.
1765
+ #
1766
+ # @option params [String] :attribute_value
1767
+ # The attribute value used to search for things.
1768
+ #
1769
+ # @option params [String] :thing_type_name
1770
+ # The name of the thing type used to search for things.
1771
+ #
1772
+ # @return [Types::ListThingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1773
+ #
1774
+ # * {Types::ListThingsResponse#things #things} => Array&lt;Types::ThingAttribute&gt;
1775
+ # * {Types::ListThingsResponse#next_token #next_token} => String
1776
+ #
1777
+ # @example Request syntax with placeholder values
1778
+ #
1779
+ # resp = client.list_things({
1780
+ # next_token: "NextToken",
1781
+ # max_results: 1,
1782
+ # attribute_name: "AttributeName",
1783
+ # attribute_value: "AttributeValue",
1784
+ # thing_type_name: "ThingTypeName",
1785
+ # })
1786
+ #
1787
+ # @example Response structure
1788
+ #
1789
+ # resp.things #=> Array
1790
+ # resp.things[0].thing_name #=> String
1791
+ # resp.things[0].thing_type_name #=> String
1792
+ # resp.things[0].attributes #=> Hash
1793
+ # resp.things[0].attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1794
+ # resp.things[0].version #=> Integer
1795
+ # resp.next_token #=> String
1796
+ #
1797
+ # @overload list_things(params = {})
1798
+ # @param [Hash] params ({})
1799
+ def list_things(params = {}, options = {})
1800
+ req = build_request(:list_things, params)
1801
+ req.send_request(options)
1802
+ end
1554
1803
 
1555
- # Lists the rules for the specific topic.
1556
- # @option params [String] :topic
1557
- # The topic.
1558
- # @option params [Integer] :max_results
1559
- # The maximum number of results to return.
1560
- # @option params [String] :next_token
1561
- # A token used to retrieve the next value.
1562
- # @option params [Boolean] :rule_disabled
1563
- # Specifies whether the rule is disabled.
1564
- # @return [Types::ListTopicRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1565
- #
1566
- # * {Types::ListTopicRulesResponse#rules #rules} => Array&lt;Types::TopicRuleListItem&gt;
1567
- # * {Types::ListTopicRulesResponse#next_token #nextToken} => String
1568
- #
1569
- # @example Request syntax with placeholder values
1570
- # resp = client.list_topic_rules({
1571
- # topic: "Topic",
1572
- # max_results: 1,
1573
- # next_token: "NextToken",
1574
- # rule_disabled: false,
1575
- # })
1576
- #
1577
- # @example Response structure
1578
- # resp.rules #=> Array
1579
- # resp.rules[0].rule_arn #=> String
1580
- # resp.rules[0].rule_name #=> String
1581
- # resp.rules[0].topic_pattern #=> String
1582
- # resp.rules[0].created_at #=> Time
1583
- # resp.rules[0].rule_disabled #=> Boolean
1584
- # resp.next_token #=> String
1585
- # @overload list_topic_rules(params = {})
1586
- # @param [Hash] params ({})
1587
- def list_topic_rules(params = {}, options = {})
1588
- req = build_request(:list_topic_rules, params)
1589
- req.send_request(options)
1590
- end
1804
+ # Lists the rules for the specific topic.
1805
+ #
1806
+ # @option params [String] :topic
1807
+ # The topic.
1808
+ #
1809
+ # @option params [Integer] :max_results
1810
+ # The maximum number of results to return.
1811
+ #
1812
+ # @option params [String] :next_token
1813
+ # A token used to retrieve the next value.
1814
+ #
1815
+ # @option params [Boolean] :rule_disabled
1816
+ # Specifies whether the rule is disabled.
1817
+ #
1818
+ # @return [Types::ListTopicRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1819
+ #
1820
+ # * {Types::ListTopicRulesResponse#rules #rules} => Array&lt;Types::TopicRuleListItem&gt;
1821
+ # * {Types::ListTopicRulesResponse#next_token #next_token} => String
1822
+ #
1823
+ # @example Request syntax with placeholder values
1824
+ #
1825
+ # resp = client.list_topic_rules({
1826
+ # topic: "Topic",
1827
+ # max_results: 1,
1828
+ # next_token: "NextToken",
1829
+ # rule_disabled: false,
1830
+ # })
1831
+ #
1832
+ # @example Response structure
1833
+ #
1834
+ # resp.rules #=> Array
1835
+ # resp.rules[0].rule_arn #=> String
1836
+ # resp.rules[0].rule_name #=> String
1837
+ # resp.rules[0].topic_pattern #=> String
1838
+ # resp.rules[0].created_at #=> Time
1839
+ # resp.rules[0].rule_disabled #=> Boolean
1840
+ # resp.next_token #=> String
1841
+ #
1842
+ # @overload list_topic_rules(params = {})
1843
+ # @param [Hash] params ({})
1844
+ def list_topic_rules(params = {}, options = {})
1845
+ req = build_request(:list_topic_rules, params)
1846
+ req.send_request(options)
1847
+ end
1591
1848
 
1592
- # Registers a CA certificate with AWS IoT. This CA certificate can then
1593
- # be used to sign device certificates, which can be then registered with
1594
- # AWS IoT. You can register up to 10 CA certificates per AWS account
1595
- # that have the same subject field and public key. This enables you to
1596
- # have up to 10 certificate authorities sign your device certificates.
1597
- # If you have more than one CA certificate registered, make sure you
1598
- # pass the CA certificate when you register your device certificates
1599
- # with the RegisterCertificate API.
1600
- # @option params [required, String] :ca_certificate
1601
- # The CA certificate.
1602
- # @option params [required, String] :verification_certificate
1603
- # The private key verification certificate.
1604
- # @option params [Boolean] :set_as_active
1605
- # A boolean value that specifies if the CA certificate is set to active.
1606
- # @option params [Boolean] :allow_auto_registration
1607
- # Allows this CA certificate to be used for auto registration of device
1608
- # certificates.
1609
- # @return [Types::RegisterCACertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1610
- #
1611
- # * {Types::RegisterCACertificateResponse#certificate_arn #certificateArn} => String
1612
- # * {Types::RegisterCACertificateResponse#certificate_id #certificateId} => String
1613
- #
1614
- # @example Request syntax with placeholder values
1615
- # resp = client.register_ca_certificate({
1616
- # ca_certificate: "CertificatePem", # required
1617
- # verification_certificate: "CertificatePem", # required
1618
- # set_as_active: false,
1619
- # allow_auto_registration: false,
1620
- # })
1621
- #
1622
- # @example Response structure
1623
- # resp.certificate_arn #=> String
1624
- # resp.certificate_id #=> String
1625
- # @overload register_ca_certificate(params = {})
1626
- # @param [Hash] params ({})
1627
- def register_ca_certificate(params = {}, options = {})
1628
- req = build_request(:register_ca_certificate, params)
1629
- req.send_request(options)
1630
- end
1849
+ # Registers a CA certificate with AWS IoT. This CA certificate can then
1850
+ # be used to sign device certificates, which can be then registered with
1851
+ # AWS IoT. You can register up to 10 CA certificates per AWS account
1852
+ # that have the same subject field and public key. This enables you to
1853
+ # have up to 10 certificate authorities sign your device certificates.
1854
+ # If you have more than one CA certificate registered, make sure you
1855
+ # pass the CA certificate when you register your device certificates
1856
+ # with the RegisterCertificate API.
1857
+ #
1858
+ # @option params [required, String] :ca_certificate
1859
+ # The CA certificate.
1860
+ #
1861
+ # @option params [required, String] :verification_certificate
1862
+ # The private key verification certificate.
1863
+ #
1864
+ # @option params [Boolean] :set_as_active
1865
+ # A boolean value that specifies if the CA certificate is set to active.
1866
+ #
1867
+ # @option params [Boolean] :allow_auto_registration
1868
+ # Allows this CA certificate to be used for auto registration of device
1869
+ # certificates.
1870
+ #
1871
+ # @return [Types::RegisterCACertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1872
+ #
1873
+ # * {Types::RegisterCACertificateResponse#certificate_arn #certificate_arn} => String
1874
+ # * {Types::RegisterCACertificateResponse#certificate_id #certificate_id} => String
1875
+ #
1876
+ # @example Request syntax with placeholder values
1877
+ #
1878
+ # resp = client.register_ca_certificate({
1879
+ # ca_certificate: "CertificatePem", # required
1880
+ # verification_certificate: "CertificatePem", # required
1881
+ # set_as_active: false,
1882
+ # allow_auto_registration: false,
1883
+ # })
1884
+ #
1885
+ # @example Response structure
1886
+ #
1887
+ # resp.certificate_arn #=> String
1888
+ # resp.certificate_id #=> String
1889
+ #
1890
+ # @overload register_ca_certificate(params = {})
1891
+ # @param [Hash] params ({})
1892
+ def register_ca_certificate(params = {}, options = {})
1893
+ req = build_request(:register_ca_certificate, params)
1894
+ req.send_request(options)
1895
+ end
1631
1896
 
1632
- # Registers a device certificate with AWS IoT. If you have more than one
1633
- # CA certificate that has the same subject field, you must specify the
1634
- # CA certificate that was used to sign the device certificate being
1635
- # registered.
1636
- # @option params [required, String] :certificate_pem
1637
- # The certificate data, in PEM format.
1638
- # @option params [String] :ca_certificate_pem
1639
- # The CA certificate used to sign the device certificate being
1640
- # registered.
1641
- # @option params [Boolean] :set_as_active
1642
- # A boolean value that specifies if the CA certificate is set to active.
1643
- # @option params [String] :status
1644
- # @return [Types::RegisterCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1645
- #
1646
- # * {Types::RegisterCertificateResponse#certificate_arn #certificateArn} => String
1647
- # * {Types::RegisterCertificateResponse#certificate_id #certificateId} => String
1648
- #
1649
- # @example Request syntax with placeholder values
1650
- # resp = client.register_certificate({
1651
- # certificate_pem: "CertificatePem", # required
1652
- # ca_certificate_pem: "CertificatePem",
1653
- # set_as_active: false,
1654
- # status: "ACTIVE", # accepts ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION
1655
- # })
1656
- #
1657
- # @example Response structure
1658
- # resp.certificate_arn #=> String
1659
- # resp.certificate_id #=> String
1660
- # @overload register_certificate(params = {})
1661
- # @param [Hash] params ({})
1662
- def register_certificate(params = {}, options = {})
1663
- req = build_request(:register_certificate, params)
1664
- req.send_request(options)
1665
- end
1897
+ # Registers a device certificate with AWS IoT. If you have more than one
1898
+ # CA certificate that has the same subject field, you must specify the
1899
+ # CA certificate that was used to sign the device certificate being
1900
+ # registered.
1901
+ #
1902
+ # @option params [required, String] :certificate_pem
1903
+ # The certificate data, in PEM format.
1904
+ #
1905
+ # @option params [String] :ca_certificate_pem
1906
+ # The CA certificate used to sign the device certificate being
1907
+ # registered.
1908
+ #
1909
+ # @option params [Boolean] :set_as_active
1910
+ # A boolean value that specifies if the CA certificate is set to active.
1911
+ #
1912
+ # @option params [String] :status
1913
+ #
1914
+ # @return [Types::RegisterCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1915
+ #
1916
+ # * {Types::RegisterCertificateResponse#certificate_arn #certificate_arn} => String
1917
+ # * {Types::RegisterCertificateResponse#certificate_id #certificate_id} => String
1918
+ #
1919
+ # @example Request syntax with placeholder values
1920
+ #
1921
+ # resp = client.register_certificate({
1922
+ # certificate_pem: "CertificatePem", # required
1923
+ # ca_certificate_pem: "CertificatePem",
1924
+ # set_as_active: false,
1925
+ # status: "ACTIVE", # accepts ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION
1926
+ # })
1927
+ #
1928
+ # @example Response structure
1929
+ #
1930
+ # resp.certificate_arn #=> String
1931
+ # resp.certificate_id #=> String
1932
+ #
1933
+ # @overload register_certificate(params = {})
1934
+ # @param [Hash] params ({})
1935
+ def register_certificate(params = {}, options = {})
1936
+ req = build_request(:register_certificate, params)
1937
+ req.send_request(options)
1938
+ end
1666
1939
 
1667
- # Rejects a pending certificate transfer. After AWS IoT rejects a
1668
- # certificate transfer, the certificate status changes from
1669
- # **PENDING\_TRANSFER** to **INACTIVE**.
1670
- #
1671
- # To check for pending certificate transfers, call ListCertificates to
1672
- # enumerate your certificates.
1673
- #
1674
- # This operation can only be called by the transfer destination. After
1675
- # it is called, the certificate will be returned to the source's
1676
- # account in the INACTIVE state.
1677
- # @option params [required, String] :certificate_id
1678
- # The ID of the certificate.
1679
- # @option params [String] :reject_reason
1680
- # The reason the certificate transfer was rejected.
1681
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1682
- #
1683
- # @example Request syntax with placeholder values
1684
- # resp = client.reject_certificate_transfer({
1685
- # certificate_id: "CertificateId", # required
1686
- # reject_reason: "Message",
1687
- # })
1688
- # @overload reject_certificate_transfer(params = {})
1689
- # @param [Hash] params ({})
1690
- def reject_certificate_transfer(params = {}, options = {})
1691
- req = build_request(:reject_certificate_transfer, params)
1692
- req.send_request(options)
1693
- end
1940
+ # Rejects a pending certificate transfer. After AWS IoT rejects a
1941
+ # certificate transfer, the certificate status changes from
1942
+ # **PENDING\_TRANSFER** to **INACTIVE**.
1943
+ #
1944
+ # To check for pending certificate transfers, call ListCertificates to
1945
+ # enumerate your certificates.
1946
+ #
1947
+ # This operation can only be called by the transfer destination. After
1948
+ # it is called, the certificate will be returned to the source's
1949
+ # account in the INACTIVE state.
1950
+ #
1951
+ # @option params [required, String] :certificate_id
1952
+ # The ID of the certificate.
1953
+ #
1954
+ # @option params [String] :reject_reason
1955
+ # The reason the certificate transfer was rejected.
1956
+ #
1957
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1958
+ #
1959
+ # @example Request syntax with placeholder values
1960
+ #
1961
+ # resp = client.reject_certificate_transfer({
1962
+ # certificate_id: "CertificateId", # required
1963
+ # reject_reason: "Message",
1964
+ # })
1965
+ #
1966
+ # @overload reject_certificate_transfer(params = {})
1967
+ # @param [Hash] params ({})
1968
+ def reject_certificate_transfer(params = {}, options = {})
1969
+ req = build_request(:reject_certificate_transfer, params)
1970
+ req.send_request(options)
1971
+ end
1694
1972
 
1695
- # Replaces the specified rule. You must specify all parameters for the
1696
- # new rule. Creating rules is an administrator-level action. Any user
1697
- # who has permission to create rules will be able to access data
1698
- # processed by the rule.
1699
- # @option params [required, String] :rule_name
1700
- # The name of the rule.
1701
- # @option params [required, Types::TopicRulePayload] :topic_rule_payload
1702
- # The rule payload.
1703
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1704
- #
1705
- # @example Request syntax with placeholder values
1706
- # resp = client.replace_topic_rule({
1707
- # rule_name: "RuleName", # required
1708
- # topic_rule_payload: { # required
1709
- # sql: "SQL", # required
1710
- # description: "Description",
1711
- # actions: [ # required
1712
- # {
1713
- # dynamo_db: {
1714
- # table_name: "TableName", # required
1715
- # role_arn: "AwsArn", # required
1716
- # operation: "DynamoOperation",
1717
- # hash_key_field: "HashKeyField", # required
1718
- # hash_key_value: "HashKeyValue", # required
1719
- # hash_key_type: "STRING", # accepts STRING, NUMBER
1720
- # range_key_field: "RangeKeyField",
1721
- # range_key_value: "RangeKeyValue",
1722
- # range_key_type: "STRING", # accepts STRING, NUMBER
1723
- # payload_field: "PayloadField",
1724
- # },
1725
- # dynamo_d_bv_2: {
1726
- # role_arn: "AwsArn",
1727
- # put_item: {
1728
- # table_name: "TableName", # required
1729
- # },
1730
- # },
1731
- # lambda: {
1732
- # function_arn: "FunctionArn", # required
1733
- # },
1734
- # sns: {
1735
- # target_arn: "AwsArn", # required
1736
- # role_arn: "AwsArn", # required
1737
- # message_format: "RAW", # accepts RAW, JSON
1738
- # },
1739
- # sqs: {
1740
- # role_arn: "AwsArn", # required
1741
- # queue_url: "QueueUrl", # required
1742
- # use_base_64: false,
1743
- # },
1744
- # kinesis: {
1745
- # role_arn: "AwsArn", # required
1746
- # stream_name: "StreamName", # required
1747
- # partition_key: "PartitionKey",
1748
- # },
1749
- # republish: {
1750
- # role_arn: "AwsArn", # required
1751
- # topic: "TopicPattern", # required
1752
- # },
1753
- # s3: {
1754
- # role_arn: "AwsArn", # required
1755
- # bucket_name: "BucketName", # required
1756
- # key: "Key", # required
1757
- # canned_acl: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write
1758
- # },
1759
- # firehose: {
1760
- # role_arn: "AwsArn", # required
1761
- # delivery_stream_name: "DeliveryStreamName", # required
1762
- # separator: "FirehoseSeparator",
1763
- # },
1764
- # cloudwatch_metric: {
1765
- # role_arn: "AwsArn", # required
1766
- # metric_namespace: "MetricNamespace", # required
1767
- # metric_name: "MetricName", # required
1768
- # metric_value: "MetricValue", # required
1769
- # metric_unit: "MetricUnit", # required
1770
- # metric_timestamp: "MetricTimestamp",
1771
- # },
1772
- # cloudwatch_alarm: {
1773
- # role_arn: "AwsArn", # required
1774
- # alarm_name: "AlarmName", # required
1775
- # state_reason: "StateReason", # required
1776
- # state_value: "StateValue", # required
1777
- # },
1778
- # elasticsearch: {
1779
- # role_arn: "AwsArn", # required
1780
- # endpoint: "ElasticsearchEndpoint", # required
1781
- # index: "ElasticsearchIndex", # required
1782
- # type: "ElasticsearchType", # required
1783
- # id: "ElasticsearchId", # required
1784
- # },
1785
- # },
1786
- # ],
1787
- # rule_disabled: false,
1788
- # aws_iot_sql_version: "AwsIotSqlVersion",
1789
- # },
1790
- # })
1791
- # @overload replace_topic_rule(params = {})
1792
- # @param [Hash] params ({})
1793
- def replace_topic_rule(params = {}, options = {})
1794
- req = build_request(:replace_topic_rule, params)
1795
- req.send_request(options)
1796
- end
1973
+ # Replaces the specified rule. You must specify all parameters for the
1974
+ # new rule. Creating rules is an administrator-level action. Any user
1975
+ # who has permission to create rules will be able to access data
1976
+ # processed by the rule.
1977
+ #
1978
+ # @option params [required, String] :rule_name
1979
+ # The name of the rule.
1980
+ #
1981
+ # @option params [required, Types::TopicRulePayload] :topic_rule_payload
1982
+ # The rule payload.
1983
+ #
1984
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1985
+ #
1986
+ # @example Request syntax with placeholder values
1987
+ #
1988
+ # resp = client.replace_topic_rule({
1989
+ # rule_name: "RuleName", # required
1990
+ # topic_rule_payload: { # required
1991
+ # sql: "SQL", # required
1992
+ # description: "Description",
1993
+ # actions: [ # required
1994
+ # {
1995
+ # dynamo_db: {
1996
+ # table_name: "TableName", # required
1997
+ # role_arn: "AwsArn", # required
1998
+ # operation: "DynamoOperation",
1999
+ # hash_key_field: "HashKeyField", # required
2000
+ # hash_key_value: "HashKeyValue", # required
2001
+ # hash_key_type: "STRING", # accepts STRING, NUMBER
2002
+ # range_key_field: "RangeKeyField",
2003
+ # range_key_value: "RangeKeyValue",
2004
+ # range_key_type: "STRING", # accepts STRING, NUMBER
2005
+ # payload_field: "PayloadField",
2006
+ # },
2007
+ # dynamo_d_bv_2: {
2008
+ # role_arn: "AwsArn",
2009
+ # put_item: {
2010
+ # table_name: "TableName", # required
2011
+ # },
2012
+ # },
2013
+ # lambda: {
2014
+ # function_arn: "FunctionArn", # required
2015
+ # },
2016
+ # sns: {
2017
+ # target_arn: "AwsArn", # required
2018
+ # role_arn: "AwsArn", # required
2019
+ # message_format: "RAW", # accepts RAW, JSON
2020
+ # },
2021
+ # sqs: {
2022
+ # role_arn: "AwsArn", # required
2023
+ # queue_url: "QueueUrl", # required
2024
+ # use_base_64: false,
2025
+ # },
2026
+ # kinesis: {
2027
+ # role_arn: "AwsArn", # required
2028
+ # stream_name: "StreamName", # required
2029
+ # partition_key: "PartitionKey",
2030
+ # },
2031
+ # republish: {
2032
+ # role_arn: "AwsArn", # required
2033
+ # topic: "TopicPattern", # required
2034
+ # },
2035
+ # s3: {
2036
+ # role_arn: "AwsArn", # required
2037
+ # bucket_name: "BucketName", # required
2038
+ # key: "Key", # required
2039
+ # canned_acl: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write
2040
+ # },
2041
+ # firehose: {
2042
+ # role_arn: "AwsArn", # required
2043
+ # delivery_stream_name: "DeliveryStreamName", # required
2044
+ # separator: "FirehoseSeparator",
2045
+ # },
2046
+ # cloudwatch_metric: {
2047
+ # role_arn: "AwsArn", # required
2048
+ # metric_namespace: "MetricNamespace", # required
2049
+ # metric_name: "MetricName", # required
2050
+ # metric_value: "MetricValue", # required
2051
+ # metric_unit: "MetricUnit", # required
2052
+ # metric_timestamp: "MetricTimestamp",
2053
+ # },
2054
+ # cloudwatch_alarm: {
2055
+ # role_arn: "AwsArn", # required
2056
+ # alarm_name: "AlarmName", # required
2057
+ # state_reason: "StateReason", # required
2058
+ # state_value: "StateValue", # required
2059
+ # },
2060
+ # elasticsearch: {
2061
+ # role_arn: "AwsArn", # required
2062
+ # endpoint: "ElasticsearchEndpoint", # required
2063
+ # index: "ElasticsearchIndex", # required
2064
+ # type: "ElasticsearchType", # required
2065
+ # id: "ElasticsearchId", # required
2066
+ # },
2067
+ # },
2068
+ # ],
2069
+ # rule_disabled: false,
2070
+ # aws_iot_sql_version: "AwsIotSqlVersion",
2071
+ # },
2072
+ # })
2073
+ #
2074
+ # @overload replace_topic_rule(params = {})
2075
+ # @param [Hash] params ({})
2076
+ def replace_topic_rule(params = {}, options = {})
2077
+ req = build_request(:replace_topic_rule, params)
2078
+ req.send_request(options)
2079
+ end
1797
2080
 
1798
- # Sets the specified version of the specified policy as the policy's
1799
- # default (operative) version. This action affects all certificates to
1800
- # which the policy is attached. To list the principals the policy is
1801
- # attached to, use the ListPrincipalPolicy API.
1802
- # @option params [required, String] :policy_name
1803
- # The policy name.
1804
- # @option params [required, String] :policy_version_id
1805
- # The policy version ID.
1806
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1807
- #
1808
- # @example Request syntax with placeholder values
1809
- # resp = client.set_default_policy_version({
1810
- # policy_name: "PolicyName", # required
1811
- # policy_version_id: "PolicyVersionId", # required
1812
- # })
1813
- # @overload set_default_policy_version(params = {})
1814
- # @param [Hash] params ({})
1815
- def set_default_policy_version(params = {}, options = {})
1816
- req = build_request(:set_default_policy_version, params)
1817
- req.send_request(options)
1818
- end
2081
+ # Sets the specified version of the specified policy as the policy's
2082
+ # default (operative) version. This action affects all certificates to
2083
+ # which the policy is attached. To list the principals the policy is
2084
+ # attached to, use the ListPrincipalPolicy API.
2085
+ #
2086
+ # @option params [required, String] :policy_name
2087
+ # The policy name.
2088
+ #
2089
+ # @option params [required, String] :policy_version_id
2090
+ # The policy version ID.
2091
+ #
2092
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2093
+ #
2094
+ # @example Request syntax with placeholder values
2095
+ #
2096
+ # resp = client.set_default_policy_version({
2097
+ # policy_name: "PolicyName", # required
2098
+ # policy_version_id: "PolicyVersionId", # required
2099
+ # })
2100
+ #
2101
+ # @overload set_default_policy_version(params = {})
2102
+ # @param [Hash] params ({})
2103
+ def set_default_policy_version(params = {}, options = {})
2104
+ req = build_request(:set_default_policy_version, params)
2105
+ req.send_request(options)
2106
+ end
1819
2107
 
1820
- # Sets the logging options.
1821
- # @option params [required, Types::LoggingOptionsPayload] :logging_options_payload
1822
- # The logging options payload.
1823
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1824
- #
1825
- # @example Request syntax with placeholder values
1826
- # resp = client.set_logging_options({
1827
- # logging_options_payload: { # required
1828
- # role_arn: "AwsArn", # required
1829
- # log_level: "DEBUG", # accepts DEBUG, INFO, ERROR, WARN, DISABLED
1830
- # },
1831
- # })
1832
- # @overload set_logging_options(params = {})
1833
- # @param [Hash] params ({})
1834
- def set_logging_options(params = {}, options = {})
1835
- req = build_request(:set_logging_options, params)
1836
- req.send_request(options)
1837
- end
2108
+ # Sets the logging options.
2109
+ #
2110
+ # @option params [required, Types::LoggingOptionsPayload] :logging_options_payload
2111
+ # The logging options payload.
2112
+ #
2113
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2114
+ #
2115
+ # @example Request syntax with placeholder values
2116
+ #
2117
+ # resp = client.set_logging_options({
2118
+ # logging_options_payload: { # required
2119
+ # role_arn: "AwsArn", # required
2120
+ # log_level: "DEBUG", # accepts DEBUG, INFO, ERROR, WARN, DISABLED
2121
+ # },
2122
+ # })
2123
+ #
2124
+ # @overload set_logging_options(params = {})
2125
+ # @param [Hash] params ({})
2126
+ def set_logging_options(params = {}, options = {})
2127
+ req = build_request(:set_logging_options, params)
2128
+ req.send_request(options)
2129
+ end
1838
2130
 
1839
- # Transfers the specified certificate to the specified AWS account.
1840
- #
1841
- # You can cancel the transfer until it is acknowledged by the recipient.
1842
- #
1843
- # No notification is sent to the transfer destination's account. It is
1844
- # up to the caller to notify the transfer target.
1845
- #
1846
- # The certificate being transferred must not be in the ACTIVE state. You
1847
- # can use the UpdateCertificate API to deactivate it.
1848
- #
1849
- # The certificate must not have any policies attached to it. You can use
1850
- # the DetachPrincipalPolicy API to detach them.
1851
- # @option params [required, String] :certificate_id
1852
- # The ID of the certificate.
1853
- # @option params [required, String] :target_aws_account
1854
- # The AWS account.
1855
- # @option params [String] :transfer_message
1856
- # The transfer message.
1857
- # @return [Types::TransferCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1858
- #
1859
- # * {Types::TransferCertificateResponse#transferred_certificate_arn #transferredCertificateArn} => String
1860
- #
1861
- # @example Request syntax with placeholder values
1862
- # resp = client.transfer_certificate({
1863
- # certificate_id: "CertificateId", # required
1864
- # target_aws_account: "AwsAccountId", # required
1865
- # transfer_message: "Message",
1866
- # })
1867
- #
1868
- # @example Response structure
1869
- # resp.transferred_certificate_arn #=> String
1870
- # @overload transfer_certificate(params = {})
1871
- # @param [Hash] params ({})
1872
- def transfer_certificate(params = {}, options = {})
1873
- req = build_request(:transfer_certificate, params)
1874
- req.send_request(options)
1875
- end
2131
+ # Transfers the specified certificate to the specified AWS account.
2132
+ #
2133
+ # You can cancel the transfer until it is acknowledged by the recipient.
2134
+ #
2135
+ # No notification is sent to the transfer destination's account. It is
2136
+ # up to the caller to notify the transfer target.
2137
+ #
2138
+ # The certificate being transferred must not be in the ACTIVE state. You
2139
+ # can use the UpdateCertificate API to deactivate it.
2140
+ #
2141
+ # The certificate must not have any policies attached to it. You can use
2142
+ # the DetachPrincipalPolicy API to detach them.
2143
+ #
2144
+ # @option params [required, String] :certificate_id
2145
+ # The ID of the certificate.
2146
+ #
2147
+ # @option params [required, String] :target_aws_account
2148
+ # The AWS account.
2149
+ #
2150
+ # @option params [String] :transfer_message
2151
+ # The transfer message.
2152
+ #
2153
+ # @return [Types::TransferCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2154
+ #
2155
+ # * {Types::TransferCertificateResponse#transferred_certificate_arn #transferred_certificate_arn} => String
2156
+ #
2157
+ # @example Request syntax with placeholder values
2158
+ #
2159
+ # resp = client.transfer_certificate({
2160
+ # certificate_id: "CertificateId", # required
2161
+ # target_aws_account: "AwsAccountId", # required
2162
+ # transfer_message: "Message",
2163
+ # })
2164
+ #
2165
+ # @example Response structure
2166
+ #
2167
+ # resp.transferred_certificate_arn #=> String
2168
+ #
2169
+ # @overload transfer_certificate(params = {})
2170
+ # @param [Hash] params ({})
2171
+ def transfer_certificate(params = {}, options = {})
2172
+ req = build_request(:transfer_certificate, params)
2173
+ req.send_request(options)
2174
+ end
1876
2175
 
1877
- # Updates a registered CA certificate.
1878
- # @option params [required, String] :certificate_id
1879
- # The CA certificate identifier.
1880
- # @option params [String] :new_status
1881
- # The updated status of the CA certificate.
1882
- #
1883
- # **Note:** The status value REGISTER\_INACTIVE is deprecated and should
1884
- # not be used.
1885
- # @option params [String] :new_auto_registration_status
1886
- # The new value for the auto registration status. Valid values are:
1887
- # "ENABLE" or "DISABLE".
1888
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1889
- #
1890
- # @example Request syntax with placeholder values
1891
- # resp = client.update_ca_certificate({
1892
- # certificate_id: "CertificateId", # required
1893
- # new_status: "ACTIVE", # accepts ACTIVE, INACTIVE
1894
- # new_auto_registration_status: "ENABLE", # accepts ENABLE, DISABLE
1895
- # })
1896
- # @overload update_ca_certificate(params = {})
1897
- # @param [Hash] params ({})
1898
- def update_ca_certificate(params = {}, options = {})
1899
- req = build_request(:update_ca_certificate, params)
1900
- req.send_request(options)
1901
- end
2176
+ # Updates a registered CA certificate.
2177
+ #
2178
+ # @option params [required, String] :certificate_id
2179
+ # The CA certificate identifier.
2180
+ #
2181
+ # @option params [String] :new_status
2182
+ # The updated status of the CA certificate.
2183
+ #
2184
+ # **Note:** The status value REGISTER\_INACTIVE is deprecated and should
2185
+ # not be used.
2186
+ #
2187
+ # @option params [String] :new_auto_registration_status
2188
+ # The new value for the auto registration status. Valid values are:
2189
+ # "ENABLE" or "DISABLE".
2190
+ #
2191
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2192
+ #
2193
+ # @example Request syntax with placeholder values
2194
+ #
2195
+ # resp = client.update_ca_certificate({
2196
+ # certificate_id: "CertificateId", # required
2197
+ # new_status: "ACTIVE", # accepts ACTIVE, INACTIVE
2198
+ # new_auto_registration_status: "ENABLE", # accepts ENABLE, DISABLE
2199
+ # })
2200
+ #
2201
+ # @overload update_ca_certificate(params = {})
2202
+ # @param [Hash] params ({})
2203
+ def update_ca_certificate(params = {}, options = {})
2204
+ req = build_request(:update_ca_certificate, params)
2205
+ req.send_request(options)
2206
+ end
1902
2207
 
1903
- # Updates the status of the specified certificate. This operation is
1904
- # idempotent.
1905
- #
1906
- # Moving a certificate from the ACTIVE state (including REVOKED) will
1907
- # not disconnect currently connected devices, but these devices will be
1908
- # unable to reconnect.
1909
- #
1910
- # The ACTIVE state is required to authenticate devices connecting to AWS
1911
- # IoT using a certificate.
1912
- # @option params [required, String] :certificate_id
1913
- # The ID of the certificate.
1914
- # @option params [required, String] :new_status
1915
- # The new status.
1916
- #
1917
- # **Note:** Setting the status to PENDING\_TRANSFER will result in an
1918
- # exception being thrown. PENDING\_TRANSFER is a status used internally
1919
- # by AWS IoT. It is not intended for developer use.
1920
- #
1921
- # **Note:** The status value REGISTER\_INACTIVE is deprecated and should
1922
- # not be used.
1923
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1924
- #
1925
- # @example Request syntax with placeholder values
1926
- # resp = client.update_certificate({
1927
- # certificate_id: "CertificateId", # required
1928
- # new_status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION
1929
- # })
1930
- # @overload update_certificate(params = {})
1931
- # @param [Hash] params ({})
1932
- def update_certificate(params = {}, options = {})
1933
- req = build_request(:update_certificate, params)
1934
- req.send_request(options)
1935
- end
2208
+ # Updates the status of the specified certificate. This operation is
2209
+ # idempotent.
2210
+ #
2211
+ # Moving a certificate from the ACTIVE state (including REVOKED) will
2212
+ # not disconnect currently connected devices, but these devices will be
2213
+ # unable to reconnect.
2214
+ #
2215
+ # The ACTIVE state is required to authenticate devices connecting to AWS
2216
+ # IoT using a certificate.
2217
+ #
2218
+ # @option params [required, String] :certificate_id
2219
+ # The ID of the certificate.
2220
+ #
2221
+ # @option params [required, String] :new_status
2222
+ # The new status.
2223
+ #
2224
+ # **Note:** Setting the status to PENDING\_TRANSFER will result in an
2225
+ # exception being thrown. PENDING\_TRANSFER is a status used internally
2226
+ # by AWS IoT. It is not intended for developer use.
2227
+ #
2228
+ # **Note:** The status value REGISTER\_INACTIVE is deprecated and should
2229
+ # not be used.
2230
+ #
2231
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2232
+ #
2233
+ # @example Request syntax with placeholder values
2234
+ #
2235
+ # resp = client.update_certificate({
2236
+ # certificate_id: "CertificateId", # required
2237
+ # new_status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION
2238
+ # })
2239
+ #
2240
+ # @overload update_certificate(params = {})
2241
+ # @param [Hash] params ({})
2242
+ def update_certificate(params = {}, options = {})
2243
+ req = build_request(:update_certificate, params)
2244
+ req.send_request(options)
2245
+ end
1936
2246
 
1937
- # Updates the data for a thing.
1938
- # @option params [required, String] :thing_name
1939
- # The name of the thing to update.
1940
- # @option params [String] :thing_type_name
1941
- # The name of the thing type.
1942
- # @option params [Types::AttributePayload] :attribute_payload
1943
- # A list of thing attributes, a JSON string containing name-value pairs.
1944
- # For example:
1945
- #
1946
- # `\{"attributes":\{"name1":"value2"\}\})`
1947
- #
1948
- # This data is used to add new attributes or update existing attributes.
1949
- # @option params [Integer] :expected_version
1950
- # The expected version of the thing record in the registry. If the
1951
- # version of the record in the registry does not match the expected
1952
- # version specified in the request, the `UpdateThing` request is
1953
- # rejected with a `VersionConflictException`.
1954
- # @option params [Boolean] :remove_thing_type
1955
- # Remove a thing type association. If **true**, the assocation is
1956
- # removed.
1957
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1958
- #
1959
- # @example Request syntax with placeholder values
1960
- # resp = client.update_thing({
1961
- # thing_name: "ThingName", # required
1962
- # thing_type_name: "ThingTypeName",
1963
- # attribute_payload: {
1964
- # attributes: {
1965
- # "AttributeName" => "AttributeValue",
1966
- # },
1967
- # merge: false,
1968
- # },
1969
- # expected_version: 1,
1970
- # remove_thing_type: false,
1971
- # })
1972
- # @overload update_thing(params = {})
1973
- # @param [Hash] params ({})
1974
- def update_thing(params = {}, options = {})
1975
- req = build_request(:update_thing, params)
1976
- req.send_request(options)
1977
- end
2247
+ # Updates the data for a thing.
2248
+ #
2249
+ # @option params [required, String] :thing_name
2250
+ # The name of the thing to update.
2251
+ #
2252
+ # @option params [String] :thing_type_name
2253
+ # The name of the thing type.
2254
+ #
2255
+ # @option params [Types::AttributePayload] :attribute_payload
2256
+ # A list of thing attributes, a JSON string containing name-value pairs.
2257
+ # For example:
2258
+ #
2259
+ # `\{"attributes":\{"name1":"value2"\}\})`
2260
+ #
2261
+ # This data is used to add new attributes or update existing attributes.
2262
+ #
2263
+ # @option params [Integer] :expected_version
2264
+ # The expected version of the thing record in the registry. If the
2265
+ # version of the record in the registry does not match the expected
2266
+ # version specified in the request, the `UpdateThing` request is
2267
+ # rejected with a `VersionConflictException`.
2268
+ #
2269
+ # @option params [Boolean] :remove_thing_type
2270
+ # Remove a thing type association. If **true**, the assocation is
2271
+ # removed.
2272
+ #
2273
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2274
+ #
2275
+ # @example Request syntax with placeholder values
2276
+ #
2277
+ # resp = client.update_thing({
2278
+ # thing_name: "ThingName", # required
2279
+ # thing_type_name: "ThingTypeName",
2280
+ # attribute_payload: {
2281
+ # attributes: {
2282
+ # "AttributeName" => "AttributeValue",
2283
+ # },
2284
+ # merge: false,
2285
+ # },
2286
+ # expected_version: 1,
2287
+ # remove_thing_type: false,
2288
+ # })
2289
+ #
2290
+ # @overload update_thing(params = {})
2291
+ # @param [Hash] params ({})
2292
+ def update_thing(params = {}, options = {})
2293
+ req = build_request(:update_thing, params)
2294
+ req.send_request(options)
2295
+ end
1978
2296
 
1979
- # @!endgroup
2297
+ # @!endgroup
2298
+
2299
+ # @param params ({})
2300
+ # @api private
2301
+ def build_request(operation_name, params = {})
2302
+ handlers = @handlers.for(operation_name)
2303
+ context = Seahorse::Client::RequestContext.new(
2304
+ operation_name: operation_name,
2305
+ operation: config.api.operation(operation_name),
2306
+ client: self,
2307
+ params: params,
2308
+ config: config)
2309
+ context[:gem_name] = 'aws-sdk-iot'
2310
+ context[:gem_version] = '1.0.0.rc2'
2311
+ Seahorse::Client::Request.new(handlers, context)
2312
+ end
2313
+
2314
+ # @api private
2315
+ # @deprecated
2316
+ def waiter_names
2317
+ []
2318
+ end
2319
+
2320
+ class << self
1980
2321
 
1981
- # @param params ({})
1982
2322
  # @api private
1983
- def build_request(operation_name, params = {})
1984
- handlers = @handlers.for(operation_name)
1985
- context = Seahorse::Client::RequestContext.new(
1986
- operation_name: operation_name,
1987
- operation: config.api.operation(operation_name),
1988
- client: self,
1989
- params: params,
1990
- config: config)
1991
- context[:gem_name] = 'aws-sdk-iot'
1992
- context[:gem_version] = '1.0.0.rc1'
1993
- Seahorse::Client::Request.new(handlers, context)
1994
- end
2323
+ attr_reader :identifier
1995
2324
 
1996
2325
  # @api private
1997
- # @deprecated
1998
- def waiter_names
1999
- []
2326
+ def errors_module
2327
+ Errors
2000
2328
  end
2001
2329
 
2002
- class << self
2003
-
2004
- # @api private
2005
- attr_reader :identifier
2006
-
2007
- # @api private
2008
- def errors_module
2009
- Errors
2010
- end
2011
-
2012
- end
2013
2330
  end
2014
2331
  end
2015
2332
  end