:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- Aws::Credentials - Used for configuring static, non-refreshing credentials.
- Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.
- Aws::AssumeRoleCredentials - Used when you need to assume a role.
When :credentials are not configured directly, the following locations will be searched for credentials:
- Aws.config[:credentials]
- The :access_key_id, :secret_access_key, and :session_token options.
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- ~/.aws/credentials
- ~/.aws/config
- EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
:region (required, String) —
The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:
- Aws.config[:region]
- ENV['AWS_REGION']
- ENV['AMAZON_REGION']
- ENV['AWS_DEFAULT_REGION']
- ~/.aws/credentials
- ~/.aws/config
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.
:client_side_monitoring (Boolean) — default: false —
When true, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_port (Integer) — default: 31000 —
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types.
:disable_host_prefix_injection (Boolean) — default: false —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:endpoint (String) —
The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.
:endpoint_cache_max_entries (Integer) — default: 1000 —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —
The log formatter.
:log_level (Symbol) — default: :info —
The log level to send messages to the :logger at.
:logger (Logger) —
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:profile (String) — default: "default" —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
:retry_base_delay (Float) — default: 0.3 —
The base delay in seconds used by the default backoff function.
:retry_jitter (Symbol) — default: :none —
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

@see https://www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.
:retry_max_delay (Integer) — default: 0 —
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
:secret_access_key (String)
:session_token (String)
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

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



202
203
204

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 202

def initialize(*args)
  super
end

Instance Method Details

#accept_certificate_transfer(params = {}) ⇒ `Struct`

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

Examples:

Request syntax with placeholder values


resp = client.accept_certificate_transfer({
  certificate_id: "CertificateId", # required
  set_as_active: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:certificate_id (required, String) —
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
:set_as_active (Boolean) —
Specifies whether the certificate is active.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 232

def accept_certificate_transfer(params = {}, options = {})
  req = build_request(:accept_certificate_transfer, params)
  req.send_request(options)
end

#add_thing_to_billing_group(params = {}) ⇒ `Struct`

Adds a thing to a billing group.

Examples:

Request syntax with placeholder values


resp = client.add_thing_to_billing_group({
  billing_group_name: "BillingGroupName",
  billing_group_arn: "BillingGroupArn",
  thing_name: "ThingName",
  thing_arn: "ThingArn",
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:billing_group_name (String) —
The name of the billing group.
:billing_group_arn (String) —
The ARN of the billing group.
:thing_name (String) —
The name of the thing to be added to the billing group.
:thing_arn (String) —
The ARN of the thing to be added to the billing group.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 264

def add_thing_to_billing_group(params = {}, options = {})
  req = build_request(:add_thing_to_billing_group, params)
  req.send_request(options)
end

#add_thing_to_thing_group(params = {}) ⇒ `Struct`

Adds a thing to a thing group.

Examples:

Request syntax with placeholder values


resp = client.add_thing_to_thing_group({
  thing_group_name: "ThingGroupName",
  thing_group_arn: "ThingGroupArn",
  thing_name: "ThingName",
  thing_arn: "ThingArn",
  override_dynamic_groups: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_group_name (String) —
The name of the group to which you are adding a thing.
:thing_group_arn (String) —
The ARN of the group to which you are adding a thing.
:thing_name (String) —
The name of the thing to add to a group.
:thing_arn (String) —
The ARN of the thing to add to a group.
:override_dynamic_groups (Boolean) —
Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 303

def add_thing_to_thing_group(params = {}, options = {})
  req = build_request(:add_thing_to_thing_group, params)
  req.send_request(options)
end

#associate_targets_with_job(params = {}) ⇒ `Types::AssociateTargetsWithJobResponse`

Associates a group with a continuous job. The following criteria must be met:

The job must have been created with the targetSelection field set to "CONTINUOUS".
The job status must currently be "IN_PROGRESS".
The total number of targets associated with a job must not exceed

Examples:

Request syntax with placeholder values


resp = client.associate_targets_with_job({
  targets: ["TargetArn"], # required
  job_id: "JobId", # required
  comment: "Comment",
})

Response structure


resp.job_arn #=> String
resp.job_id #=> String
resp.description #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:targets (required, Array<String>) —
A list of thing group ARNs that define the targets of the job.
:job_id (required, String) —
The unique identifier you assigned to this job when it was created.
:comment (String) —
An optional comment string describing why the job was associated with the targets.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 351

def associate_targets_with_job(params = {}, options = {})
  req = build_request(:associate_targets_with_job, params)
  req.send_request(options)
end

#attach_policy(params = {}) ⇒ `Struct`

Attaches a policy to the specified target.

Examples:

Request syntax with placeholder values


resp = client.attach_policy({
  policy_name: "PolicyName", # required
  target: "PolicyTarget", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The name of the policy to attach.
:target (required, String) —
The identity to which the policy is attached.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 379

def attach_policy(params = {}, options = {})
  req = build_request(:attach_policy, params)
  req.send_request(options)
end

#attach_principal_policy(params = {}) ⇒ `Struct`

Attaches the specified policy to the specified principal (certificate or other credential).

Note: This API is deprecated. Please use AttachPolicy instead.

Examples:

Request syntax with placeholder values


resp = client.attach_principal_policy({
  policy_name: "PolicyName", # required
  principal: "Principal", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The policy name.
:principal (required, String) —
The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 407

def attach_principal_policy(params = {}, options = {})
  req = build_request(:attach_principal_policy, params)
  req.send_request(options)
end

#attach_security_profile(params = {}) ⇒ `Struct`

Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.

Examples:

Request syntax with placeholder values


resp = client.attach_security_profile({
  security_profile_name: "SecurityProfileName", # required
  security_profile_target_arn: "SecurityProfileTargetArn", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:security_profile_name (required, String) —
The security profile that is attached.
:security_profile_target_arn (required, String) —
The ARN of the target (thing group) to which the security profile is attached.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 434

def attach_security_profile(params = {}, options = {})
  req = build_request(:attach_security_profile, params)
  req.send_request(options)
end

#attach_thing_principal(params = {}) ⇒ `Struct`

Attaches the specified principal to the specified thing.

Examples:

Request syntax with placeholder values


resp = client.attach_thing_principal({
  thing_name: "ThingName", # required
  principal: "Principal", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_name (required, String) —
The name of the thing.
:principal (required, String) —
The principal, such as a certificate or other credential.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 458

def attach_thing_principal(params = {}, options = {})
  req = build_request(:attach_thing_principal, params)
  req.send_request(options)
end

#cancel_audit_task(params = {}) ⇒ `Struct`

Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.

Examples:

Request syntax with placeholder values


resp = client.cancel_audit_task({
  task_id: "AuditTaskId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:task_id (required, String) —
The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 481

def cancel_audit_task(params = {}, options = {})
  req = build_request(:cancel_audit_task, params)
  req.send_request(options)
end

#cancel_certificate_transfer(params = {}) ⇒ `Struct`

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

Examples:

Request syntax with placeholder values


resp = client.cancel_certificate_transfer({
  certificate_id: "CertificateId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:certificate_id (required, String) —
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 512

def cancel_certificate_transfer(params = {}, options = {})
  req = build_request(:cancel_certificate_transfer, params)
  req.send_request(options)
end

#cancel_job(params = {}) ⇒ `Types::CancelJobResponse`

Cancels a job.

Examples:

Request syntax with placeholder values


resp = client.cancel_job({
  job_id: "JobId", # required
  reason_code: "ReasonCode",
  comment: "Comment",
  force: false,
})

Response structure


resp.job_arn #=> String
resp.job_id #=> String
resp.description #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
The unique identifier you assigned to this job when it was created.
:reason_code (String) — default: Optional —
A reason code string that explains why the job was canceled.
:comment (String) —
An optional comment string describing why the job was canceled.
:force (Boolean) — default: Optional —
If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 561

def cancel_job(params = {}, options = {})
  req = build_request(:cancel_job, params)
  req.send_request(options)
end

#cancel_job_execution(params = {}) ⇒ `Struct`

Cancels the execution of a job for a given thing.

Examples:

Request syntax with placeholder values


resp = client.cancel_job_execution({
  job_id: "JobId", # required
  thing_name: "ThingName", # required
  force: false,
  expected_version: 1,
  status_details: {
    "DetailsKey" => "DetailsValue",
  },
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
The ID of the job to be canceled.
:thing_name (required, String) —
The name of the thing whose execution of the job will be canceled.
:force (Boolean) — default: Optional —
If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
:expected_version (Integer) — default: Optional —
The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
:status_details (Hash<String,String>) —
A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 616

def cancel_job_execution(params = {}, options = {})
  req = build_request(:cancel_job_execution, params)
  req.send_request(options)
end

#clear_default_authorizer(params = {}) ⇒ `Struct`

Clears the default authorizer.

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 627

def clear_default_authorizer(params = {}, options = {})
  req = build_request(:clear_default_authorizer, params)
  req.send_request(options)
end

#create_authorizer(params = {}) ⇒ `Types::CreateAuthorizerResponse`

Creates an authorizer.

Examples:

Request syntax with placeholder values


resp = client.create_authorizer({
  authorizer_name: "AuthorizerName", # required
  authorizer_function_arn: "AuthorizerFunctionArn", # required
  token_key_name: "TokenKeyName", # required
  token_signing_public_keys: { # required
    "KeyName" => "KeyValue",
  },
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
})

Response structure


resp.authorizer_name #=> String
resp.authorizer_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:authorizer_name (required, String) —
The authorizer name.
:authorizer_function_arn (required, String) —
The ARN of the authorizer's Lambda function.
:token_key_name (required, String) —
The name of the token key used to extract the token from the HTTP headers.
:token_signing_public_keys (required, Hash<String,String>) —
The public keys used to verify the digital signature returned by your custom authentication service.
:status (String) —
The status of the create authorizer request.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 675

def create_authorizer(params = {}, options = {})
  req = build_request(:create_authorizer, params)
  req.send_request(options)
end

#create_billing_group(params = {}) ⇒ `Types::CreateBillingGroupResponse`

Creates a billing group.

Examples:

Request syntax with placeholder values


resp = client.create_billing_group({
  billing_group_name: "BillingGroupName", # required
  billing_group_properties: {
    billing_group_description: "BillingGroupDescription",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.billing_group_name #=> String
resp.billing_group_arn #=> String
resp.billing_group_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:billing_group_name (required, String) —
The name you wish to give to the billing group.
:billing_group_properties (Types::BillingGroupProperties) —
The properties of the billing group.
:tags (Array<Types::Tag>) —
Metadata which can be used to manage the billing group.

Returns:

(Types::CreateBillingGroupResponse) —
Returns a response object which responds to the following methods:
- #billing_group_name => String
- #billing_group_arn => String
- #billing_group_id => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 720

def create_billing_group(params = {}, options = {})
  req = build_request(:create_billing_group, params)
  req.send_request(options)
end

#create_certificate_from_csr(params = {}) ⇒ `Types::CreateCertificateFromCsrResponse`

Creates an X.509 certificate using the specified certificate signing request.

Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {\} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{\}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.

The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {\} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{\}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_\}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"

Examples:

Request syntax with placeholder values


resp = client.create_certificate_from_csr({
  certificate_signing_request: "CertificateSigningRequest", # required
  set_as_active: false,
})

Response structure


resp.certificate_arn #=> String
resp.certificate_id #=> String
resp.certificate_pem #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:certificate_signing_request (required, String) —
The certificate signing request (CSR).
:set_as_active (Boolean) —
Specifies whether the certificate is active.

Returns:

(Types::CreateCertificateFromCsrResponse) —
Returns a response object which responds to the following methods:
- #certificate_arn => String
- #certificate_id => String
- #certificate_pem => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 801

def create_certificate_from_csr(params = {}, options = {})
  req = build_request(:create_certificate_from_csr, params)
  req.send_request(options)
end

#create_dynamic_thing_group(params = {}) ⇒ `Types::CreateDynamicThingGroupResponse`

Creates a dynamic thing group.

Examples:

Request syntax with placeholder values


resp = client.create_dynamic_thing_group({
  thing_group_name: "ThingGroupName", # required
  thing_group_properties: {
    thing_group_description: "ThingGroupDescription",
    attribute_payload: {
      attributes: {
        "AttributeName" => "AttributeValue",
      },
      merge: false,
    },
  },
  index_name: "IndexName",
  query_string: "QueryString", # required
  query_version: "QueryVersion",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.thing_group_name #=> String
resp.thing_group_arn #=> String
resp.thing_group_id #=> String
resp.index_name #=> String
resp.query_string #=> String
resp.query_version #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_group_name (required, String) —
The dynamic thing group name to create.
:thing_group_properties (Types::ThingGroupProperties) —
The dynamic thing group properties.
:index_name (String) —
The dynamic thing group index name.

Currently one index is supported: "AWS_Things".
:query_string (required, String) —
The dynamic thing group search query string.

See Query Syntax for information about query string syntax.
:query_version (String) —
The dynamic thing group query version.

Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
:tags (Array<Types::Tag>) —
Metadata which can be used to manage the dynamic thing group.

Returns:

(Types::CreateDynamicThingGroupResponse) —
Returns a response object which responds to the following methods:
- #thing_group_name => String
- #thing_group_arn => String
- #thing_group_id => String
- #index_name => String
- #query_string => String
- #query_version => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 885

def create_dynamic_thing_group(params = {}, options = {})
  req = build_request(:create_dynamic_thing_group, params)
  req.send_request(options)
end

#create_job(params = {}) ⇒ `Types::CreateJobResponse`

Creates a job.

Examples:

Request syntax with placeholder values


resp = client.create_job({
  job_id: "JobId", # required
  targets: ["TargetArn"], # required
  document_source: "JobDocumentSource",
  document: "JobDocument",
  description: "JobDescription",
  presigned_url_config: {
    role_arn: "RoleArn",
    expires_in_sec: 1,
  },
  target_selection: "CONTINUOUS", # accepts CONTINUOUS, SNAPSHOT
  job_executions_rollout_config: {
    maximum_per_minute: 1,
    exponential_rate: {
      base_rate_per_minute: 1, # required
      increment_factor: 1.0, # required
      rate_increase_criteria: { # required
        number_of_notified_things: 1,
        number_of_succeeded_things: 1,
      },
    },
  },
  abort_config: {
    criteria_list: [ # required
      {
        failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
        action: "CANCEL", # required, accepts CANCEL
        threshold_percentage: 1.0, # required
        min_number_of_executed_things: 1, # required
      },
    ],
  },
  timeout_config: {
    in_progress_timeout_in_minutes: 1,
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_arn #=> String
resp.job_id #=> String
resp.description #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
:targets (required, Array<String>) —
A list of things and thing groups to which the job should be sent.
:document_source (String) —
An S3 link to the job document.
:document (String) —
The job document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

$\{aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key\}

where bucket is your bucket name and key is the object in the bucket to which you are linking.
:description (String) —
A short text description of the job.
:presigned_url_config (Types::PresignedUrlConfig) —
Configuration information for pre-signed S3 URLs.
:target_selection (String) —
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
:job_executions_rollout_config (Types::JobExecutionsRolloutConfig) —
Allows you to create a staged rollout of the job.
:abort_config (Types::AbortConfig) —
Allows you to create criteria to abort a job.
:timeout_config (Types::TimeoutConfig) —
Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.
:tags (Array<Types::Tag>) —
Metadata which can be used to manage the job.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1007

def create_job(params = {}, options = {})
  req = build_request(:create_job, params)
  req.send_request(options)
end

#create_keys_and_certificate(params = {}) ⇒ `Types::CreateKeysAndCertificateResponse`

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.

Examples:

Request syntax with placeholder values


resp = client.create_keys_and_certificate({
  set_as_active: false,
})

Response structure


resp.certificate_arn #=> String
resp.certificate_id #=> String
resp.certificate_pem #=> String
resp.key_pair.public_key #=> String
resp.key_pair.private_key #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:set_as_active (Boolean) —
Specifies whether the certificate is active.

Returns:

(Types::CreateKeysAndCertificateResponse) —
Returns a response object which responds to the following methods:
- #certificate_arn => String
- #certificate_id => String
- #certificate_pem => String
- #key_pair => Types::KeyPair

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1044

def create_keys_and_certificate(params = {}, options = {})
  req = build_request(:create_keys_and_certificate, params)
  req.send_request(options)
end

#create_ota_update(params = {}) ⇒ `Types::CreateOTAUpdateResponse`

Creates an AWS IoT OTAUpdate on a target group of things or groups.

Examples:

Request syntax with placeholder values


resp = client.create_ota_update({
  ota_update_id: "OTAUpdateId", # required
  description: "OTAUpdateDescription",
  targets: ["Target"], # required
  target_selection: "CONTINUOUS", # accepts CONTINUOUS, SNAPSHOT
  aws_job_executions_rollout_config: {
    maximum_per_minute: 1,
  },
  files: [ # required
    {
      file_name: "FileName",
      file_version: "OTAUpdateFileVersion",
      file_location: {
        stream: {
          stream_id: "StreamId",
          file_id: 1,
        },
        s3_location: {
          bucket: "S3Bucket",
          key: "S3Key",
          version: "S3Version",
        },
      },
      code_signing: {
        aws_signer_job_id: "SigningJobId",
        start_signing_job_parameter: {
          signing_profile_parameter: {
            certificate_arn: "CertificateArn",
            platform: "Platform",
            certificate_path_on_device: "CertificatePathOnDevice",
          },
          signing_profile_name: "SigningProfileName",
          destination: {
            s3_destination: {
              bucket: "S3Bucket",
              prefix: "Prefix",
            },
          },
        },
        custom_code_signing: {
          signature: {
            inline_document: "data",
          },
          certificate_chain: {
            certificate_name: "CertificateName",
            inline_document: "InlineDocument",
          },
          hash_algorithm: "HashAlgorithm",
          signature_algorithm: "SignatureAlgorithm",
        },
      },
      attributes: {
        "AttributeKey" => "Value",
      },
    },
  ],
  role_arn: "RoleArn", # required
  additional_parameters: {
    "AttributeKey" => "Value",
  },
})

Response structure


resp.ota_update_id #=> String
resp.aws_iot_job_id #=> String
resp.ota_update_arn #=> String
resp.aws_iot_job_arn #=> String
resp.ota_update_status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ota_update_id (required, String) —
The ID of the OTA update to be created.
:description (String) —
The description of the OTA update.
:targets (required, Array<String>) —
The targeted devices to receive OTA updates.
:target_selection (String) —
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
:aws_job_executions_rollout_config (Types::AwsJobExecutionsRolloutConfig) —
Configuration for the rollout of OTA updates.
:files (required, Array<Types::OTAUpdateFile>) —
The files to be streamed by the OTA update.
:role_arn (required, String) —
The IAM role that allows access to the AWS IoT Jobs service.
:additional_parameters (Hash<String,String>) —
A list of additional OTA update parameters which are name-value pairs.

Returns:

(Types::CreateOTAUpdateResponse) —
Returns a response object which responds to the following methods:
- #ota_update_id => String
- #aws_iot_job_id => String
- #ota_update_arn => String
- #aws_iot_job_arn => String
- #ota_update_status => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1163

def create_ota_update(params = {}, options = {})
  req = build_request(:create_ota_update, params)
  req.send_request(options)
end

#create_policy(params = {}) ⇒ `Types::CreatePolicyResponse`

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

Examples:

Request syntax with placeholder values


resp = client.create_policy({
  policy_name: "PolicyName", # required
  policy_document: "PolicyDocument", # required
})

Response structure


resp.policy_name #=> String
resp.policy_arn #=> String
resp.policy_document #=> String
resp.policy_version_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The policy name.
:policy_document (required, String) —
The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Returns:

(Types::CreatePolicyResponse) —
Returns a response object which responds to the following methods:
- #policy_name => String
- #policy_arn => String
- #policy_document => String
- #policy_version_id => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1205

def create_policy(params = {}, options = {})
  req = build_request(:create_policy, params)
  req.send_request(options)
end

#create_policy_version(params = {}) ⇒ `Types::CreatePolicyVersionResponse`

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Examples:

Request syntax with placeholder values


resp = client.create_policy_version({
  policy_name: "PolicyName", # required
  policy_document: "PolicyDocument", # required
  set_as_default: false,
})

Response structure


resp.policy_arn #=> String
resp.policy_document #=> String
resp.policy_version_id #=> String
resp.is_default_version #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The policy name.
:policy_document (required, String) —
The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.
:set_as_default (Boolean) —
Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Returns:

(Types::CreatePolicyVersionResponse) —
Returns a response object which responds to the following methods:
- #policy_arn => String
- #policy_document => String
- #policy_version_id => String
- #is_default_version => Boolean

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1258

def create_policy_version(params = {}, options = {})
  req = build_request(:create_policy_version, params)
  req.send_request(options)
end

#create_role_alias(params = {}) ⇒ `Types::CreateRoleAliasResponse`

Creates a role alias.

Examples:

Request syntax with placeholder values


resp = client.create_role_alias({
  role_alias: "RoleAlias", # required
  role_arn: "RoleArn", # required
  credential_duration_seconds: 1,
})

Response structure


resp.role_alias #=> String
resp.role_alias_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:role_alias (required, String) —
The role alias that points to a role ARN. This allows you to change the role without having to update the device.
:role_arn (required, String) —
The role ARN.
:credential_duration_seconds (Integer) —
How long (in seconds) the credentials will be valid.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1295

def create_role_alias(params = {}, options = {})
  req = build_request(:create_role_alias, params)
  req.send_request(options)
end

#create_scheduled_audit(params = {}) ⇒ `Types::CreateScheduledAuditResponse`

Creates a scheduled audit that is run at a specified time interval.

Examples:

Request syntax with placeholder values


resp = client.create_scheduled_audit({
  frequency: "DAILY", # required, accepts DAILY, WEEKLY, BIWEEKLY, MONTHLY
  day_of_month: "DayOfMonth",
  day_of_week: "SUN", # accepts SUN, MON, TUE, WED, THU, FRI, SAT
  target_check_names: ["AuditCheckName"], # required
  scheduled_audit_name: "ScheduledAuditName", # required
})

Response structure


resp.scheduled_audit_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:frequency (required, String) —
How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The actual start time of each audit is determined by the system.
:day_of_month (String) —
The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
:day_of_week (String) —
The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI" or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
:target_check_names (required, Array<String>) —
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.)
:scheduled_audit_name (required, String) —
The name you want to give to the scheduled audit. (Max. 128 chars)

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1349

def create_scheduled_audit(params = {}, options = {})
  req = build_request(:create_scheduled_audit, params)
  req.send_request(options)
end

#create_security_profile(params = {}) ⇒ `Types::CreateSecurityProfileResponse`

Creates a Device Defender security profile.

Examples:

Request syntax with placeholder values


resp = client.create_security_profile({
  security_profile_name: "SecurityProfileName", # required
  security_profile_description: "SecurityProfileDescription",
  behaviors: [ # required
    {
      name: "BehaviorName", # required
      metric: "BehaviorMetric",
      criteria: {
        comparison_operator: "less-than", # accepts less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set
        value: {
          count: 1,
          cidrs: ["Cidr"],
          ports: [1],
        },
        duration_seconds: 1,
      },
    },
  ],
  alert_targets: {
    "SNS" => {
      alert_target_arn: "AlertTargetArn", # required
      role_arn: "RoleArn", # required
    },
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.security_profile_name #=> String
resp.security_profile_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:security_profile_name (required, String) —
The name you are giving to the security profile.
:security_profile_description (String) —
A description of the security profile.
:behaviors (required, Array<Types::Behavior>) —
Specifies the behaviors that, when violated by a device (thing), cause an alert.
:alert_targets (Hash<String,Types::AlertTarget>) —
Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
:tags (Array<Types::Tag>) —
Metadata which can be used to manage the security profile.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1420

def create_security_profile(params = {}, options = {})
  req = build_request(:create_security_profile, params)
  req.send_request(options)
end

#create_stream(params = {}) ⇒ `Types::CreateStreamResponse`

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.

Examples:

Request syntax with placeholder values


resp = client.create_stream({
  stream_id: "StreamId", # required
  description: "StreamDescription",
  files: [ # required
    {
      file_id: 1,
      s3_location: {
        bucket: "S3Bucket",
        key: "S3Key",
        version: "S3Version",
      },
    },
  ],
  role_arn: "RoleArn", # required
})

Response structure


resp.stream_id #=> String
resp.stream_arn #=> String
resp.description #=> String
resp.stream_version #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:stream_id (required, String) —
The stream ID.
:description (String) —
A description of the stream.
:files (required, Array<Types::StreamFile>) —
The files to stream.
:role_arn (required, String) —
An IAM role that allows the IoT service principal assumes to access your S3 files.

Returns:

(Types::CreateStreamResponse) —
Returns a response object which responds to the following methods:
- #stream_id => String
- #stream_arn => String
- #description => String
- #stream_version => Integer

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1481

def create_stream(params = {}, options = {})
  req = build_request(:create_stream, params)
  req.send_request(options)
end

#create_thing(params = {}) ⇒ `Types::CreateThingResponse`

Creates a thing record in the registry.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

Examples:

Request syntax with placeholder values


resp = client.create_thing({
  thing_name: "ThingName", # required
  thing_type_name: "ThingTypeName",
  attribute_payload: {
    attributes: {
      "AttributeName" => "AttributeValue",
    },
    merge: false,
  },
  billing_group_name: "BillingGroupName",
})

Response structure


resp.thing_name #=> String
resp.thing_arn #=> String
resp.thing_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_name (required, String) —
The name of the thing to create.
:thing_type_name (String) —
The name of the thing type associated with the new thing.
:attribute_payload (Types::AttributePayload) —
The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:

\{"attributes":\{"string1":"string2"\}\}
:billing_group_name (String) —
The name of the billing group the thing will be added to.

Returns:

(Types::CreateThingResponse) —
Returns a response object which responds to the following methods:
- #thing_name => String
- #thing_arn => String
- #thing_id => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1540

def create_thing(params = {}, options = {})
  req = build_request(:create_thing, params)
  req.send_request(options)
end

#create_thing_group(params = {}) ⇒ `Types::CreateThingGroupResponse`

Create a thing group.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

Examples:

Request syntax with placeholder values


resp = client.create_thing_group({
  thing_group_name: "ThingGroupName", # required
  parent_group_name: "ThingGroupName",
  thing_group_properties: {
    thing_group_description: "ThingGroupDescription",
    attribute_payload: {
      attributes: {
        "AttributeName" => "AttributeValue",
      },
      merge: false,
    },
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.thing_group_name #=> String
resp.thing_group_arn #=> String
resp.thing_group_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_group_name (required, String) —
The thing group name to create.
:parent_group_name (String) —
The name of the parent thing group.
:thing_group_properties (Types::ThingGroupProperties) —
The thing group properties.
:tags (Array<Types::Tag>) —
Metadata which can be used to manage the thing group.

Returns:

(Types::CreateThingGroupResponse) —
Returns a response object which responds to the following methods:
- #thing_group_name => String
- #thing_group_arn => String
- #thing_group_id => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1604

def create_thing_group(params = {}, options = {})
  req = build_request(:create_thing_group, params)
  req.send_request(options)
end

#create_thing_type(params = {}) ⇒ `Types::CreateThingTypeResponse`

Creates a new thing type.

Examples:

Request syntax with placeholder values


resp = client.create_thing_type({
  thing_type_name: "ThingTypeName", # required
  thing_type_properties: {
    thing_type_description: "ThingTypeDescription",
    searchable_attributes: ["AttributeName"],
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.thing_type_name #=> String
resp.thing_type_arn #=> String
resp.thing_type_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_type_name (required, String) —
The name of the thing type.
:thing_type_properties (Types::ThingTypeProperties) —
The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.
:tags (Array<Types::Tag>) —
Metadata which can be used to manage the thing type.

Returns:

(Types::CreateThingTypeResponse) —
Returns a response object which responds to the following methods:
- #thing_type_name => String
- #thing_type_arn => String
- #thing_type_id => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1652

def create_thing_type(params = {}, options = {})
  req = build_request(:create_thing_type, params)
  req.send_request(options)
end

#create_topic_rule(params = {}) ⇒ `Struct`

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Examples:

Request syntax with placeholder values


resp = client.create_topic_rule({
  rule_name: "RuleName", # required
  topic_rule_payload: { # required
    sql: "SQL", # required
    description: "Description",
    actions: [ # required
      {
        dynamo_db: {
          table_name: "TableName", # required
          role_arn: "AwsArn", # required
          operation: "DynamoOperation",
          hash_key_field: "HashKeyField", # required
          hash_key_value: "HashKeyValue", # required
          hash_key_type: "STRING", # accepts STRING, NUMBER
          range_key_field: "RangeKeyField",
          range_key_value: "RangeKeyValue",
          range_key_type: "STRING", # accepts STRING, NUMBER
          payload_field: "PayloadField",
        },
        dynamo_d_bv_2: {
          role_arn: "AwsArn", # required
          put_item: { # required
            table_name: "TableName", # required
          },
        },
        lambda: {
          function_arn: "FunctionArn", # required
        },
        sns: {
          target_arn: "AwsArn", # required
          role_arn: "AwsArn", # required
          message_format: "RAW", # accepts RAW, JSON
        },
        sqs: {
          role_arn: "AwsArn", # required
          queue_url: "QueueUrl", # required
          use_base_64: false,
        },
        kinesis: {
          role_arn: "AwsArn", # required
          stream_name: "StreamName", # required
          partition_key: "PartitionKey",
        },
        republish: {
          role_arn: "AwsArn", # required
          topic: "TopicPattern", # required
        },
        s3: {
          role_arn: "AwsArn", # required
          bucket_name: "BucketName", # required
          key: "Key", # required
          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
        },
        firehose: {
          role_arn: "AwsArn", # required
          delivery_stream_name: "DeliveryStreamName", # required
          separator: "FirehoseSeparator",
        },
        cloudwatch_metric: {
          role_arn: "AwsArn", # required
          metric_namespace: "String", # required
          metric_name: "String", # required
          metric_value: "String", # required
          metric_unit: "String", # required
          metric_timestamp: "String",
        },
        cloudwatch_alarm: {
          role_arn: "AwsArn", # required
          alarm_name: "AlarmName", # required
          state_reason: "StateReason", # required
          state_value: "StateValue", # required
        },
        elasticsearch: {
          role_arn: "AwsArn", # required
          endpoint: "ElasticsearchEndpoint", # required
          index: "ElasticsearchIndex", # required
          type: "ElasticsearchType", # required
          id: "ElasticsearchId", # required
        },
        salesforce: {
          token: "SalesforceToken", # required
          url: "SalesforceEndpoint", # required
        },
        iot_analytics: {
          channel_arn: "AwsArn",
          channel_name: "ChannelName",
          role_arn: "AwsArn",
        },
        iot_events: {
          input_name: "InputName", # required
          message_id: "MessageId",
          role_arn: "AwsArn", # required
        },
        step_functions: {
          execution_name_prefix: "ExecutionNamePrefix",
          state_machine_name: "StateMachineName", # required
          role_arn: "AwsArn", # required
        },
      },
    ],
    rule_disabled: false,
    aws_iot_sql_version: "AwsIotSqlVersion",
    error_action: {
      dynamo_db: {
        table_name: "TableName", # required
        role_arn: "AwsArn", # required
        operation: "DynamoOperation",
        hash_key_field: "HashKeyField", # required
        hash_key_value: "HashKeyValue", # required
        hash_key_type: "STRING", # accepts STRING, NUMBER
        range_key_field: "RangeKeyField",
        range_key_value: "RangeKeyValue",
        range_key_type: "STRING", # accepts STRING, NUMBER
        payload_field: "PayloadField",
      },
      dynamo_d_bv_2: {
        role_arn: "AwsArn", # required
        put_item: { # required
          table_name: "TableName", # required
        },
      },
      lambda: {
        function_arn: "FunctionArn", # required
      },
      sns: {
        target_arn: "AwsArn", # required
        role_arn: "AwsArn", # required
        message_format: "RAW", # accepts RAW, JSON
      },
      sqs: {
        role_arn: "AwsArn", # required
        queue_url: "QueueUrl", # required
        use_base_64: false,
      },
      kinesis: {
        role_arn: "AwsArn", # required
        stream_name: "StreamName", # required
        partition_key: "PartitionKey",
      },
      republish: {
        role_arn: "AwsArn", # required
        topic: "TopicPattern", # required
      },
      s3: {
        role_arn: "AwsArn", # required
        bucket_name: "BucketName", # required
        key: "Key", # required
        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
      },
      firehose: {
        role_arn: "AwsArn", # required
        delivery_stream_name: "DeliveryStreamName", # required
        separator: "FirehoseSeparator",
      },
      cloudwatch_metric: {
        role_arn: "AwsArn", # required
        metric_namespace: "String", # required
        metric_name: "String", # required
        metric_value: "String", # required
        metric_unit: "String", # required
        metric_timestamp: "String",
      },
      cloudwatch_alarm: {
        role_arn: "AwsArn", # required
        alarm_name: "AlarmName", # required
        state_reason: "StateReason", # required
        state_value: "StateValue", # required
      },
      elasticsearch: {
        role_arn: "AwsArn", # required
        endpoint: "ElasticsearchEndpoint", # required
        index: "ElasticsearchIndex", # required
        type: "ElasticsearchType", # required
        id: "ElasticsearchId", # required
      },
      salesforce: {
        token: "SalesforceToken", # required
        url: "SalesforceEndpoint", # required
      },
      iot_analytics: {
        channel_arn: "AwsArn",
        channel_name: "ChannelName",
        role_arn: "AwsArn",
      },
      iot_events: {
        input_name: "InputName", # required
        message_id: "MessageId",
        role_arn: "AwsArn", # required
      },
      step_functions: {
        execution_name_prefix: "ExecutionNamePrefix",
        state_machine_name: "StateMachineName", # required
        role_arn: "AwsArn", # required
      },
    },
  },
  tags: "String",
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:rule_name (required, String) —
The name of the rule.
:topic_rule_payload (required, Types::TopicRulePayload) —
The rule payload.
:tags (String) —
Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1886

def create_topic_rule(params = {}, options = {})
  req = build_request(:create_topic_rule, params)
  req.send_request(options)
end

#delete_account_audit_configuration(params = {}) ⇒ `Struct`

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

Examples:

Request syntax with placeholder values


resp = client.delete_account_audit_configuration({
  delete_scheduled_audits: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:delete_scheduled_audits (Boolean) —
If true, all scheduled audits are deleted.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1908

def delete_account_audit_configuration(params = {}, options = {})
  req = build_request(:delete_account_audit_configuration, params)
  req.send_request(options)
end

#delete_authorizer(params = {}) ⇒ `Struct`

Deletes an authorizer.

Examples:

Request syntax with placeholder values


resp = client.delete_authorizer({
  authorizer_name: "AuthorizerName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:authorizer_name (required, String) —
The name of the authorizer to delete.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1928

def delete_authorizer(params = {}, options = {})
  req = build_request(:delete_authorizer, params)
  req.send_request(options)
end

#delete_billing_group(params = {}) ⇒ `Struct`

Deletes the billing group.

Examples:

Request syntax with placeholder values


resp = client.delete_billing_group({
  billing_group_name: "BillingGroupName", # required
  expected_version: 1,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:billing_group_name (required, String) —
The name of the billing group.
:expected_version (Integer) —
The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1955

def delete_billing_group(params = {}, options = {})
  req = build_request(:delete_billing_group, params)
  req.send_request(options)
end

#delete_ca_certificate(params = {}) ⇒ `Struct`

Deletes a registered CA certificate.

Examples:

Request syntax with placeholder values


resp = client.delete_ca_certificate({
  certificate_id: "CertificateId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:certificate_id (required, String) —
The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1976

def delete_ca_certificate(params = {}, options = {})
  req = build_request(:delete_ca_certificate, params)
  req.send_request(options)
end

#delete_certificate(params = {}) ⇒ `Struct`

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

Examples:

Request syntax with placeholder values


resp = client.delete_certificate({
  certificate_id: "CertificateId", # required
  force_delete: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:certificate_id (required, String) —
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
:force_delete (Boolean) —
Forces a certificate request to be deleted.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2006

def delete_certificate(params = {}, options = {})
  req = build_request(:delete_certificate, params)
  req.send_request(options)
end

#delete_dynamic_thing_group(params = {}) ⇒ `Struct`

Deletes a dynamic thing group.

Examples:

Request syntax with placeholder values


resp = client.delete_dynamic_thing_group({
  thing_group_name: "ThingGroupName", # required
  expected_version: 1,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_group_name (required, String) —
The name of the dynamic thing group to delete.
:expected_version (Integer) —
The expected version of the dynamic thing group to delete.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2030

def delete_dynamic_thing_group(params = {}, options = {})
  req = build_request(:delete_dynamic_thing_group, params)
  req.send_request(options)
end

#delete_job(params = {}) ⇒ `Struct`

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

Examples:

Request syntax with placeholder values


resp = client.delete_job({
  job_id: "JobId", # required
  force: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
:force (Boolean) — default: Optional —
When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2078

def delete_job(params = {}, options = {})
  req = build_request(:delete_job, params)
  req.send_request(options)
end

#delete_job_execution(params = {}) ⇒ `Struct`

Deletes a job execution.

Examples:

Request syntax with placeholder values


resp = client.delete_job_execution({
  job_id: "JobId", # required
  thing_name: "ThingName", # required
  execution_number: 1, # required
  force: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
The ID of the job whose execution on a particular device will be deleted.
:thing_name (required, String) —
The name of the thing whose job execution will be deleted.
:execution_number (required, Integer) —
The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.
:force (Boolean) — default: Optional —
When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2126

def delete_job_execution(params = {}, options = {})
  req = build_request(:delete_job_execution, params)
  req.send_request(options)
end

#delete_ota_update(params = {}) ⇒ `Struct`

Delete an OTA update.

Examples:

Request syntax with placeholder values


resp = client.delete_ota_update({
  ota_update_id: "OTAUpdateId", # required
  delete_stream: false,
  force_delete_aws_job: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ota_update_id (required, String) —
The OTA update ID to delete.
:delete_stream (Boolean) —
Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.
:force_delete_aws_job (Boolean) —
Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2156

def delete_ota_update(params = {}, options = {})
  req = build_request(:delete_ota_update, params)
  req.send_request(options)
end

#delete_policy(params = {}) ⇒ `Struct`

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

Examples:

Request syntax with placeholder values


resp = client.delete_policy({
  policy_name: "PolicyName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The name of the policy to delete.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2187

def delete_policy(params = {}, options = {})
  req = build_request(:delete_policy, params)
  req.send_request(options)
end

#delete_policy_version(params = {}) ⇒ `Struct`

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Examples:

Request syntax with placeholder values


resp = client.delete_policy_version({
  policy_name: "PolicyName", # required
  policy_version_id: "PolicyVersionId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The name of the policy.
:policy_version_id (required, String) —
The policy version ID.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2215

def delete_policy_version(params = {}, options = {})
  req = build_request(:delete_policy_version, params)
  req.send_request(options)
end

#delete_registration_code(params = {}) ⇒ `Struct`

Deletes a CA certificate registration code.

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2226

def delete_registration_code(params = {}, options = {})
  req = build_request(:delete_registration_code, params)
  req.send_request(options)
end

#delete_role_alias(params = {}) ⇒ `Struct`

Deletes a role alias

Examples:

Request syntax with placeholder values


resp = client.delete_role_alias({
  role_alias: "RoleAlias", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:role_alias (required, String) —
The role alias to delete.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2246

def delete_role_alias(params = {}, options = {})
  req = build_request(:delete_role_alias, params)
  req.send_request(options)
end

#delete_scheduled_audit(params = {}) ⇒ `Struct`

Deletes a scheduled audit.

Examples:

Request syntax with placeholder values


resp = client.delete_scheduled_audit({
  scheduled_audit_name: "ScheduledAuditName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:scheduled_audit_name (required, String) —
The name of the scheduled audit you want to delete.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2266

def delete_scheduled_audit(params = {}, options = {})
  req = build_request(:delete_scheduled_audit, params)
  req.send_request(options)
end

#delete_security_profile(params = {}) ⇒ `Struct`

Deletes a Device Defender security profile.

Examples:

Request syntax with placeholder values


resp = client.delete_security_profile({
  security_profile_name: "SecurityProfileName", # required
  expected_version: 1,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:security_profile_name (required, String) —
The name of the security profile to be deleted.
:expected_version (Integer) —
The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a VersionConflictException is thrown.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2293

def delete_security_profile(params = {}, options = {})
  req = build_request(:delete_security_profile, params)
  req.send_request(options)
end

#delete_stream(params = {}) ⇒ `Struct`

Deletes a stream.

Examples:

Request syntax with placeholder values


resp = client.delete_stream({
  stream_id: "StreamId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:stream_id (required, String) —
The stream ID.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2313

def delete_stream(params = {}, options = {})
  req = build_request(:delete_stream, params)
  req.send_request(options)
end

#delete_thing(params = {}) ⇒ `Struct`

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

Examples:

Request syntax with placeholder values


resp = client.delete_thing({
  thing_name: "ThingName", # required
  expected_version: 1,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_name (required, String) —
The name of the thing to delete.
:expected_version (Integer) —
The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2341

def delete_thing(params = {}, options = {})
  req = build_request(:delete_thing, params)
  req.send_request(options)
end

#delete_thing_group(params = {}) ⇒ `Struct`

Deletes a thing group.

Examples:

Request syntax with placeholder values


resp = client.delete_thing_group({
  thing_group_name: "ThingGroupName", # required
  expected_version: 1,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_group_name (required, String) —
The name of the thing group to delete.
:expected_version (Integer) —
The expected version of the thing group to delete.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2365

def delete_thing_group(params = {}, options = {})
  req = build_request(:delete_thing_group, params)
  req.send_request(options)
end

#delete_thing_type(params = {}) ⇒ `Struct`

Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

Examples:

Request syntax with placeholder values


resp = client.delete_thing_type({
  thing_type_name: "ThingTypeName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_type_name (required, String) —
The name of the thing type.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2390

def delete_thing_type(params = {}, options = {})
  req = build_request(:delete_thing_type, params)
  req.send_request(options)
end

#delete_topic_rule(params = {}) ⇒ `Struct`

Deletes the rule.

Examples:

Request syntax with placeholder values


resp = client.delete_topic_rule({
  rule_name: "RuleName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:rule_name (required, String) —
The name of the rule.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2410

def delete_topic_rule(params = {}, options = {})
  req = build_request(:delete_topic_rule, params)
  req.send_request(options)
end

#delete_v2_logging_level(params = {}) ⇒ `Struct`

Deletes a logging level.

Examples:

Request syntax with placeholder values


resp = client.delete_v2_logging_level({
  target_type: "DEFAULT", # required, accepts DEFAULT, THING_GROUP
  target_name: "LogTargetName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:target_type (required, String) —
The type of resource for which you are configuring logging. Must be THING_Group.
:target_name (required, String) —
The name of the resource for which you are configuring logging.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2435

def delete_v2_logging_level(params = {}, options = {})
  req = build_request(:delete_v2_logging_level, params)
  req.send_request(options)
end

#deprecate_thing_type(params = {}) ⇒ `Struct`

Deprecates a thing type. You can not associate new things with deprecated thing type.

Examples:

Request syntax with placeholder values


resp = client.deprecate_thing_type({
  thing_type_name: "ThingTypeName", # required
  undo_deprecate: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_type_name (required, String) —
The name of the thing type to deprecate.
:undo_deprecate (Boolean) —
Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2462

def deprecate_thing_type(params = {}, options = {})
  req = build_request(:deprecate_thing_type, params)
  req.send_request(options)
end

#describe_account_audit_configuration(params = {}) ⇒ `Types::DescribeAccountAuditConfigurationResponse`

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

Examples:

Response structure


resp.role_arn #=> String
resp.audit_notification_target_configurations #=> Hash
resp.audit_notification_target_configurations["AuditNotificationType"].target_arn #=> String
resp.audit_notification_target_configurations["AuditNotificationType"].role_arn #=> String
resp.audit_notification_target_configurations["AuditNotificationType"].enabled #=> Boolean
resp.audit_check_configurations #=> Hash
resp.audit_check_configurations["AuditCheckName"].enabled #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Types::DescribeAccountAuditConfigurationResponse) —
Returns a response object which responds to the following methods:
- #role_arn => String
- #audit_notification_target_configurations => Hash<String,Types::AuditNotificationTarget>
- #audit_check_configurations => Hash<String,Types::AuditCheckConfiguration>

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2489

def describe_account_audit_configuration(params = {}, options = {})
  req = build_request(:describe_account_audit_configuration, params)
  req.send_request(options)
end

#describe_audit_task(params = {}) ⇒ `Types::DescribeAuditTaskResponse`

Gets information about a Device Defender audit.

Examples:

Request syntax with placeholder values


resp = client.describe_audit_task({
  task_id: "AuditTaskId", # required
})

Response structure


resp.task_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELED"
resp.task_type #=> String, one of "ON_DEMAND_AUDIT_TASK", "SCHEDULED_AUDIT_TASK"
resp.task_start_time #=> Time
resp.task_statistics.total_checks #=> Integer
resp.task_statistics.in_progress_checks #=> Integer
resp.task_statistics.waiting_for_data_collection_checks #=> Integer
resp.task_statistics.compliant_checks #=> Integer
resp.task_statistics.non_compliant_checks #=> Integer
resp.task_statistics.failed_checks #=> Integer
resp.task_statistics.canceled_checks #=> Integer
resp.scheduled_audit_name #=> String
resp.audit_details #=> Hash
resp.audit_details["AuditCheckName"].check_run_status #=> String, one of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", "FAILED"
resp.audit_details["AuditCheckName"].check_compliant #=> Boolean
resp.audit_details["AuditCheckName"].total_resources_count #=> Integer
resp.audit_details["AuditCheckName"].non_compliant_resources_count #=> Integer
resp.audit_details["AuditCheckName"].error_code #=> String
resp.audit_details["AuditCheckName"].message #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:task_id (required, String) —
The ID of the audit whose information you want to get.

Returns:

(Types::DescribeAuditTaskResponse) —
Returns a response object which responds to the following methods:
- #task_status => String
- #task_type => String
- #task_start_time => Time
- #task_statistics => Types::TaskStatistics
- #scheduled_audit_name => String
- #audit_details => Hash<String,Types::AuditCheckDetails>

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2537

def describe_audit_task(params = {}, options = {})
  req = build_request(:describe_audit_task, params)
  req.send_request(options)
end

#describe_authorizer(params = {}) ⇒ `Types::DescribeAuthorizerResponse`

Describes an authorizer.

Examples:

Request syntax with placeholder values


resp = client.describe_authorizer({
  authorizer_name: "AuthorizerName", # required
})

Response structure


resp.authorizer_description.authorizer_name #=> String
resp.authorizer_description.authorizer_arn #=> String
resp.authorizer_description.authorizer_function_arn #=> String
resp.authorizer_description.token_key_name #=> String
resp.authorizer_description.token_signing_public_keys #=> Hash
resp.authorizer_description.token_signing_public_keys["KeyName"] #=> String
resp.authorizer_description.status #=> String, one of "ACTIVE", "INACTIVE"
resp.authorizer_description.creation_date #=> Time
resp.authorizer_description.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:authorizer_name (required, String) —
The name of the authorizer to describe.

Returns:

(Types::DescribeAuthorizerResponse) —
Returns a response object which responds to the following methods:
- #authorizer_description => Types::AuthorizerDescription

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2571

def describe_authorizer(params = {}, options = {})
  req = build_request(:describe_authorizer, params)
  req.send_request(options)
end

#describe_billing_group(params = {}) ⇒ `Types::DescribeBillingGroupResponse`

Returns information about a billing group.

Examples:

Request syntax with placeholder values


resp = client.describe_billing_group({
  billing_group_name: "BillingGroupName", # required
})

Response structure


resp.billing_group_name #=> String
resp.billing_group_id #=> String
resp.billing_group_arn #=> String
resp.version #=> Integer
resp.billing_group_properties.billing_group_description #=> String
resp.billing_group_metadata.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:billing_group_name (required, String) —
The name of the billing group.

Returns:

(Types::DescribeBillingGroupResponse) —
Returns a response object which responds to the following methods:
- #billing_group_name => String
- #billing_group_id => String
- #billing_group_arn => String
- #version => Integer
- #billing_group_properties => Types::BillingGroupProperties
- #billing_group_metadata => Types::BillingGroupMetadata

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2607

def describe_billing_group(params = {}, options = {})
  req = build_request(:describe_billing_group, params)
  req.send_request(options)
end

#describe_ca_certificate(params = {}) ⇒ `Types::DescribeCACertificateResponse`

Describes a registered CA certificate.

Examples:

Request syntax with placeholder values


resp = client.describe_ca_certificate({
  certificate_id: "CertificateId", # required
})

Response structure


resp.certificate_description.certificate_arn #=> String
resp.certificate_description.certificate_id #=> String
resp.certificate_description.status #=> String, one of "ACTIVE", "INACTIVE"
resp.certificate_description.certificate_pem #=> String
resp.certificate_description.owned_by #=> String
resp.certificate_description.creation_date #=> Time
resp.certificate_description.auto_registration_status #=> String, one of "ENABLE", "DISABLE"
resp.certificate_description.last_modified_date #=> Time
resp.certificate_description.customer_version #=> Integer
resp.certificate_description.generation_id #=> String
resp.certificate_description.validity.not_before #=> Time
resp.certificate_description.validity.not_after #=> Time
resp.registration_config.template_body #=> String
resp.registration_config.role_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:certificate_id (required, String) —
The CA certificate identifier.

Returns:

(Types::DescribeCACertificateResponse) —
Returns a response object which responds to the following methods:
- #certificate_description => Types::CACertificateDescription
- #registration_config => Types::RegistrationConfig

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2647

def describe_ca_certificate(params = {}, options = {})
  req = build_request(:describe_ca_certificate, params)
  req.send_request(options)
end

#describe_certificate(params = {}) ⇒ `Types::DescribeCertificateResponse`

Gets information about the specified certificate.

Examples:

Request syntax with placeholder values


resp = client.describe_certificate({
  certificate_id: "CertificateId", # required
})

Response structure


resp.certificate_description.certificate_arn #=> String
resp.certificate_description.certificate_id #=> String
resp.certificate_description.ca_certificate_id #=> String
resp.certificate_description.status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
resp.certificate_description.certificate_pem #=> String
resp.certificate_description.owned_by #=> String
resp.certificate_description.previous_owned_by #=> String
resp.certificate_description.creation_date #=> Time
resp.certificate_description.last_modified_date #=> Time
resp.certificate_description.customer_version #=> Integer
resp.certificate_description.transfer_data.transfer_message #=> String
resp.certificate_description.transfer_data.reject_reason #=> String
resp.certificate_description.transfer_data.transfer_date #=> Time
resp.certificate_description.transfer_data.accept_date #=> Time
resp.certificate_description.transfer_data.reject_date #=> Time
resp.certificate_description.generation_id #=> String
resp.certificate_description.validity.not_before #=> Time
resp.certificate_description.validity.not_after #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:certificate_id (required, String) —
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Returns:

(Types::DescribeCertificateResponse) —
Returns a response object which responds to the following methods:
- #certificate_description => Types::CertificateDescription

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2691

def describe_certificate(params = {}, options = {})
  req = build_request(:describe_certificate, params)
  req.send_request(options)
end

#describe_default_authorizer(params = {}) ⇒ `Types::DescribeDefaultAuthorizerResponse`

Describes the default authorizer.

Examples:

Response structure


resp.authorizer_description.authorizer_name #=> String
resp.authorizer_description.authorizer_arn #=> String
resp.authorizer_description.authorizer_function_arn #=> String
resp.authorizer_description.token_key_name #=> String
resp.authorizer_description.token_signing_public_keys #=> Hash
resp.authorizer_description.token_signing_public_keys["KeyName"] #=> String
resp.authorizer_description.status #=> String, one of "ACTIVE", "INACTIVE"
resp.authorizer_description.creation_date #=> Time
resp.authorizer_description.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Types::DescribeDefaultAuthorizerResponse) —
Returns a response object which responds to the following methods:
- #authorizer_description => Types::AuthorizerDescription

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2716

def describe_default_authorizer(params = {}, options = {})
  req = build_request(:describe_default_authorizer, params)
  req.send_request(options)
end

#describe_endpoint(params = {}) ⇒ `Types::DescribeEndpointResponse`

Returns a unique endpoint specific to the AWS account making the call.

Examples:

Request syntax with placeholder values


resp = client.describe_endpoint({
  endpoint_type: "EndpointType",
})

Response structure


resp.endpoint_address #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:endpoint_type (String) —
The endpoint type. Valid endpoint types include:
- iot:Data - Returns a VeriSign signed data endpoint.
^ ^
- iot:Data-ATS - Returns an ATS signed data endpoint.
^ ^
- iot:CredentialProvider - Returns an AWS IoT credentials provider API endpoint.
^ ^
- iot:Jobs - Returns an AWS IoT device management Jobs API endpoint.
^

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2762

def describe_endpoint(params = {}, options = {})
  req = build_request(:describe_endpoint, params)
  req.send_request(options)
end

#describe_event_configurations(params = {}) ⇒ `Types::DescribeEventConfigurationsResponse`

Describes event configurations.

Examples:

Response structure


resp.event_configurations #=> Hash
resp.event_configurations["EventType"].enabled #=> Boolean
resp.creation_date #=> Time
resp.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Types::DescribeEventConfigurationsResponse) —
Returns a response object which responds to the following methods:
- #event_configurations => Hash<String,Types::Configuration>
- #creation_date => Time
- #last_modified_date => Time

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2784

def describe_event_configurations(params = {}, options = {})
  req = build_request(:describe_event_configurations, params)
  req.send_request(options)
end

#describe_index(params = {}) ⇒ `Types::DescribeIndexResponse`

Describes a search index.

Examples:

Request syntax with placeholder values


resp = client.describe_index({
  index_name: "IndexName", # required
})

Response structure


resp.index_name #=> String
resp.index_status #=> String, one of "ACTIVE", "BUILDING", "REBUILDING"
resp.schema #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:index_name (required, String) —
The index name.

Returns:

(Types::DescribeIndexResponse) —
Returns a response object which responds to the following methods:
- #index_name => String
- #index_status => String
- #schema => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2814

def describe_index(params = {}, options = {})
  req = build_request(:describe_index, params)
  req.send_request(options)
end

#describe_job(params = {}) ⇒ `Types::DescribeJobResponse`

Describes a job.

Examples:

Request syntax with placeholder values


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

Response structure


resp.document_source #=> String
resp.job.job_arn #=> String
resp.job.job_id #=> String
resp.job.target_selection #=> String, one of "CONTINUOUS", "SNAPSHOT"
resp.job.status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS"
resp.job.force_canceled #=> Boolean
resp.job.reason_code #=> String
resp.job.comment #=> String
resp.job.targets #=> Array
resp.job.targets[0] #=> String
resp.job.description #=> String
resp.job.presigned_url_config.role_arn #=> String
resp.job.presigned_url_config.expires_in_sec #=> Integer
resp.job.job_executions_rollout_config.maximum_per_minute #=> Integer
resp.job.job_executions_rollout_config.exponential_rate.base_rate_per_minute #=> Integer
resp.job.job_executions_rollout_config.exponential_rate.increment_factor #=> Float
resp.job.job_executions_rollout_config.exponential_rate.rate_increase_criteria.number_of_notified_things #=> Integer
resp.job.job_executions_rollout_config.exponential_rate.rate_increase_criteria.number_of_succeeded_things #=> Integer
resp.job.abort_config.criteria_list #=> Array
resp.job.abort_config.criteria_list[0].failure_type #=> String, one of "FAILED", "REJECTED", "TIMED_OUT", "ALL"
resp.job.abort_config.criteria_list[0].action #=> String, one of "CANCEL"
resp.job.abort_config.criteria_list[0].threshold_percentage #=> Float
resp.job.abort_config.criteria_list[0].min_number_of_executed_things #=> Integer
resp.job.created_at #=> Time
resp.job.last_updated_at #=> Time
resp.job.completed_at #=> Time
resp.job.job_process_details.processing_targets #=> Array
resp.job.job_process_details.processing_targets[0] #=> String
resp.job.job_process_details.number_of_canceled_things #=> Integer
resp.job.job_process_details.number_of_succeeded_things #=> Integer
resp.job.job_process_details.number_of_failed_things #=> Integer
resp.job.job_process_details.number_of_rejected_things #=> Integer
resp.job.job_process_details.number_of_queued_things #=> Integer
resp.job.job_process_details.number_of_in_progress_things #=> Integer
resp.job.job_process_details.number_of_removed_things #=> Integer
resp.job.job_process_details.number_of_timed_out_things #=> Integer
resp.job.timeout_config.in_progress_timeout_in_minutes #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
The unique identifier you assigned to this job when it was created.

Returns:

(Types::DescribeJobResponse) —
Returns a response object which responds to the following methods:
- #document_source => String
- #job => Types::Job

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2877

def describe_job(params = {}, options = {})
  req = build_request(:describe_job, params)
  req.send_request(options)
end

#describe_job_execution(params = {}) ⇒ `Types::DescribeJobExecutionResponse`

Describes a job execution.

Examples:

Request syntax with placeholder values


resp = client.describe_job_execution({
  job_id: "JobId", # required
  thing_name: "ThingName", # required
  execution_number: 1,
})

Response structure


resp.execution.job_id #=> String
resp.execution.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "REJECTED", "REMOVED", "CANCELED"
resp.execution.force_canceled #=> Boolean
resp.execution.status_details.details_map #=> Hash
resp.execution.status_details.details_map["DetailsKey"] #=> String
resp.execution.thing_arn #=> String
resp.execution.queued_at #=> Time
resp.execution.started_at #=> Time
resp.execution.last_updated_at #=> Time
resp.execution.execution_number #=> Integer
resp.execution.version_number #=> Integer
resp.execution.approximate_seconds_before_timed_out #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
The unique identifier you assigned to this job when it was created.
:thing_name (required, String) —
The name of the thing on which the job execution is running.
:execution_number (Integer) —
A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.

Returns:

(Types::DescribeJobExecutionResponse) —
Returns a response object which responds to the following methods:
- #execution => Types::JobExecution

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2923

def describe_job_execution(params = {}, options = {})
  req = build_request(:describe_job_execution, params)
  req.send_request(options)
end

#describe_role_alias(params = {}) ⇒ `Types::DescribeRoleAliasResponse`

Describes a role alias.

Examples:

Request syntax with placeholder values


resp = client.describe_role_alias({
  role_alias: "RoleAlias", # required
})

Response structure


resp.role_alias_description.role_alias #=> String
resp.role_alias_description.role_alias_arn #=> String
resp.role_alias_description.role_arn #=> String
resp.role_alias_description.owner #=> String
resp.role_alias_description.credential_duration_seconds #=> Integer
resp.role_alias_description.creation_date #=> Time
resp.role_alias_description.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:role_alias (required, String) —
The role alias to describe.

Returns:

(Types::DescribeRoleAliasResponse) —
Returns a response object which responds to the following methods:
- #role_alias_description => Types::RoleAliasDescription

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2955

def describe_role_alias(params = {}, options = {})
  req = build_request(:describe_role_alias, params)
  req.send_request(options)
end

#describe_scheduled_audit(params = {}) ⇒ `Types::DescribeScheduledAuditResponse`

Gets information about a scheduled audit.

Examples:

Request syntax with placeholder values


resp = client.describe_scheduled_audit({
  scheduled_audit_name: "ScheduledAuditName", # required
})

Response structure


resp.frequency #=> String, one of "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY"
resp.day_of_month #=> String
resp.day_of_week #=> String, one of "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"
resp.target_check_names #=> Array
resp.target_check_names[0] #=> String
resp.scheduled_audit_name #=> String
resp.scheduled_audit_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:scheduled_audit_name (required, String) —
The name of the scheduled audit whose information you want to get.

Returns:

(Types::DescribeScheduledAuditResponse) —
Returns a response object which responds to the following methods:
- #frequency => String
- #day_of_month => String
- #day_of_week => String
- #target_check_names => Array<String>
- #scheduled_audit_name => String
- #scheduled_audit_arn => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2992

def describe_scheduled_audit(params = {}, options = {})
  req = build_request(:describe_scheduled_audit, params)
  req.send_request(options)
end

#describe_security_profile(params = {}) ⇒ `Types::DescribeSecurityProfileResponse`

Gets information about a Device Defender security profile.

Examples:

Request syntax with placeholder values


resp = client.describe_security_profile({
  security_profile_name: "SecurityProfileName", # required
})

Response structure


resp.security_profile_name #=> String
resp.security_profile_arn #=> String
resp.security_profile_description #=> String
resp.behaviors #=> Array
resp.behaviors[0].name #=> String
resp.behaviors[0].metric #=> String
resp.behaviors[0].criteria.comparison_operator #=> String, one of "less-than", "less-than-equals", "greater-than", "greater-than-equals", "in-cidr-set", "not-in-cidr-set", "in-port-set", "not-in-port-set"
resp.behaviors[0].criteria.value.count #=> Integer
resp.behaviors[0].criteria.value.cidrs #=> Array
resp.behaviors[0].criteria.value.cidrs[0] #=> String
resp.behaviors[0].criteria.value.ports #=> Array
resp.behaviors[0].criteria.value.ports[0] #=> Integer
resp.behaviors[0].criteria.duration_seconds #=> Integer
resp.alert_targets #=> Hash
resp.alert_targets["AlertTargetType"].alert_target_arn #=> String
resp.alert_targets["AlertTargetType"].role_arn #=> String
resp.version #=> Integer
resp.creation_date #=> Time
resp.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:security_profile_name (required, String) —
The name of the security profile whose information you want to get.

Returns:

(Types::DescribeSecurityProfileResponse) —
Returns a response object which responds to the following methods:
- #security_profile_name => String
- #security_profile_arn => String
- #security_profile_description => String
- #behaviors => Array<Types::Behavior>
- #alert_targets => Hash<String,Types::AlertTarget>
- #version => Integer
- #creation_date => Time
- #last_modified_date => Time

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3043

def describe_security_profile(params = {}, options = {})
  req = build_request(:describe_security_profile, params)
  req.send_request(options)
end

#describe_stream(params = {}) ⇒ `Types::DescribeStreamResponse`

Gets information about a stream.

Examples:

Request syntax with placeholder values


resp = client.describe_stream({
  stream_id: "StreamId", # required
})

Response structure


resp.stream_info.stream_id #=> String
resp.stream_info.stream_arn #=> String
resp.stream_info.stream_version #=> Integer
resp.stream_info.description #=> String
resp.stream_info.files #=> Array
resp.stream_info.files[0].file_id #=> Integer
resp.stream_info.files[0].s3_location.bucket #=> String
resp.stream_info.files[0].s3_location.key #=> String
resp.stream_info.files[0].s3_location.version #=> String
resp.stream_info.created_at #=> Time
resp.stream_info.last_updated_at #=> Time
resp.stream_info.role_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:stream_id (required, String) —
The stream ID.

Returns:

(Types::DescribeStreamResponse) —
Returns a response object which responds to the following methods:
- #stream_info => Types::StreamInfo

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3080

def describe_stream(params = {}, options = {})
  req = build_request(:describe_stream, params)
  req.send_request(options)
end

#describe_thing(params = {}) ⇒ `Types::DescribeThingResponse`

Gets information about the specified thing.

Examples:

Request syntax with placeholder values


resp = client.describe_thing({
  thing_name: "ThingName", # required
})

Response structure


resp.default_client_id #=> String
resp.thing_name #=> String
resp.thing_id #=> String
resp.thing_arn #=> String
resp.thing_type_name #=> String
resp.attributes #=> Hash
resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.version #=> Integer
resp.billing_group_name #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_name (required, String) —
The name of the thing.

Returns:

(Types::DescribeThingResponse) —
Returns a response object which responds to the following methods:
- #default_client_id => String
- #thing_name => String
- #thing_id => String
- #thing_arn => String
- #thing_type_name => String
- #attributes => Hash<String,String>
- #version => Integer
- #billing_group_name => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3121

def describe_thing(params = {}, options = {})
  req = build_request(:describe_thing, params)
  req.send_request(options)
end

#describe_thing_group(params = {}) ⇒ `Types::DescribeThingGroupResponse`

Describe a thing group.

Examples:

Request syntax with placeholder values


resp = client.describe_thing_group({
  thing_group_name: "ThingGroupName", # required
})

Response structure


resp.thing_group_name #=> String
resp.thing_group_id #=> String
resp.thing_group_arn #=> String
resp.version #=> Integer
resp.thing_group_properties.thing_group_description #=> String
resp.thing_group_properties.attribute_payload.attributes #=> Hash
resp.thing_group_properties.attribute_payload.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.thing_group_properties.attribute_payload.merge #=> Boolean
resp.thing_group_metadata.parent_group_name #=> String
resp.thing_group_metadata.root_to_parent_thing_groups #=> Array
resp.thing_group_metadata.root_to_parent_thing_groups[0].group_name #=> String
resp.thing_group_metadata.root_to_parent_thing_groups[0].group_arn #=> String
resp.thing_group_metadata.creation_date #=> Time
resp.index_name #=> String
resp.query_string #=> String
resp.query_version #=> String
resp.status #=> String, one of "ACTIVE", "BUILDING", "REBUILDING"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_group_name (required, String) —
The name of the thing group.

Returns:

(Types::DescribeThingGroupResponse) —
Returns a response object which responds to the following methods:
- #thing_group_name => String
- #thing_group_id => String
- #thing_group_arn => String
- #version => Integer
- #thing_group_properties => Types::ThingGroupProperties
- #thing_group_metadata => Types::ThingGroupMetadata
- #index_name => String
- #query_string => String
- #query_version => String
- #status => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3172

def describe_thing_group(params = {}, options = {})
  req = build_request(:describe_thing_group, params)
  req.send_request(options)
end

#describe_thing_registration_task(params = {}) ⇒ `Types::DescribeThingRegistrationTaskResponse`

Describes a bulk thing provisioning task.

Examples:

Request syntax with placeholder values


resp = client.describe_thing_registration_task({
  task_id: "TaskId", # required
})

Response structure


resp.task_id #=> String
resp.creation_date #=> Time
resp.last_modified_date #=> Time
resp.template_body #=> String
resp.input_file_bucket #=> String
resp.input_file_key #=> String
resp.role_arn #=> String
resp.status #=> String, one of "InProgress", "Completed", "Failed", "Cancelled", "Cancelling"
resp.message #=> String
resp.success_count #=> Integer
resp.failure_count #=> Integer
resp.percentage_progress #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:task_id (required, String) —
The task ID.

Returns:

(Types::DescribeThingRegistrationTaskResponse) —
Returns a response object which responds to the following methods:
- #task_id => String
- #creation_date => Time
- #last_modified_date => Time
- #template_body => String
- #input_file_bucket => String
- #input_file_key => String
- #role_arn => String
- #status => String
- #message => String
- #success_count => Integer
- #failure_count => Integer
- #percentage_progress => Integer

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3220

def describe_thing_registration_task(params = {}, options = {})
  req = build_request(:describe_thing_registration_task, params)
  req.send_request(options)
end

#describe_thing_type(params = {}) ⇒ `Types::DescribeThingTypeResponse`

Gets information about the specified thing type.

Examples:

Request syntax with placeholder values


resp = client.describe_thing_type({
  thing_type_name: "ThingTypeName", # required
})

Response structure


resp.thing_type_name #=> String
resp.thing_type_id #=> String
resp.thing_type_arn #=> String
resp.thing_type_properties.thing_type_description #=> String
resp.thing_type_properties.searchable_attributes #=> Array
resp.thing_type_properties.searchable_attributes[0] #=> String
resp.thing_type_metadata.deprecated #=> Boolean
resp.thing_type_metadata.deprecation_date #=> Time
resp.thing_type_metadata.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_type_name (required, String) —
The name of the thing type.

Returns:

(Types::DescribeThingTypeResponse) —
Returns a response object which responds to the following methods:
- #thing_type_name => String
- #thing_type_id => String
- #thing_type_arn => String
- #thing_type_properties => Types::ThingTypeProperties
- #thing_type_metadata => Types::ThingTypeMetadata

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3258

def describe_thing_type(params = {}, options = {})
  req = build_request(:describe_thing_type, params)
  req.send_request(options)
end

#detach_policy(params = {}) ⇒ `Struct`

Detaches a policy from the specified target.

Examples:

Request syntax with placeholder values


resp = client.detach_policy({
  policy_name: "PolicyName", # required
  target: "PolicyTarget", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The policy to detach.
:target (required, String) —
The target from which the policy will be detached.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3282

def detach_policy(params = {}, options = {})
  req = build_request(:detach_policy, params)
  req.send_request(options)
end

#detach_principal_policy(params = {}) ⇒ `Struct`

Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

Examples:

Request syntax with placeholder values


resp = client.detach_principal_policy({
  policy_name: "PolicyName", # required
  principal: "Principal", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The name of the policy to detach.
:principal (required, String) —
The principal.

If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3311

def detach_principal_policy(params = {}, options = {})
  req = build_request(:detach_principal_policy, params)
  req.send_request(options)
end

#detach_security_profile(params = {}) ⇒ `Struct`

Disassociates a Device Defender security profile from a thing group or from this account.

Examples:

Request syntax with placeholder values


resp = client.detach_security_profile({
  security_profile_name: "SecurityProfileName", # required
  security_profile_target_arn: "SecurityProfileTargetArn", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:security_profile_name (required, String) —
The security profile that is detached.
:security_profile_target_arn (required, String) —
The ARN of the thing group from which the security profile is detached.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3337

def detach_security_profile(params = {}, options = {})
  req = build_request(:detach_security_profile, params)
  req.send_request(options)
end

#detach_thing_principal(params = {}) ⇒ `Struct`

Detaches the specified principal from the specified thing.

This call is asynchronous. It might take several seconds for the detachment to propagate.

Examples:

Request syntax with placeholder values


resp = client.detach_thing_principal({
  thing_name: "ThingName", # required
  principal: "Principal", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_name (required, String) —
The name of the thing.
:principal (required, String) —
If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3368

def detach_thing_principal(params = {}, options = {})
  req = build_request(:detach_thing_principal, params)
  req.send_request(options)
end

#disable_topic_rule(params = {}) ⇒ `Struct`

Disables the rule.

Examples:

Request syntax with placeholder values


resp = client.disable_topic_rule({
  rule_name: "RuleName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:rule_name (required, String) —
The name of the rule to disable.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3388

def disable_topic_rule(params = {}, options = {})
  req = build_request(:disable_topic_rule, params)
  req.send_request(options)
end

#enable_topic_rule(params = {}) ⇒ `Struct`

Enables the rule.

Examples:

Request syntax with placeholder values


resp = client.enable_topic_rule({
  rule_name: "RuleName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:rule_name (required, String) —
The name of the topic rule to enable.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3408

def enable_topic_rule(params = {}, options = {})
  req = build_request(:enable_topic_rule, params)
  req.send_request(options)
end

#get_effective_policies(params = {}) ⇒ `Types::GetEffectivePoliciesResponse`

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.

Examples:

Request syntax with placeholder values


resp = client.get_effective_policies({
  principal: "Principal",
  cognito_identity_pool_id: "CognitoIdentityPoolId",
  thing_name: "ThingName",
})

Response structure


resp.effective_policies #=> Array
resp.effective_policies[0].policy_name #=> String
resp.effective_policies[0].policy_arn #=> String
resp.effective_policies[0].policy_document #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:principal (String) —
The principal.
:cognito_identity_pool_id (String) —
The Cognito identity pool ID.
:thing_name (String) —
The thing name.

Returns:

(Types::GetEffectivePoliciesResponse) —
Returns a response object which responds to the following methods:
- #effective_policies => Array<Types::EffectivePolicy>

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3447

def get_effective_policies(params = {}, options = {})
  req = build_request(:get_effective_policies, params)
  req.send_request(options)
end

#get_indexing_configuration(params = {}) ⇒ `Types::GetIndexingConfigurationResponse`

Gets the search configuration.

Examples:

Response structure


resp.thing_indexing_configuration.thing_indexing_mode #=> String, one of "OFF", "REGISTRY", "REGISTRY_AND_SHADOW"
resp.thing_indexing_configuration.thing_connectivity_indexing_mode #=> String, one of "OFF", "STATUS"
resp.thing_group_indexing_configuration.thing_group_indexing_mode #=> String, one of "OFF", "ON"

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Types::GetIndexingConfigurationResponse) —
Returns a response object which responds to the following methods:
- #thing_indexing_configuration => Types::ThingIndexingConfiguration
- #thing_group_indexing_configuration => Types::ThingGroupIndexingConfiguration

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3467

def get_indexing_configuration(params = {}, options = {})
  req = build_request(:get_indexing_configuration, params)
  req.send_request(options)
end

#get_job_document(params = {}) ⇒ `Types::GetJobDocumentResponse`

Gets a job document.

Examples:

Request syntax with placeholder values


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

Response structure


resp.document #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
The unique identifier you assigned to this job when it was created.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3493

def get_job_document(params = {}, options = {})
  req = build_request(:get_job_document, params)
  req.send_request(options)
end

#get_logging_options(params = {}) ⇒ `Types::GetLoggingOptionsResponse`

Gets the logging options.

NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

Examples:

Response structure


resp.role_arn #=> String
resp.log_level #=> String, one of "DEBUG", "INFO", "ERROR", "WARN", "DISABLED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3515

def get_logging_options(params = {}, options = {})
  req = build_request(:get_logging_options, params)
  req.send_request(options)
end

#get_ota_update(params = {}) ⇒ `Types::GetOTAUpdateResponse`

Gets an OTA update.

Examples:

Request syntax with placeholder values


resp = client.get_ota_update({
  ota_update_id: "OTAUpdateId", # required
})

Response structure


resp.ota_update_info.ota_update_id #=> String
resp.ota_update_info.ota_update_arn #=> String
resp.ota_update_info.creation_date #=> Time
resp.ota_update_info.last_modified_date #=> Time
resp.ota_update_info.description #=> String
resp.ota_update_info.targets #=> Array
resp.ota_update_info.targets[0] #=> String
resp.ota_update_info.aws_job_executions_rollout_config.maximum_per_minute #=> Integer
resp.ota_update_info.target_selection #=> String, one of "CONTINUOUS", "SNAPSHOT"
resp.ota_update_info.ota_update_files #=> Array
resp.ota_update_info.ota_update_files[0].file_name #=> String
resp.ota_update_info.ota_update_files[0].file_version #=> String
resp.ota_update_info.ota_update_files[0].file_location.stream.stream_id #=> String
resp.ota_update_info.ota_update_files[0].file_location.stream.file_id #=> Integer
resp.ota_update_info.ota_update_files[0].file_location.s3_location.bucket #=> String
resp.ota_update_info.ota_update_files[0].file_location.s3_location.key #=> String
resp.ota_update_info.ota_update_files[0].file_location.s3_location.version #=> String
resp.ota_update_info.ota_update_files[0].code_signing.aws_signer_job_id #=> String
resp.ota_update_info.ota_update_files[0].code_signing.start_signing_job_parameter.signing_profile_parameter.certificate_arn #=> String
resp.ota_update_info.ota_update_files[0].code_signing.start_signing_job_parameter.signing_profile_parameter.platform #=> String
resp.ota_update_info.ota_update_files[0].code_signing.start_signing_job_parameter.signing_profile_parameter.certificate_path_on_device #=> String
resp.ota_update_info.ota_update_files[0].code_signing.start_signing_job_parameter.signing_profile_name #=> String
resp.ota_update_info.ota_update_files[0].code_signing.start_signing_job_parameter.destination.s3_destination.bucket #=> String
resp.ota_update_info.ota_update_files[0].code_signing.start_signing_job_parameter.destination.s3_destination.prefix #=> String
resp.ota_update_info.ota_update_files[0].code_signing.custom_code_signing.signature.inline_document #=> String
resp.ota_update_info.ota_update_files[0].code_signing.custom_code_signing.certificate_chain.certificate_name #=> String
resp.ota_update_info.ota_update_files[0].code_signing.custom_code_signing.certificate_chain.inline_document #=> String
resp.ota_update_info.ota_update_files[0].code_signing.custom_code_signing.hash_algorithm #=> String
resp.ota_update_info.ota_update_files[0].code_signing.custom_code_signing.signature_algorithm #=> String
resp.ota_update_info.ota_update_files[0].attributes #=> Hash
resp.ota_update_info.ota_update_files[0].attributes["AttributeKey"] #=> String
resp.ota_update_info.ota_update_status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED"
resp.ota_update_info.aws_iot_job_id #=> String
resp.ota_update_info.aws_iot_job_arn #=> String
resp.ota_update_info.error_info.code #=> String
resp.ota_update_info.error_info.message #=> String
resp.ota_update_info.additional_parameters #=> Hash
resp.ota_update_info.additional_parameters["AttributeKey"] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ota_update_id (required, String) —
The OTA update ID.

Returns:

(Types::GetOTAUpdateResponse) —
Returns a response object which responds to the following methods:
- #ota_update_info => Types::OTAUpdateInfo

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3578

def get_ota_update(params = {}, options = {})
  req = build_request(:get_ota_update, params)
  req.send_request(options)
end

#get_policy(params = {}) ⇒ `Types::GetPolicyResponse`

Gets information about the specified policy with the policy document of the default version.

Examples:

Request syntax with placeholder values


resp = client.get_policy({
  policy_name: "PolicyName", # required
})

Response structure


resp.policy_name #=> String
resp.policy_arn #=> String
resp.policy_document #=> String
resp.default_version_id #=> String
resp.creation_date #=> Time
resp.last_modified_date #=> Time
resp.generation_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The name of the policy.

Returns:

(Types::GetPolicyResponse) —
Returns a response object which responds to the following methods:
- #policy_name => String
- #policy_arn => String
- #policy_document => String
- #default_version_id => String
- #creation_date => Time
- #last_modified_date => Time
- #generation_id => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3617

def get_policy(params = {}, options = {})
  req = build_request(:get_policy, params)
  req.send_request(options)
end

#get_policy_version(params = {}) ⇒ `Types::GetPolicyVersionResponse`

Gets information about the specified policy version.

Examples:

Request syntax with placeholder values


resp = client.get_policy_version({
  policy_name: "PolicyName", # required
  policy_version_id: "PolicyVersionId", # required
})

Response structure


resp.policy_arn #=> String
resp.policy_name #=> String
resp.policy_document #=> String
resp.policy_version_id #=> String
resp.is_default_version #=> Boolean
resp.creation_date #=> Time
resp.last_modified_date #=> Time
resp.generation_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The name of the policy.
:policy_version_id (required, String) —
The policy version ID.

Returns:

(Types::GetPolicyVersionResponse) —
Returns a response object which responds to the following methods:
- #policy_arn => String
- #policy_name => String
- #policy_document => String
- #policy_version_id => String
- #is_default_version => Boolean
- #creation_date => Time
- #last_modified_date => Time
- #generation_id => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3661

def get_policy_version(params = {}, options = {})
  req = build_request(:get_policy_version, params)
  req.send_request(options)
end

#get_registration_code(params = {}) ⇒ `Types::GetRegistrationCodeResponse`

Gets a registration code used to register a CA certificate with AWS IoT.

Examples:

Response structure


resp.registration_code #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3679

def get_registration_code(params = {}, options = {})
  req = build_request(:get_registration_code, params)
  req.send_request(options)
end

#get_topic_rule(params = {}) ⇒ `Types::GetTopicRuleResponse`

Gets information about the rule.

Examples:

Request syntax with placeholder values


resp = client.get_topic_rule({
  rule_name: "RuleName", # required
})

Response structure


resp.rule_arn #=> String
resp.rule.rule_name #=> String
resp.rule.sql #=> String
resp.rule.description #=> String
resp.rule.created_at #=> Time
resp.rule.actions #=> Array
resp.rule.actions[0].dynamo_db.table_name #=> String
resp.rule.actions[0].dynamo_db.role_arn #=> String
resp.rule.actions[0].dynamo_db.operation #=> String
resp.rule.actions[0].dynamo_db.hash_key_field #=> String
resp.rule.actions[0].dynamo_db.hash_key_value #=> String
resp.rule.actions[0].dynamo_db.hash_key_type #=> String, one of "STRING", "NUMBER"
resp.rule.actions[0].dynamo_db.range_key_field #=> String
resp.rule.actions[0].dynamo_db.range_key_value #=> String
resp.rule.actions[0].dynamo_db.range_key_type #=> String, one of "STRING", "NUMBER"
resp.rule.actions[0].dynamo_db.payload_field #=> String
resp.rule.actions[0].dynamo_d_bv_2.role_arn #=> String
resp.rule.actions[0].dynamo_d_bv_2.put_item.table_name #=> String
resp.rule.actions[0].lambda.function_arn #=> String
resp.rule.actions[0].sns.target_arn #=> String
resp.rule.actions[0].sns.role_arn #=> String
resp.rule.actions[0].sns.message_format #=> String, one of "RAW", "JSON"
resp.rule.actions[0].sqs.role_arn #=> String
resp.rule.actions[0].sqs.queue_url #=> String
resp.rule.actions[0].sqs.use_base_64 #=> Boolean
resp.rule.actions[0].kinesis.role_arn #=> String
resp.rule.actions[0].kinesis.stream_name #=> String
resp.rule.actions[0].kinesis.partition_key #=> String
resp.rule.actions[0].republish.role_arn #=> String
resp.rule.actions[0].republish.topic #=> String
resp.rule.actions[0].s3.role_arn #=> String
resp.rule.actions[0].s3.bucket_name #=> String
resp.rule.actions[0].s3.key #=> String
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"
resp.rule.actions[0].firehose.role_arn #=> String
resp.rule.actions[0].firehose.delivery_stream_name #=> String
resp.rule.actions[0].firehose.separator #=> String
resp.rule.actions[0].cloudwatch_metric.role_arn #=> String
resp.rule.actions[0].cloudwatch_metric.metric_namespace #=> String
resp.rule.actions[0].cloudwatch_metric.metric_name #=> String
resp.rule.actions[0].cloudwatch_metric.metric_value #=> String
resp.rule.actions[0].cloudwatch_metric.metric_unit #=> String
resp.rule.actions[0].cloudwatch_metric.metric_timestamp #=> String
resp.rule.actions[0].cloudwatch_alarm.role_arn #=> String
resp.rule.actions[0].cloudwatch_alarm.alarm_name #=> String
resp.rule.actions[0].cloudwatch_alarm.state_reason #=> String
resp.rule.actions[0].cloudwatch_alarm.state_value #=> String
resp.rule.actions[0].elasticsearch.role_arn #=> String
resp.rule.actions[0].elasticsearch.endpoint #=> String
resp.rule.actions[0].elasticsearch.index #=> String
resp.rule.actions[0].elasticsearch.type #=> String
resp.rule.actions[0].elasticsearch.id #=> String
resp.rule.actions[0].salesforce.token #=> String
resp.rule.actions[0].salesforce.url #=> String
resp.rule.actions[0].iot_analytics.channel_arn #=> String
resp.rule.actions[0].iot_analytics.channel_name #=> String
resp.rule.actions[0].iot_analytics.role_arn #=> String
resp.rule.actions[0].iot_events.input_name #=> String
resp.rule.actions[0].iot_events.message_id #=> String
resp.rule.actions[0].iot_events.role_arn #=> String
resp.rule.actions[0].step_functions.execution_name_prefix #=> String
resp.rule.actions[0].step_functions.state_machine_name #=> String
resp.rule.actions[0].step_functions.role_arn #=> String
resp.rule.rule_disabled #=> Boolean
resp.rule.aws_iot_sql_version #=> String
resp.rule.error_action.dynamo_db.table_name #=> String
resp.rule.error_action.dynamo_db.role_arn #=> String
resp.rule.error_action.dynamo_db.operation #=> String
resp.rule.error_action.dynamo_db.hash_key_field #=> String
resp.rule.error_action.dynamo_db.hash_key_value #=> String
resp.rule.error_action.dynamo_db.hash_key_type #=> String, one of "STRING", "NUMBER"
resp.rule.error_action.dynamo_db.range_key_field #=> String
resp.rule.error_action.dynamo_db.range_key_value #=> String
resp.rule.error_action.dynamo_db.range_key_type #=> String, one of "STRING", "NUMBER"
resp.rule.error_action.dynamo_db.payload_field #=> String
resp.rule.error_action.dynamo_d_bv_2.role_arn #=> String
resp.rule.error_action.dynamo_d_bv_2.put_item.table_name #=> String
resp.rule.error_action.lambda.function_arn #=> String
resp.rule.error_action.sns.target_arn #=> String
resp.rule.error_action.sns.role_arn #=> String
resp.rule.error_action.sns.message_format #=> String, one of "RAW", "JSON"
resp.rule.error_action.sqs.role_arn #=> String
resp.rule.error_action.sqs.queue_url #=> String
resp.rule.error_action.sqs.use_base_64 #=> Boolean
resp.rule.error_action.kinesis.role_arn #=> String
resp.rule.error_action.kinesis.stream_name #=> String
resp.rule.error_action.kinesis.partition_key #=> String
resp.rule.error_action.republish.role_arn #=> String
resp.rule.error_action.republish.topic #=> String
resp.rule.error_action.s3.role_arn #=> String
resp.rule.error_action.s3.bucket_name #=> String
resp.rule.error_action.s3.key #=> String
resp.rule.error_action.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"
resp.rule.error_action.firehose.role_arn #=> String
resp.rule.error_action.firehose.delivery_stream_name #=> String
resp.rule.error_action.firehose.separator #=> String
resp.rule.error_action.cloudwatch_metric.role_arn #=> String
resp.rule.error_action.cloudwatch_metric.metric_namespace #=> String
resp.rule.error_action.cloudwatch_metric.metric_name #=> String
resp.rule.error_action.cloudwatch_metric.metric_value #=> String
resp.rule.error_action.cloudwatch_metric.metric_unit #=> String
resp.rule.error_action.cloudwatch_metric.metric_timestamp #=> String
resp.rule.error_action.cloudwatch_alarm.role_arn #=> String
resp.rule.error_action.cloudwatch_alarm.alarm_name #=> String
resp.rule.error_action.cloudwatch_alarm.state_reason #=> String
resp.rule.error_action.cloudwatch_alarm.state_value #=> String
resp.rule.error_action.elasticsearch.role_arn #=> String
resp.rule.error_action.elasticsearch.endpoint #=> String
resp.rule.error_action.elasticsearch.index #=> String
resp.rule.error_action.elasticsearch.type #=> String
resp.rule.error_action.elasticsearch.id #=> String
resp.rule.error_action.salesforce.token #=> String
resp.rule.error_action.salesforce.url #=> String
resp.rule.error_action.iot_analytics.channel_arn #=> String
resp.rule.error_action.iot_analytics.channel_name #=> String
resp.rule.error_action.iot_analytics.role_arn #=> String
resp.rule.error_action.iot_events.input_name #=> String
resp.rule.error_action.iot_events.message_id #=> String
resp.rule.error_action.iot_events.role_arn #=> String
resp.rule.error_action.step_functions.execution_name_prefix #=> String
resp.rule.error_action.step_functions.state_machine_name #=> String
resp.rule.error_action.step_functions.role_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:rule_name (required, String) —
The name of the rule.

Returns:

(Types::GetTopicRuleResponse) —
Returns a response object which responds to the following methods:
- #rule_arn => String
- #rule => Types::TopicRule

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3827

def get_topic_rule(params = {}, options = {})
  req = build_request(:get_topic_rule, params)
  req.send_request(options)
end

#get_v2_logging_options(params = {}) ⇒ `Types::GetV2LoggingOptionsResponse`

Gets the fine grained logging options.

Examples:

Response structure


resp.role_arn #=> String
resp.default_log_level #=> String, one of "DEBUG", "INFO", "ERROR", "WARN", "DISABLED"
resp.disable_all_logs #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Types::GetV2LoggingOptionsResponse) —
Returns a response object which responds to the following methods:
- #role_arn => String
- #default_log_level => String
- #disable_all_logs => Boolean

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3848

def get_v2_logging_options(params = {}, options = {})
  req = build_request(:get_v2_logging_options, params)
  req.send_request(options)
end

#list_active_violations(params = {}) ⇒ `Types::ListActiveViolationsResponse`

Lists the active violations for a given Device Defender security profile.

Examples:

Request syntax with placeholder values


resp = client.list_active_violations({
  thing_name: "ThingName",
  security_profile_name: "SecurityProfileName",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.active_violations #=> Array
resp.active_violations[0].violation_id #=> String
resp.active_violations[0].thing_name #=> String
resp.active_violations[0].security_profile_name #=> String
resp.active_violations[0].behavior.name #=> String
resp.active_violations[0].behavior.metric #=> String
resp.active_violations[0].behavior.criteria.comparison_operator #=> String, one of "less-than", "less-than-equals", "greater-than", "greater-than-equals", "in-cidr-set", "not-in-cidr-set", "in-port-set", "not-in-port-set"
resp.active_violations[0].behavior.criteria.value.count #=> Integer
resp.active_violations[0].behavior.criteria.value.cidrs #=> Array
resp.active_violations[0].behavior.criteria.value.cidrs[0] #=> String
resp.active_violations[0].behavior.criteria.value.ports #=> Array
resp.active_violations[0].behavior.criteria.value.ports[0] #=> Integer
resp.active_violations[0].behavior.criteria.duration_seconds #=> Integer
resp.active_violations[0].last_violation_value.count #=> Integer
resp.active_violations[0].last_violation_value.cidrs #=> Array
resp.active_violations[0].last_violation_value.cidrs[0] #=> String
resp.active_violations[0].last_violation_value.ports #=> Array
resp.active_violations[0].last_violation_value.ports[0] #=> Integer
resp.active_violations[0].last_violation_time #=> Time
resp.active_violations[0].violation_start_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_name (String) —
The name of the thing whose active violations are listed.
:security_profile_name (String) —
The name of the Device Defender security profile for which violations are listed.
:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time.

Returns:

(Types::ListActiveViolationsResponse) —
Returns a response object which responds to the following methods:
- #active_violations => Array<Types::ActiveViolation>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3909

def list_active_violations(params = {}, options = {})
  req = build_request(:list_active_violations, params)
  req.send_request(options)
end

#list_attached_policies(params = {}) ⇒ `Types::ListAttachedPoliciesResponse`

Lists the policies attached to the specified thing group.

Examples:

Request syntax with placeholder values


resp = client.list_attached_policies({
  target: "PolicyTarget", # required
  recursive: false,
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.policies #=> Array
resp.policies[0].policy_name #=> String
resp.policies[0].policy_arn #=> String
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:target (required, String) —
The group for which the policies will be listed.
:recursive (Boolean) —
When true, recursively list attached policies.
:marker (String) —
The token to retrieve the next set of results.
:page_size (Integer) —
The maximum number of results to be returned per request.

Returns:

(Types::ListAttachedPoliciesResponse) —
Returns a response object which responds to the following methods:
- #policies => Array<Types::Policy>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3951

def list_attached_policies(params = {}, options = {})
  req = build_request(:list_attached_policies, params)
  req.send_request(options)
end

#list_audit_findings(params = {}) ⇒ `Types::ListAuditFindingsResponse`

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)

Examples:

Request syntax with placeholder values


resp = client.list_audit_findings({
  task_id: "AuditTaskId",
  check_name: "AuditCheckName",
  resource_identifier: {
    device_certificate_id: "CertificateId",
    ca_certificate_id: "CertificateId",
    cognito_identity_pool_id: "CognitoIdentityPoolId",
    client_id: "ClientId",
    policy_version_identifier: {
      policy_name: "PolicyName",
      policy_version_id: "PolicyVersionId",
    },
    account: "AwsAccountId",
  },
  max_results: 1,
  next_token: "NextToken",
  start_time: Time.now,
  end_time: Time.now,
})

Response structure


resp.findings #=> Array
resp.findings[0].task_id #=> String
resp.findings[0].check_name #=> String
resp.findings[0].task_start_time #=> Time
resp.findings[0].finding_time #=> Time
resp.findings[0].severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW"
resp.findings[0].non_compliant_resource.resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS"
resp.findings[0].non_compliant_resource.resource_identifier.device_certificate_id #=> String
resp.findings[0].non_compliant_resource.resource_identifier.ca_certificate_id #=> String
resp.findings[0].non_compliant_resource.resource_identifier.cognito_identity_pool_id #=> String
resp.findings[0].non_compliant_resource.resource_identifier.client_id #=> String
resp.findings[0].non_compliant_resource.resource_identifier.policy_version_identifier.policy_name #=> String
resp.findings[0].non_compliant_resource.resource_identifier.policy_version_identifier.policy_version_id #=> String
resp.findings[0].non_compliant_resource.resource_identifier.account #=> String
resp.findings[0].non_compliant_resource.additional_info #=> Hash
resp.findings[0].non_compliant_resource.additional_info["String"] #=> String
resp.findings[0].related_resources #=> Array
resp.findings[0].related_resources[0].resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS"
resp.findings[0].related_resources[0].resource_identifier.device_certificate_id #=> String
resp.findings[0].related_resources[0].resource_identifier.ca_certificate_id #=> String
resp.findings[0].related_resources[0].resource_identifier.cognito_identity_pool_id #=> String
resp.findings[0].related_resources[0].resource_identifier.client_id #=> String
resp.findings[0].related_resources[0].resource_identifier.policy_version_identifier.policy_name #=> String
resp.findings[0].related_resources[0].resource_identifier.policy_version_identifier.policy_version_id #=> String
resp.findings[0].related_resources[0].resource_identifier.account #=> String
resp.findings[0].related_resources[0].additional_info #=> Hash
resp.findings[0].related_resources[0].additional_info["String"] #=> String
resp.findings[0].reason_for_non_compliance #=> String
resp.findings[0].reason_for_non_compliance_code #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:task_id (String) —
A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.
:check_name (String) —
A filter to limit results to the findings for the specified audit check.
:resource_identifier (Types::ResourceIdentifier) —
Information identifying the non-compliant resource.
:max_results (Integer) —
The maximum number of results to return at one time. The default is 25.
:next_token (String) —
The token for the next set of results.
:start_time (Time, DateTime, Date, Integer, String) —
A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
:end_time (Time, DateTime, Date, Integer, String) —
A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.

Returns:

(Types::ListAuditFindingsResponse) —
Returns a response object which responds to the following methods:
- #findings => Array<Types::AuditFinding>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4050

def list_audit_findings(params = {}, options = {})
  req = build_request(:list_audit_findings, params)
  req.send_request(options)
end

#list_audit_tasks(params = {}) ⇒ `Types::ListAuditTasksResponse`

Lists the Device Defender audits that have been performed during a given time period.

Examples:

Request syntax with placeholder values


resp = client.list_audit_tasks({
  start_time: Time.now, # required
  end_time: Time.now, # required
  task_type: "ON_DEMAND_AUDIT_TASK", # accepts ON_DEMAND_AUDIT_TASK, SCHEDULED_AUDIT_TASK
  task_status: "IN_PROGRESS", # accepts IN_PROGRESS, COMPLETED, FAILED, CANCELED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.tasks #=> Array
resp.tasks[0].task_id #=> String
resp.tasks[0].task_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELED"
resp.tasks[0].task_type #=> String, one of "ON_DEMAND_AUDIT_TASK", "SCHEDULED_AUDIT_TASK"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:start_time (required, Time, DateTime, Date, Integer, String) —
The beginning of the time period. Note that audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
:end_time (required, Time, DateTime, Date, Integer, String) —
The end of the time period.
:task_type (String) —
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
:task_status (String) —
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED" or "CANCELED".
:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time. The default is 25.

Returns:

(Types::ListAuditTasksResponse) —
Returns a response object which responds to the following methods:
- #tasks => Array<Types::AuditTaskMetadata>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4108

def list_audit_tasks(params = {}, options = {})
  req = build_request(:list_audit_tasks, params)
  req.send_request(options)
end

#list_authorizers(params = {}) ⇒ `Types::ListAuthorizersResponse`

Lists the authorizers registered in your account.

Examples:

Request syntax with placeholder values


resp = client.list_authorizers({
  page_size: 1,
  marker: "Marker",
  ascending_order: false,
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
})

Response structure


resp.authorizers #=> Array
resp.authorizers[0].authorizer_name #=> String
resp.authorizers[0].authorizer_arn #=> String
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:page_size (Integer) —
The maximum number of results to return at one time.
:marker (String) —
A marker used to get the next set of results.
:ascending_order (Boolean) —
Return the list of authorizers in ascending alphabetical order.
:status (String) —
The status of the list authorizers request.

Returns:

(Types::ListAuthorizersResponse) —
Returns a response object which responds to the following methods:
- #authorizers => Array<Types::AuthorizerSummary>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4150

def list_authorizers(params = {}, options = {})
  req = build_request(:list_authorizers, params)
  req.send_request(options)
end

#list_billing_groups(params = {}) ⇒ `Types::ListBillingGroupsResponse`

Lists the billing groups you have created.

Examples:

Request syntax with placeholder values


resp = client.list_billing_groups({
  next_token: "NextToken",
  max_results: 1,
  name_prefix_filter: "BillingGroupName",
})

Response structure


resp.billing_groups #=> Array
resp.billing_groups[0].group_name #=> String
resp.billing_groups[0].group_arn #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
The token to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return per request.
:name_prefix_filter (String) —
Limit the results to billing groups whose names have the given prefix.

Returns:

(Types::ListBillingGroupsResponse) —
Returns a response object which responds to the following methods:
- #billing_groups => Array<Types::GroupNameAndArn>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4188

def list_billing_groups(params = {}, options = {})
  req = build_request(:list_billing_groups, params)
  req.send_request(options)
end

#list_ca_certificates(params = {}) ⇒ `Types::ListCACertificatesResponse`

Lists the CA certificates registered for your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Examples:

Request syntax with placeholder values


resp = client.list_ca_certificates({
  page_size: 1,
  marker: "Marker",
  ascending_order: false,
})

Response structure


resp.certificates #=> Array
resp.certificates[0].certificate_arn #=> String
resp.certificates[0].certificate_id #=> String
resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.certificates[0].creation_date #=> Time
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:page_size (Integer) —
The result page size.
:marker (String) —
The marker for the next set of results.
:ascending_order (Boolean) —
Determines the order of the results.

Returns:

(Types::ListCACertificatesResponse) —
Returns a response object which responds to the following methods:
- #certificates => Array<Types::CACertificate>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4231

def list_ca_certificates(params = {}, options = {})
  req = build_request(:list_ca_certificates, params)
  req.send_request(options)
end

#list_certificates(params = {}) ⇒ `Types::ListCertificatesResponse`

Lists the certificates registered in your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Examples:

Request syntax with placeholder values


resp = client.list_certificates({
  page_size: 1,
  marker: "Marker",
  ascending_order: false,
})

Response structure


resp.certificates #=> Array
resp.certificates[0].certificate_arn #=> String
resp.certificates[0].certificate_id #=> String
resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
resp.certificates[0].creation_date #=> Time
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:page_size (Integer) —
The result page size.
:marker (String) —
The marker for the next set of results.
:ascending_order (Boolean) —
Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

Returns:

(Types::ListCertificatesResponse) —
Returns a response object which responds to the following methods:
- #certificates => Array<Types::Certificate>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4275

def list_certificates(params = {}, options = {})
  req = build_request(:list_certificates, params)
  req.send_request(options)
end

#list_certificates_by_ca(params = {}) ⇒ `Types::ListCertificatesByCAResponse`

List the device certificates signed by the specified CA certificate.

Examples:

Request syntax with placeholder values


resp = client.list_certificates_by_ca({
  ca_certificate_id: "CertificateId", # required
  page_size: 1,
  marker: "Marker",
  ascending_order: false,
})

Response structure


resp.certificates #=> Array
resp.certificates[0].certificate_arn #=> String
resp.certificates[0].certificate_id #=> String
resp.certificates[0].status #=> String, one of "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION"
resp.certificates[0].creation_date #=> Time
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ca_certificate_id (required, String) —
The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
:page_size (Integer) —
The result page size.
:marker (String) —
The marker for the next set of results.
:ascending_order (Boolean) —
Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

Returns:

(Types::ListCertificatesByCAResponse) —
Returns a response object which responds to the following methods:
- #certificates => Array<Types::Certificate>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4321

def list_certificates_by_ca(params = {}, options = {})
  req = build_request(:list_certificates_by_ca, params)
  req.send_request(options)
end

#list_indices(params = {}) ⇒ `Types::ListIndicesResponse`

Lists the search indices.

Examples:

Request syntax with placeholder values


resp = client.list_indices({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.index_names #=> Array
resp.index_names[0] #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
The token used to get the next set of results, or null if there are no additional results.
:max_results (Integer) —
The maximum number of results to return at one time.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4355

def list_indices(params = {}, options = {})
  req = build_request(:list_indices, params)
  req.send_request(options)
end

#list_job_executions_for_job(params = {}) ⇒ `Types::ListJobExecutionsForJobResponse`

Lists the job executions for a job.

Examples:

Request syntax with placeholder values


resp = client.list_job_executions_for_job({
  job_id: "JobId", # required
  status: "QUEUED", # accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.execution_summaries #=> Array
resp.execution_summaries[0].thing_arn #=> String
resp.execution_summaries[0].job_execution_summary.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "REJECTED", "REMOVED", "CANCELED"
resp.execution_summaries[0].job_execution_summary.queued_at #=> Time
resp.execution_summaries[0].job_execution_summary.started_at #=> Time
resp.execution_summaries[0].job_execution_summary.last_updated_at #=> Time
resp.execution_summaries[0].job_execution_summary.execution_number #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:job_id (required, String) —
The unique identifier you assigned to this job when it was created.
:status (String) —
The status of the job.
:max_results (Integer) —
The maximum number of results to be returned per request.
:next_token (String) —
The token to retrieve the next set of results.

Returns:

(Types::ListJobExecutionsForJobResponse) —
Returns a response object which responds to the following methods:
- #execution_summaries => Array<Types::JobExecutionSummaryForJob>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4401

def list_job_executions_for_job(params = {}, options = {})
  req = build_request(:list_job_executions_for_job, params)
  req.send_request(options)
end

#list_job_executions_for_thing(params = {}) ⇒ `Types::ListJobExecutionsForThingResponse`

Lists the job executions for the specified thing.

Examples:

Request syntax with placeholder values


resp = client.list_job_executions_for_thing({
  thing_name: "ThingName", # required
  status: "QUEUED", # accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.execution_summaries #=> Array
resp.execution_summaries[0].job_id #=> String
resp.execution_summaries[0].job_execution_summary.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "REJECTED", "REMOVED", "CANCELED"
resp.execution_summaries[0].job_execution_summary.queued_at #=> Time
resp.execution_summaries[0].job_execution_summary.started_at #=> Time
resp.execution_summaries[0].job_execution_summary.last_updated_at #=> Time
resp.execution_summaries[0].job_execution_summary.execution_number #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:thing_name (required, String) —
The thing name.
:status (String) —
An optional filter that lets you search for jobs that have the specified status.
:max_results (Integer) —
The maximum number of results to be returned per request.
:next_token (String) —
The token to retrieve the next set of results.

Returns:

(Types::ListJobExecutionsForThingResponse) —
Returns a response object which responds to the following methods:
- #execution_summaries => Array<Types::JobExecutionSummaryForThing>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4448

def list_job_executions_for_thing(params = {}, options = {})
  req = build_request(:list_job_executions_for_thing, params)
  req.send_request(options)
end

#list_jobs(params = {}) ⇒ `Types::ListJobsResponse`

Lists jobs.

Examples:

Request syntax with placeholder values


resp = client.list_jobs({
  status: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS
  target_selection: "CONTINUOUS", # accepts CONTINUOUS, SNAPSHOT
  max_results: 1,
  next_token: "NextToken",
  thing_group_name: "ThingGroupName",
  thing_group_id: "ThingGroupId",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].job_arn #=> String
resp.jobs[0].job_id #=> String
resp.jobs[0].thing_group_id #=> String
resp.jobs[0].target_selection #=> String, one of "CONTINUOUS", "SNAPSHOT"
resp.jobs[0].status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS"
resp.jobs[0].created_at #=> Time
resp.jobs[0].last_updated_at #=> Time
resp.jobs[0].completed_at #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:status (String) —
An optional filter that lets you search for jobs that have the specified status.
:target_selection (String) —
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
:max_results (Integer) —
The maximum number of results to return per request.
:next_token (String) —
The token to retrieve the next set of results.
:thing_group_name (String) —
A filter that limits the returned jobs to those for the specified group.
:thing_group_id (String) —
A filter that limits the returned jobs to those for the specified group.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4512

def list_jobs(params = {}, options = {})
  req = build_request(:list_jobs, params)
  req.send_request(options)
end

#list_ota_updates(params = {}) ⇒ `Types::ListOTAUpdatesResponse`

Lists OTA updates.

Examples:

Request syntax with placeholder values


resp = client.list_ota_updates({
  max_results: 1,
  next_token: "NextToken",
  ota_update_status: "CREATE_PENDING", # accepts CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED
})

Response structure


resp.ota_updates #=> Array
resp.ota_updates[0].ota_update_id #=> String
resp.ota_updates[0].ota_update_arn #=> String
resp.ota_updates[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:max_results (Integer) —
The maximum number of results to return at one time.
:next_token (String) —
A token used to retrieve the next set of results.
:ota_update_status (String) —
The OTA update job status.

Returns:

(Types::ListOTAUpdatesResponse) —
Returns a response object which responds to the following methods:
- #ota_updates => Array<Types::OTAUpdateSummary>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4551

def list_ota_updates(params = {}, options = {})
  req = build_request(:list_ota_updates, params)
  req.send_request(options)
end

#list_outgoing_certificates(params = {}) ⇒ `Types::ListOutgoingCertificatesResponse`

Lists certificates that are being transferred but not yet accepted.

Examples:

Request syntax with placeholder values


resp = client.list_outgoing_certificates({
  page_size: 1,
  marker: "Marker",
  ascending_order: false,
})

Response structure


resp.outgoing_certificates #=> Array
resp.outgoing_certificates[0].certificate_arn #=> String
resp.outgoing_certificates[0].certificate_id #=> String
resp.outgoing_certificates[0].transferred_to #=> String
resp.outgoing_certificates[0].transfer_date #=> Time
resp.outgoing_certificates[0].transfer_message #=> String
resp.outgoing_certificates[0].creation_date #=> Time
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:page_size (Integer) —
The result page size.
:marker (String) —
The marker for the next set of results.
:ascending_order (Boolean) —
Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

Returns:

(Types::ListOutgoingCertificatesResponse) —
Returns a response object which responds to the following methods:
- #outgoing_certificates => Array<Types::OutgoingCertificate>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4594

def list_outgoing_certificates(params = {}, options = {})
  req = build_request(:list_outgoing_certificates, params)
  req.send_request(options)
end

#list_policies(params = {}) ⇒ `Types::ListPoliciesResponse`

Lists your policies.

Examples:

Request syntax with placeholder values


resp = client.list_policies({
  marker: "Marker",
  page_size: 1,
  ascending_order: false,
})

Response structure


resp.policies #=> Array
resp.policies[0].policy_name #=> String
resp.policies[0].policy_arn #=> String
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:marker (String) —
The marker for the next set of results.
:page_size (Integer) —
The result page size.
:ascending_order (Boolean) —
Specifies the order for results. If true, the results are returned in ascending creation order.

Returns:

(Types::ListPoliciesResponse) —
Returns a response object which responds to the following methods:
- #policies => Array<Types::Policy>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4633

def list_policies(params = {}, options = {})
  req = build_request(:list_policies, params)
  req.send_request(options)
end

#list_policy_principals(params = {}) ⇒ `Types::ListPolicyPrincipalsResponse`

Lists the principals associated with the specified policy.

Note: This API is deprecated. Please use ListTargetsForPolicy instead.

Examples:

Request syntax with placeholder values


resp = client.list_policy_principals({
  policy_name: "PolicyName", # required
  marker: "Marker",
  page_size: 1,
  ascending_order: false,
})

Response structure


resp.principals #=> Array
resp.principals[0] #=> String
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The policy name.
:marker (String) —
The marker for the next set of results.
:page_size (Integer) —
The result page size.
:ascending_order (Boolean) —
Specifies the order for results. If true, the results are returned in ascending creation order.

Returns:

(Types::ListPolicyPrincipalsResponse) —
Returns a response object which responds to the following methods:
- #principals => Array<String>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4678

def list_policy_principals(params = {}, options = {})
  req = build_request(:list_policy_principals, params)
  req.send_request(options)
end

#list_policy_versions(params = {}) ⇒ `Types::ListPolicyVersionsResponse`

Lists the versions of the specified policy and identifies the default version.

Examples:

Request syntax with placeholder values


resp = client.list_policy_versions({
  policy_name: "PolicyName", # required
})

Response structure


resp.policy_versions #=> Array
resp.policy_versions[0].version_id #=> String
resp.policy_versions[0].is_default_version #=> Boolean
resp.policy_versions[0].create_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The policy name.

Returns:

(Types::ListPolicyVersionsResponse) —
Returns a response object which responds to the following methods:
- #policy_versions => Array<Types::PolicyVersion>

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4708

def list_policy_versions(params = {}, options = {})
  req = build_request(:list_policy_versions, params)
  req.send_request(options)
end

#list_principal_policies(params = {}) ⇒ `Types::ListPrincipalPoliciesResponse`

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

Note: This API is deprecated. Please use ListAttachedPolicies instead.

Examples:

Request syntax with placeholder values


resp = client.list_principal_policies({
  principal: "Principal", # required
  marker: "Marker",
  page_size: 1,
  ascending_order: false,
})

Response structure


resp.policies #=> Array
resp.policies[0].policy_name #=> String
resp.policies[0].policy_arn #=> String
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:principal (required, String) —
The principal.
:marker (String) —
The marker for the next set of results.
:page_size (Integer) —
The result page size.
:ascending_order (Boolean) —
Specifies the order for results. If true, results are returned in ascending creation order.

Returns:

(Types::ListPrincipalPoliciesResponse) —
Returns a response object which responds to the following methods:
- #policies => Array<Types::Policy>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4760

def list_principal_policies(params = {}, options = {})
  req = build_request(:list_principal_policies, params)
  req.send_request(options)
end

#list_principal_things(params = {}) ⇒ `Types::ListPrincipalThingsResponse`

Lists the things associated with the specified principal.

Examples:

Request syntax with placeholder values


resp = client.list_principal_things({
  next_token: "NextToken",
  max_results: 1,
  principal: "Principal", # required
})

Response structure


resp.things #=> Array
resp.things[0] #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
The token to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return in this operation.
:principal (required, String) —
The principal.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4797

def list_principal_things(params = {}, options = {})
  req = build_request(:list_principal_things, params)
  req.send_request(options)
end

#list_role_aliases(params = {}) ⇒ `Types::ListRoleAliasesResponse`

Lists the role aliases registered in your account.

Examples:

Request syntax with placeholder values


resp = client.list_role_aliases({
  page_size: 1,
  marker: "Marker",
  ascending_order: false,
})

Response structure


resp.role_aliases #=> Array
resp.role_aliases[0] #=> String
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:page_size (Integer) —
The maximum number of results to return at one time.
:marker (String) —
A marker used to get the next set of results.
:ascending_order (Boolean) —
Return the list of role aliases in ascending alphabetical order.

Returns:

(Types::ListRoleAliasesResponse) —
Returns a response object which responds to the following methods:
- #role_aliases => Array<String>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4834

def list_role_aliases(params = {}, options = {})
  req = build_request(:list_role_aliases, params)
  req.send_request(options)
end

#list_scheduled_audits(params = {}) ⇒ `Types::ListScheduledAuditsResponse`

Lists all of your scheduled audits.

Examples:

Request syntax with placeholder values


resp = client.list_scheduled_audits({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.scheduled_audits #=> Array
resp.scheduled_audits[0].scheduled_audit_name #=> String
resp.scheduled_audits[0].scheduled_audit_arn #=> String
resp.scheduled_audits[0].frequency #=> String, one of "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY"
resp.scheduled_audits[0].day_of_month #=> String
resp.scheduled_audits[0].day_of_week #=> String, one of "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time. The default is 25.

Returns:

(Types::ListScheduledAuditsResponse) —
Returns a response object which responds to the following methods:
- #scheduled_audits => Array<Types::ScheduledAuditMetadata>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4872

def list_scheduled_audits(params = {}, options = {})
  req = build_request(:list_scheduled_audits, params)
  req.send_request(options)
end

#list_security_profiles(params = {}) ⇒ `Types::ListSecurityProfilesResponse`

Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.

Examples:

Request syntax with placeholder values


resp = client.list_security_profiles({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.security_profile_identifiers #=> Array
resp.security_profile_identifiers[0].name #=> String
resp.security_profile_identifiers[0].arn #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time.

Returns:

(Types::ListSecurityProfilesResponse) —
Returns a response object which responds to the following methods:
- #security_profile_identifiers => Array<Types::SecurityProfileIdentifier>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4908

def list_security_profiles(params = {}, options = {})
  req = build_request(:list_security_profiles, params)
  req.send_request(options)
end

#list_security_profiles_for_target(params = {}) ⇒ `Types::ListSecurityProfilesForTargetResponse`

Lists the Device Defender security profiles attached to a target (thing group).

Examples:

Request syntax with placeholder values


resp = client.list_security_profiles_for_target({
  next_token: "NextToken",
  max_results: 1,
  recursive: false,
  security_profile_target_arn: "SecurityProfileTargetArn", # required
})

Response structure


resp.security_profile_target_mappings #=> Array
resp.security_profile_target_mappings[0].security_profile_identifier.name #=> String
resp.security_profile_target_mappings[0].security_profile_identifier.arn #=> String
resp.security_profile_target_mappings[0].target.arn #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time.
:recursive (Boolean) —
If true, return child groups as well.
:security_profile_target_arn (required, String) —
The ARN of the target (thing group) whose attached security profiles you want to get.

Returns:

(Types::ListSecurityProfilesForTargetResponse) —
Returns a response object which responds to the following methods:
- #security_profile_target_mappings => Array<Types::SecurityProfileTargetMapping>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4953

def list_security_profiles_for_target(params = {}, options = {})
  req = build_request(:list_security_profiles_for_target, params)
  req.send_request(options)
end

#list_streams(params = {}) ⇒ `Types::ListStreamsResponse`

Lists all of the streams in your AWS account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.streams #=> Array
resp.streams[0].stream_id #=> String
resp.streams[0].stream_arn #=> String
resp.streams[0].stream_version #=> Integer
resp.streams[0].description #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:max_results (Integer) —
The maximum number of results to return at a time.
:next_token (String) —
A token used to get the next set of results.
:ascending_order (Boolean) —
Set to true to return the list of streams in ascending order.

Returns:

(Types::ListStreamsResponse) —
Returns a response object which responds to the following methods:
- #streams => Array<Types::StreamSummary>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4993

def list_streams(params = {}, options = {})
  req = build_request(:list_streams, params)
  req.send_request(options)
end

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

Lists the tags (metadata) you have assigned to the resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
  next_token: "NextToken",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The ARN of the resource.
:next_token (String) —
The token to retrieve the next set of results.

Returns:

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

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5027

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_targets_for_policy(params = {}) ⇒ `Types::ListTargetsForPolicyResponse`

List targets for the specified policy.

Examples:

Request syntax with placeholder values


resp = client.list_targets_for_policy({
  policy_name: "PolicyName", # required
  marker: "Marker",
  page_size: 1,
})

Response structure


resp.targets #=> Array
resp.targets[0] #=> String
resp.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:policy_name (required, String) —
The policy name.
:marker (String) —
A marker used to get the next set of results.
:page_size (Integer) —
The maximum number of results to return at one time.

Returns:

(Types::ListTargetsForPolicyResponse) —
Returns a response object which responds to the following methods:
- #targets => Array<String>
- #next_marker => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5064

def list_targets_for_policy(params = {}, options = {})
  req = build_request(:list_targets_for_policy, params)
  req.send_request(options)
end

#list_targets_for_security_profile(params = {}) ⇒ `Types::ListTargetsForSecurityProfileResponse`

Lists the targets (thing groups) associated with a given Device Defender security profile.

Examples:

Request syntax with placeholder values


resp = client.list_targets_for_security_profile({
  security_profile_name: "SecurityProfileName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.security_profile_targets #=> Array
resp.security_profile_targets[0].arn #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:security_profile_name (required, String) —
The security profile.
:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time.

Returns:

(Types::ListTargetsForSecurityProfileResponse) —
Returns a response object which responds to the following methods:
- #security_profile_targets => Array<Types::SecurityProfileTarget>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5102

def list_targets_for_security_profile(params = {}, options = {})
  req = build_request(:list_targets_for_security_profile, params)
  req.send_request(options)
end

#list_thing_groups(params = {}) ⇒ `Types::ListThingGroupsResponse`

List the thing groups in your account.

Examples:

Request syntax with placeholder values


resp = client.list_thing_groups({
  next_token: "NextToken",
  max_results: 1,
  parent_group: "ThingGroupName",
  name_prefix_filter: "ThingGroupName",
  recursive: false,
})

Response structure


resp.thing_groups #=> Array
resp.thing_groups[0].group_name #=> String
resp.thing_groups[0].group_arn #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
The token to retrieve the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time.
:parent_group (String) —
A filter that limits the results to those with the specified parent group.
:name_prefix_filter (String) —
A filter that limits the results to those with the specified name prefix.
:recursive (Boolean) —
If true, return child groups as well.

Returns:

(Types::ListThingGroupsResponse) —
Returns a response object which responds to the following methods:
- #thing_groups => Array<Types::GroupNameAndArn>
- #next_token => String

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5150

def list_thing_groups(params = {}, options = {})
  req = build_request(:list_thing_groups, params)
  req.send_request(options)
end

#list_thing_groups_for_thing(params = {}) ⇒ `Types::ListThingGroupsForThingResponse`

List the thing groups to which the specified thing belongs.

Examples:

Request syntax with placeholder values


resp = client.list_thing_groups_for_thing({
  thing_name: "ThingName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.thing_groups #=> Array
resp

Class: Aws::IoT::Client

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options) ⇒ Client

Instance Method Details

#accept_certificate_transfer(params = {}) ⇒ Struct

#add_thing_to_billing_group(params = {}) ⇒ Struct

#add_thing_to_thing_group(params = {}) ⇒ Struct

#associate_targets_with_job(params = {}) ⇒ Types::AssociateTargetsWithJobResponse

#attach_policy(params = {}) ⇒ Struct

#attach_principal_policy(params = {}) ⇒ Struct

#attach_security_profile(params = {}) ⇒ Struct

#attach_thing_principal(params = {}) ⇒ Struct

#cancel_audit_task(params = {}) ⇒ Struct

#cancel_certificate_transfer(params = {}) ⇒ Struct

#cancel_job(params = {}) ⇒ Types::CancelJobResponse

#cancel_job_execution(params = {}) ⇒ Struct

#clear_default_authorizer(params = {}) ⇒ Struct

#create_authorizer(params = {}) ⇒ Types::CreateAuthorizerResponse

#create_billing_group(params = {}) ⇒ Types::CreateBillingGroupResponse

#create_certificate_from_csr(params = {}) ⇒ Types::CreateCertificateFromCsrResponse

#create_dynamic_thing_group(params = {}) ⇒ Types::CreateDynamicThingGroupResponse

#create_job(params = {}) ⇒ Types::CreateJobResponse

#create_keys_and_certificate(params = {}) ⇒ Types::CreateKeysAndCertificateResponse

#create_ota_update(params = {}) ⇒ Types::CreateOTAUpdateResponse

#create_policy(params = {}) ⇒ Types::CreatePolicyResponse

#create_policy_version(params = {}) ⇒ Types::CreatePolicyVersionResponse

#create_role_alias(params = {}) ⇒ Types::CreateRoleAliasResponse

#create_scheduled_audit(params = {}) ⇒ Types::CreateScheduledAuditResponse

#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse

#create_stream(params = {}) ⇒ Types::CreateStreamResponse

#create_thing(params = {}) ⇒ Types::CreateThingResponse

#create_thing_group(params = {}) ⇒ Types::CreateThingGroupResponse

#create_thing_type(params = {}) ⇒ Types::CreateThingTypeResponse

#create_topic_rule(params = {}) ⇒ Struct

#delete_account_audit_configuration(params = {}) ⇒ Struct

#delete_authorizer(params = {}) ⇒ Struct

#delete_billing_group(params = {}) ⇒ Struct

#delete_ca_certificate(params = {}) ⇒ Struct

#delete_certificate(params = {}) ⇒ Struct

#delete_dynamic_thing_group(params = {}) ⇒ Struct

#delete_job(params = {}) ⇒ Struct

#delete_job_execution(params = {}) ⇒ Struct

#delete_ota_update(params = {}) ⇒ Struct

#delete_policy(params = {}) ⇒ Struct

#delete_policy_version(params = {}) ⇒ Struct

#delete_registration_code(params = {}) ⇒ Struct

#delete_role_alias(params = {}) ⇒ Struct

#delete_scheduled_audit(params = {}) ⇒ Struct

#delete_security_profile(params = {}) ⇒ Struct

#delete_stream(params = {}) ⇒ Struct

#delete_thing(params = {}) ⇒ Struct

#delete_thing_group(params = {}) ⇒ Struct

#delete_thing_type(params = {}) ⇒ Struct

#delete_topic_rule(params = {}) ⇒ Struct

#delete_v2_logging_level(params = {}) ⇒ Struct

#deprecate_thing_type(params = {}) ⇒ Struct

#describe_account_audit_configuration(params = {}) ⇒ Types::DescribeAccountAuditConfigurationResponse

#describe_audit_task(params = {}) ⇒ Types::DescribeAuditTaskResponse

#describe_authorizer(params = {}) ⇒ Types::DescribeAuthorizerResponse

#describe_billing_group(params = {}) ⇒ Types::DescribeBillingGroupResponse

#describe_ca_certificate(params = {}) ⇒ Types::DescribeCACertificateResponse

#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResponse

#describe_default_authorizer(params = {}) ⇒ Types::DescribeDefaultAuthorizerResponse

#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse

#describe_event_configurations(params = {}) ⇒ Types::DescribeEventConfigurationsResponse

#describe_index(params = {}) ⇒ Types::DescribeIndexResponse

#describe_job(params = {}) ⇒ Types::DescribeJobResponse

#describe_job_execution(params = {}) ⇒ Types::DescribeJobExecutionResponse

#describe_role_alias(params = {}) ⇒ Types::DescribeRoleAliasResponse

#describe_scheduled_audit(params = {}) ⇒ Types::DescribeScheduledAuditResponse

#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse

#describe_stream(params = {}) ⇒ Types::DescribeStreamResponse

#describe_thing(params = {}) ⇒ Types::DescribeThingResponse

#initialize(options) ⇒ `Client`

#accept_certificate_transfer(params = {}) ⇒ `Struct`

#add_thing_to_billing_group(params = {}) ⇒ `Struct`

#add_thing_to_thing_group(params = {}) ⇒ `Struct`

#associate_targets_with_job(params = {}) ⇒ `Types::AssociateTargetsWithJobResponse`

#attach_policy(params = {}) ⇒ `Struct`

#attach_principal_policy(params = {}) ⇒ `Struct`

#attach_security_profile(params = {}) ⇒ `Struct`

#attach_thing_principal(params = {}) ⇒ `Struct`

#cancel_audit_task(params = {}) ⇒ `Struct`

#cancel_certificate_transfer(params = {}) ⇒ `Struct`

#cancel_job(params = {}) ⇒ `Types::CancelJobResponse`

#cancel_job_execution(params = {}) ⇒ `Struct`

#clear_default_authorizer(params = {}) ⇒ `Struct`

#create_authorizer(params = {}) ⇒ `Types::CreateAuthorizerResponse`

#create_billing_group(params = {}) ⇒ `Types::CreateBillingGroupResponse`

#create_certificate_from_csr(params = {}) ⇒ `Types::CreateCertificateFromCsrResponse`

#create_dynamic_thing_group(params = {}) ⇒ `Types::CreateDynamicThingGroupResponse`

#create_job(params = {}) ⇒ `Types::CreateJobResponse`

#create_keys_and_certificate(params = {}) ⇒ `Types::CreateKeysAndCertificateResponse`

#create_ota_update(params = {}) ⇒ `Types::CreateOTAUpdateResponse`

#create_policy(params = {}) ⇒ `Types::CreatePolicyResponse`

#create_policy_version(params = {}) ⇒ `Types::CreatePolicyVersionResponse`

#create_role_alias(params = {}) ⇒ `Types::CreateRoleAliasResponse`

#create_scheduled_audit(params = {}) ⇒ `Types::CreateScheduledAuditResponse`

#create_security_profile(params = {}) ⇒ `Types::CreateSecurityProfileResponse`

#create_stream(params = {}) ⇒ `Types::CreateStreamResponse`

#create_thing(params = {}) ⇒ `Types::CreateThingResponse`

#create_thing_group(params = {}) ⇒ `Types::CreateThingGroupResponse`

#create_thing_type(params = {}) ⇒ `Types::CreateThingTypeResponse`

#create_topic_rule(params = {}) ⇒ `Struct`

#delete_account_audit_configuration(params = {}) ⇒ `Struct`

#delete_authorizer(params = {}) ⇒ `Struct`

#delete_billing_group(params = {}) ⇒ `Struct`

#delete_ca_certificate(params = {}) ⇒ `Struct`

#delete_certificate(params = {}) ⇒ `Struct`

#delete_dynamic_thing_group(params = {}) ⇒ `Struct`

#delete_job(params = {}) ⇒ `Struct`

#delete_job_execution(params = {}) ⇒ `Struct`

#delete_ota_update(params = {}) ⇒ `Struct`

#delete_policy(params = {}) ⇒ `Struct`

#delete_policy_version(params = {}) ⇒ `Struct`

#delete_registration_code(params = {}) ⇒ `Struct`

#delete_role_alias(params = {}) ⇒ `Struct`

#delete_scheduled_audit(params = {}) ⇒ `Struct`

#delete_security_profile(params = {}) ⇒ `Struct`

#delete_stream(params = {}) ⇒ `Struct`

#delete_thing(params = {}) ⇒ `Struct`

#delete_thing_group(params = {}) ⇒ `Struct`

#delete_thing_type(params = {}) ⇒ `Struct`

#delete_topic_rule(params = {}) ⇒ `Struct`

#delete_v2_logging_level(params = {}) ⇒ `Struct`

#deprecate_thing_type(params = {}) ⇒ `Struct`

#describe_account_audit_configuration(params = {}) ⇒ `Types::DescribeAccountAuditConfigurationResponse`

#describe_audit_task(params = {}) ⇒ `Types::DescribeAuditTaskResponse`

#describe_authorizer(params = {}) ⇒ `Types::DescribeAuthorizerResponse`

#describe_billing_group(params = {}) ⇒ `Types::DescribeBillingGroupResponse`

#describe_ca_certificate(params = {}) ⇒ `Types::DescribeCACertificateResponse`

#describe_certificate(params = {}) ⇒ `Types::DescribeCertificateResponse`

#describe_default_authorizer(params = {}) ⇒ `Types::DescribeDefaultAuthorizerResponse`

#describe_endpoint(params = {}) ⇒ `Types::DescribeEndpointResponse`

#describe_event_configurations(params = {}) ⇒ `Types::DescribeEventConfigurationsResponse`

#describe_index(params = {}) ⇒ `Types::DescribeIndexResponse`

#describe_job(params = {}) ⇒ `Types::DescribeJobResponse`

#describe_job_execution(params = {}) ⇒ `Types::DescribeJobExecutionResponse`

#describe_role_alias(params = {}) ⇒ `Types::DescribeRoleAliasResponse`

#describe_scheduled_audit(params = {}) ⇒ `Types::DescribeScheduledAuditResponse`

#describe_security_profile(params = {}) ⇒ `Types::DescribeSecurityProfileResponse`

#describe_stream(params = {}) ⇒ `Types::DescribeStreamResponse`

#describe_thing(params = {}) ⇒ `Types::DescribeThingResponse`

#describe_thing_group(params = {}) ⇒ `Types::DescribeThingGroupResponse`

#describe_thing_registration_task(params = {}) ⇒ `Types::DescribeThingRegistrationTaskResponse`

#describe_thing_type(params = {}) ⇒ `Types::DescribeThingTypeResponse`

#detach_policy(params = {}) ⇒ `Struct`

#detach_principal_policy(params = {}) ⇒ `Struct`

#detach_security_profile(params = {}) ⇒ `Struct`

#detach_thing_principal(params = {}) ⇒ `Struct`

#disable_topic_rule(params = {}) ⇒ `Struct`

#enable_topic_rule(params = {}) ⇒ `Struct`

#get_effective_policies(params = {}) ⇒ `Types::GetEffectivePoliciesResponse`