Class: Aws::IoT::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoT::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb
Overview
An API client for IoT. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoT::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_certificate_transfer(params = {}) ⇒ Struct
Accepts a pending certificate transfer.
-
#add_thing_to_billing_group(params = {}) ⇒ Struct
Adds a thing to a billing group.
-
#add_thing_to_thing_group(params = {}) ⇒ Struct
Adds a thing to a thing group.
-
#associate_targets_with_job(params = {}) ⇒ Types::AssociateTargetsWithJobResponse
Associates a group with a continuous job.
-
#attach_policy(params = {}) ⇒ Struct
Attaches the specified policy to the specified principal (certificate or other credential).
-
#attach_principal_policy(params = {}) ⇒ Struct
Attaches the specified policy to the specified principal (certificate or other credential).
-
#attach_security_profile(params = {}) ⇒ Struct
Associates a Device Defender security profile with a thing group or this account.
-
#attach_thing_principal(params = {}) ⇒ Struct
Attaches the specified principal to the specified thing.
-
#cancel_audit_mitigation_actions_task(params = {}) ⇒ Struct
Cancels a mitigation action task that is in progress.
-
#cancel_audit_task(params = {}) ⇒ Struct
Cancels an audit that is in progress.
-
#cancel_certificate_transfer(params = {}) ⇒ Struct
Cancels a pending transfer for the specified certificate.
-
#cancel_detect_mitigation_actions_task(params = {}) ⇒ Struct
Cancels a Device Defender ML Detect mitigation action.
-
#cancel_job(params = {}) ⇒ Types::CancelJobResponse
Cancels a job.
-
#cancel_job_execution(params = {}) ⇒ Struct
Cancels the execution of a job for a given thing.
-
#clear_default_authorizer(params = {}) ⇒ Struct
Clears the default authorizer.
-
#confirm_topic_rule_destination(params = {}) ⇒ Struct
Confirms a topic rule destination.
-
#create_audit_suppression(params = {}) ⇒ Struct
Creates a Device Defender audit suppression.
-
#create_authorizer(params = {}) ⇒ Types::CreateAuthorizerResponse
Creates an authorizer.
-
#create_billing_group(params = {}) ⇒ Types::CreateBillingGroupResponse
Creates a billing group.
-
#create_certificate_from_csr(params = {}) ⇒ Types::CreateCertificateFromCsrResponse
Creates an X.509 certificate using the specified certificate signing request.
-
#create_custom_metric(params = {}) ⇒ Types::CreateCustomMetricResponse
Use this API to define a Custom Metric published by your devices to Device Defender.
-
#create_dimension(params = {}) ⇒ Types::CreateDimensionResponse
Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender.
-
#create_domain_configuration(params = {}) ⇒ Types::CreateDomainConfigurationResponse
Creates a domain configuration.
-
#create_dynamic_thing_group(params = {}) ⇒ Types::CreateDynamicThingGroupResponse
Creates a dynamic thing group.
-
#create_fleet_metric(params = {}) ⇒ Types::CreateFleetMetricResponse
Creates a fleet metric.
-
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates a job.
-
#create_job_template(params = {}) ⇒ Types::CreateJobTemplateResponse
Creates a job template.
-
#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.
-
#create_mitigation_action(params = {}) ⇒ Types::CreateMitigationActionResponse
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.
-
#create_ota_update(params = {}) ⇒ Types::CreateOTAUpdateResponse
Creates an IoT OTA update on a target group of things or groups.
-
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates an IoT policy.
-
#create_policy_version(params = {}) ⇒ Types::CreatePolicyVersionResponse
Creates a new version of the specified IoT policy.
-
#create_provisioning_claim(params = {}) ⇒ Types::CreateProvisioningClaimResponse
Creates a provisioning claim.
-
#create_provisioning_template(params = {}) ⇒ Types::CreateProvisioningTemplateResponse
Creates a provisioning template.
-
#create_provisioning_template_version(params = {}) ⇒ Types::CreateProvisioningTemplateVersionResponse
Creates a new version of a provisioning template.
-
#create_role_alias(params = {}) ⇒ Types::CreateRoleAliasResponse
Creates a role alias.
-
#create_scheduled_audit(params = {}) ⇒ Types::CreateScheduledAuditResponse
Creates a scheduled audit that is run at a specified time interval.
-
#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse
Creates a Device Defender security profile.
-
#create_stream(params = {}) ⇒ Types::CreateStreamResponse
Creates a stream for delivering one or more large files in chunks over MQTT.
-
#create_thing(params = {}) ⇒ Types::CreateThingResponse
Creates a thing record in the registry.
-
#create_thing_group(params = {}) ⇒ Types::CreateThingGroupResponse
Create a thing group.
-
#create_thing_type(params = {}) ⇒ Types::CreateThingTypeResponse
Creates a new thing type.
-
#create_topic_rule(params = {}) ⇒ Struct
Creates a rule.
-
#create_topic_rule_destination(params = {}) ⇒ Types::CreateTopicRuleDestinationResponse
Creates a topic rule destination.
-
#delete_account_audit_configuration(params = {}) ⇒ Struct
Restores the default settings for Device Defender audits for this account.
-
#delete_audit_suppression(params = {}) ⇒ Struct
Deletes a Device Defender audit suppression.
-
#delete_authorizer(params = {}) ⇒ Struct
Deletes an authorizer.
-
#delete_billing_group(params = {}) ⇒ Struct
Deletes the billing group.
-
#delete_ca_certificate(params = {}) ⇒ Struct
Deletes a registered CA certificate.
-
#delete_certificate(params = {}) ⇒ Struct
Deletes the specified certificate.
-
#delete_custom_metric(params = {}) ⇒ Struct
Deletes a Device Defender detect custom metric.
-
#delete_dimension(params = {}) ⇒ Struct
Removes the specified dimension from your Amazon Web Services accounts.
-
#delete_domain_configuration(params = {}) ⇒ Struct
Deletes the specified domain configuration.
-
#delete_dynamic_thing_group(params = {}) ⇒ Struct
Deletes a dynamic thing group.
-
#delete_fleet_metric(params = {}) ⇒ Struct
Deletes the specified fleet metric.
-
#delete_job(params = {}) ⇒ Struct
Deletes a job and its related job executions.
-
#delete_job_execution(params = {}) ⇒ Struct
Deletes a job execution.
-
#delete_job_template(params = {}) ⇒ Struct
Deletes the specified job template.
-
#delete_mitigation_action(params = {}) ⇒ Struct
Deletes a defined mitigation action from your Amazon Web Services accounts.
-
#delete_ota_update(params = {}) ⇒ Struct
Delete an OTA update.
-
#delete_policy(params = {}) ⇒ Struct
Deletes the specified policy.
-
#delete_policy_version(params = {}) ⇒ Struct
Deletes the specified version of the specified policy.
-
#delete_provisioning_template(params = {}) ⇒ Struct
Deletes a provisioning template.
-
#delete_provisioning_template_version(params = {}) ⇒ Struct
Deletes a provisioning template version.
-
#delete_registration_code(params = {}) ⇒ Struct
Deletes a CA certificate registration code.
-
#delete_role_alias(params = {}) ⇒ Struct
Deletes a role alias.
-
#delete_scheduled_audit(params = {}) ⇒ Struct
Deletes a scheduled audit.
-
#delete_security_profile(params = {}) ⇒ Struct
Deletes a Device Defender security profile.
-
#delete_stream(params = {}) ⇒ Struct
Deletes a stream.
-
#delete_thing(params = {}) ⇒ Struct
Deletes the specified thing.
-
#delete_thing_group(params = {}) ⇒ Struct
Deletes a thing group.
-
#delete_thing_type(params = {}) ⇒ Struct
Deletes the specified thing type.
-
#delete_topic_rule(params = {}) ⇒ Struct
Deletes the rule.
-
#delete_topic_rule_destination(params = {}) ⇒ Struct
Deletes a topic rule destination.
-
#delete_v2_logging_level(params = {}) ⇒ Struct
Deletes a logging level.
-
#deprecate_thing_type(params = {}) ⇒ Struct
Deprecates a thing type.
-
#describe_account_audit_configuration(params = {}) ⇒ Types::DescribeAccountAuditConfigurationResponse
Gets information about the Device Defender audit settings for this account.
-
#describe_audit_finding(params = {}) ⇒ Types::DescribeAuditFindingResponse
Gets information about a single audit finding.
-
#describe_audit_mitigation_actions_task(params = {}) ⇒ Types::DescribeAuditMitigationActionsTaskResponse
Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.
-
#describe_audit_suppression(params = {}) ⇒ Types::DescribeAuditSuppressionResponse
Gets information about a Device Defender audit suppression.
-
#describe_audit_task(params = {}) ⇒ Types::DescribeAuditTaskResponse
Gets information about a Device Defender audit.
-
#describe_authorizer(params = {}) ⇒ Types::DescribeAuthorizerResponse
Describes an authorizer.
-
#describe_billing_group(params = {}) ⇒ Types::DescribeBillingGroupResponse
Returns information about a billing group.
-
#describe_ca_certificate(params = {}) ⇒ Types::DescribeCACertificateResponse
Describes a registered CA certificate.
-
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResponse
Gets information about the specified certificate.
-
#describe_custom_metric(params = {}) ⇒ Types::DescribeCustomMetricResponse
Gets information about a Device Defender detect custom metric.
-
#describe_default_authorizer(params = {}) ⇒ Types::DescribeDefaultAuthorizerResponse
Describes the default authorizer.
-
#describe_detect_mitigation_actions_task(params = {}) ⇒ Types::DescribeDetectMitigationActionsTaskResponse
Gets information about a Device Defender ML Detect mitigation action.
-
#describe_dimension(params = {}) ⇒ Types::DescribeDimensionResponse
Provides details about a dimension that is defined in your Amazon Web Services accounts.
-
#describe_domain_configuration(params = {}) ⇒ Types::DescribeDomainConfigurationResponse
Gets summary information about a domain configuration.
-
#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse
Returns a unique endpoint specific to the Amazon Web Services account making the call.
-
#describe_event_configurations(params = {}) ⇒ Types::DescribeEventConfigurationsResponse
Describes event configurations.
-
#describe_fleet_metric(params = {}) ⇒ Types::DescribeFleetMetricResponse
Gets information about the specified fleet metric.
-
#describe_index(params = {}) ⇒ Types::DescribeIndexResponse
Describes a search index.
-
#describe_job(params = {}) ⇒ Types::DescribeJobResponse
Describes a job.
-
#describe_job_execution(params = {}) ⇒ Types::DescribeJobExecutionResponse
Describes a job execution.
-
#describe_job_template(params = {}) ⇒ Types::DescribeJobTemplateResponse
Returns information about a job template.
-
#describe_managed_job_template(params = {}) ⇒ Types::DescribeManagedJobTemplateResponse
View details of a managed job template.
-
#describe_mitigation_action(params = {}) ⇒ Types::DescribeMitigationActionResponse
Gets information about a mitigation action.
-
#describe_provisioning_template(params = {}) ⇒ Types::DescribeProvisioningTemplateResponse
Returns information about a provisioning template.
-
#describe_provisioning_template_version(params = {}) ⇒ Types::DescribeProvisioningTemplateVersionResponse
Returns information about a provisioning template version.
-
#describe_role_alias(params = {}) ⇒ Types::DescribeRoleAliasResponse
Describes a role alias.
-
#describe_scheduled_audit(params = {}) ⇒ Types::DescribeScheduledAuditResponse
Gets information about a scheduled audit.
-
#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse
Gets information about a Device Defender security profile.
-
#describe_stream(params = {}) ⇒ Types::DescribeStreamResponse
Gets information about a stream.
-
#describe_thing(params = {}) ⇒ Types::DescribeThingResponse
Gets information about the specified thing.
-
#describe_thing_group(params = {}) ⇒ Types::DescribeThingGroupResponse
Describe a thing group.
-
#describe_thing_registration_task(params = {}) ⇒ Types::DescribeThingRegistrationTaskResponse
Describes a bulk thing provisioning task.
-
#describe_thing_type(params = {}) ⇒ Types::DescribeThingTypeResponse
Gets information about the specified thing type.
-
#detach_policy(params = {}) ⇒ Struct
Detaches a policy from the specified target.
-
#detach_principal_policy(params = {}) ⇒ Struct
Removes the specified policy from the specified certificate.
-
#detach_security_profile(params = {}) ⇒ Struct
Disassociates a Device Defender security profile from a thing group or from this account.
-
#detach_thing_principal(params = {}) ⇒ Struct
Detaches the specified principal from the specified thing.
-
#disable_topic_rule(params = {}) ⇒ Struct
Disables the rule.
-
#enable_topic_rule(params = {}) ⇒ Struct
Enables the rule.
-
#get_behavior_model_training_summaries(params = {}) ⇒ Types::GetBehaviorModelTrainingSummariesResponse
Returns a Device Defender's ML Detect Security Profile training model's status.
-
#get_buckets_aggregation(params = {}) ⇒ Types::GetBucketsAggregationResponse
Aggregates on indexed data with search queries pertaining to particular fields.
-
#get_cardinality(params = {}) ⇒ Types::GetCardinalityResponse
Returns the approximate count of unique values that match the query.
-
#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 IoT device gateway.
-
#get_indexing_configuration(params = {}) ⇒ Types::GetIndexingConfigurationResponse
Gets the indexing configuration.
-
#get_job_document(params = {}) ⇒ Types::GetJobDocumentResponse
Gets a job document.
-
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Gets the logging options.
-
#get_ota_update(params = {}) ⇒ Types::GetOTAUpdateResponse
Gets an OTA update.
-
#get_percentiles(params = {}) ⇒ Types::GetPercentilesResponse
Groups the aggregated values that match the query into percentile groupings.
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Gets information about the specified policy with the policy document of the default version.
-
#get_policy_version(params = {}) ⇒ Types::GetPolicyVersionResponse
Gets information about the specified policy version.
-
#get_registration_code(params = {}) ⇒ Types::GetRegistrationCodeResponse
Gets a registration code used to register a CA certificate with IoT.
-
#get_statistics(params = {}) ⇒ Types::GetStatisticsResponse
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.
-
#get_topic_rule(params = {}) ⇒ Types::GetTopicRuleResponse
Gets information about the rule.
-
#get_topic_rule_destination(params = {}) ⇒ Types::GetTopicRuleDestinationResponse
Gets information about a topic rule destination.
-
#get_v2_logging_options(params = {}) ⇒ Types::GetV2LoggingOptionsResponse
Gets the fine grained logging options.
-
#list_active_violations(params = {}) ⇒ Types::ListActiveViolationsResponse
Lists the active violations for a given Device Defender security profile.
-
#list_attached_policies(params = {}) ⇒ Types::ListAttachedPoliciesResponse
Lists the policies attached to the specified thing group.
-
#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.
-
#list_audit_mitigation_actions_executions(params = {}) ⇒ Types::ListAuditMitigationActionsExecutionsResponse
Gets the status of audit mitigation action tasks that were executed.
-
#list_audit_mitigation_actions_tasks(params = {}) ⇒ Types::ListAuditMitigationActionsTasksResponse
Gets a list of audit mitigation action tasks that match the specified filters.
-
#list_audit_suppressions(params = {}) ⇒ Types::ListAuditSuppressionsResponse
Lists your Device Defender audit listings.
-
#list_audit_tasks(params = {}) ⇒ Types::ListAuditTasksResponse
Lists the Device Defender audits that have been performed during a given time period.
-
#list_authorizers(params = {}) ⇒ Types::ListAuthorizersResponse
Lists the authorizers registered in your account.
-
#list_billing_groups(params = {}) ⇒ Types::ListBillingGroupsResponse
Lists the billing groups you have created.
-
#list_ca_certificates(params = {}) ⇒ Types::ListCACertificatesResponse
Lists the CA certificates registered for your Amazon Web Services account.
-
#list_certificates(params = {}) ⇒ Types::ListCertificatesResponse
Lists the certificates registered in your Amazon Web Services account.
-
#list_certificates_by_ca(params = {}) ⇒ Types::ListCertificatesByCAResponse
List the device certificates signed by the specified CA certificate.
-
#list_custom_metrics(params = {}) ⇒ Types::ListCustomMetricsResponse
Lists your Device Defender detect custom metrics.
-
#list_detect_mitigation_actions_executions(params = {}) ⇒ Types::ListDetectMitigationActionsExecutionsResponse
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
-
#list_detect_mitigation_actions_tasks(params = {}) ⇒ Types::ListDetectMitigationActionsTasksResponse
List of Device Defender ML Detect mitigation actions tasks.
-
#list_dimensions(params = {}) ⇒ Types::ListDimensionsResponse
List the set of dimensions that are defined for your Amazon Web Services accounts.
-
#list_domain_configurations(params = {}) ⇒ Types::ListDomainConfigurationsResponse
Gets a list of domain configurations for the user.
-
#list_fleet_metrics(params = {}) ⇒ Types::ListFleetMetricsResponse
Lists all your fleet metrics.
-
#list_indices(params = {}) ⇒ Types::ListIndicesResponse
Lists the search indices.
-
#list_job_executions_for_job(params = {}) ⇒ Types::ListJobExecutionsForJobResponse
Lists the job executions for a job.
-
#list_job_executions_for_thing(params = {}) ⇒ Types::ListJobExecutionsForThingResponse
Lists the job executions for the specified thing.
-
#list_job_templates(params = {}) ⇒ Types::ListJobTemplatesResponse
Returns a list of job templates.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists jobs.
-
#list_managed_job_templates(params = {}) ⇒ Types::ListManagedJobTemplatesResponse
Returns a list of managed job templates.
-
#list_metric_values(params = {}) ⇒ Types::ListMetricValuesResponse
Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.
-
#list_mitigation_actions(params = {}) ⇒ Types::ListMitigationActionsResponse
Gets a list of all mitigation actions that match the specified filter criteria.
-
#list_ota_updates(params = {}) ⇒ Types::ListOTAUpdatesResponse
Lists OTA updates.
-
#list_outgoing_certificates(params = {}) ⇒ Types::ListOutgoingCertificatesResponse
Lists certificates that are being transferred but not yet accepted.
-
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Lists your policies.
-
#list_policy_principals(params = {}) ⇒ Types::ListPolicyPrincipalsResponse
Lists the principals associated with the specified policy.
-
#list_policy_versions(params = {}) ⇒ Types::ListPolicyVersionsResponse
Lists the versions of the specified policy and identifies the default version.
-
#list_principal_policies(params = {}) ⇒ Types::ListPrincipalPoliciesResponse
Lists the policies attached to the specified principal.
-
#list_principal_things(params = {}) ⇒ Types::ListPrincipalThingsResponse
Lists the things associated with the specified principal.
-
#list_provisioning_template_versions(params = {}) ⇒ Types::ListProvisioningTemplateVersionsResponse
A list of provisioning template versions.
-
#list_provisioning_templates(params = {}) ⇒ Types::ListProvisioningTemplatesResponse
Lists the provisioning templates in your Amazon Web Services account.
-
#list_role_aliases(params = {}) ⇒ Types::ListRoleAliasesResponse
Lists the role aliases registered in your account.
-
#list_scheduled_audits(params = {}) ⇒ Types::ListScheduledAuditsResponse
Lists all of your scheduled audits.
-
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
Lists the Device Defender security profiles you've created.
-
#list_security_profiles_for_target(params = {}) ⇒ Types::ListSecurityProfilesForTargetResponse
Lists the Device Defender security profiles attached to a target (thing group).
-
#list_streams(params = {}) ⇒ Types::ListStreamsResponse
Lists all of the streams in your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
-
#list_targets_for_policy(params = {}) ⇒ Types::ListTargetsForPolicyResponse
List targets for the specified policy.
-
#list_targets_for_security_profile(params = {}) ⇒ Types::ListTargetsForSecurityProfileResponse
Lists the targets (thing groups) associated with a given Device Defender security profile.
-
#list_thing_groups(params = {}) ⇒ Types::ListThingGroupsResponse
List the thing groups in your account.
-
#list_thing_groups_for_thing(params = {}) ⇒ Types::ListThingGroupsForThingResponse
List the thing groups to which the specified thing belongs.
-
#list_thing_principals(params = {}) ⇒ Types::ListThingPrincipalsResponse
Lists the principals associated with the specified thing.
-
#list_thing_registration_task_reports(params = {}) ⇒ Types::ListThingRegistrationTaskReportsResponse
Information about the thing registration tasks.
-
#list_thing_registration_tasks(params = {}) ⇒ Types::ListThingRegistrationTasksResponse
List bulk thing provisioning tasks.
-
#list_thing_types(params = {}) ⇒ Types::ListThingTypesResponse
Lists the existing thing types.
-
#list_things(params = {}) ⇒ Types::ListThingsResponse
Lists your things.
-
#list_things_in_billing_group(params = {}) ⇒ Types::ListThingsInBillingGroupResponse
Lists the things you have added to the given billing group.
-
#list_things_in_thing_group(params = {}) ⇒ Types::ListThingsInThingGroupResponse
Lists the things in the specified group.
-
#list_topic_rule_destinations(params = {}) ⇒ Types::ListTopicRuleDestinationsResponse
Lists all the topic rule destinations in your Amazon Web Services account.
-
#list_topic_rules(params = {}) ⇒ Types::ListTopicRulesResponse
Lists the rules for the specific topic.
-
#list_v2_logging_levels(params = {}) ⇒ Types::ListV2LoggingLevelsResponse
Lists logging levels.
-
#list_violation_events(params = {}) ⇒ Types::ListViolationEventsResponse
Lists the Device Defender security profile violations discovered during the given time period.
-
#put_verification_state_on_violation(params = {}) ⇒ Struct
Set a verification state and provide a description of that verification state on a violation (detect alarm).
-
#register_ca_certificate(params = {}) ⇒ Types::RegisterCACertificateResponse
Registers a CA certificate with Amazon Web Services IoT Core.
-
#register_certificate(params = {}) ⇒ Types::RegisterCertificateResponse
Registers a device certificate with IoT in the same [certificate mode][1] as the signing CA.
-
#register_certificate_without_ca(params = {}) ⇒ Types::RegisterCertificateWithoutCAResponse
Register a certificate that does not have a certificate authority (CA).
-
#register_thing(params = {}) ⇒ Types::RegisterThingResponse
Provisions a thing in the device registry.
-
#reject_certificate_transfer(params = {}) ⇒ Struct
Rejects a pending certificate transfer.
-
#remove_thing_from_billing_group(params = {}) ⇒ Struct
Removes the given thing from the billing group.
-
#remove_thing_from_thing_group(params = {}) ⇒ Struct
Remove the specified thing from the specified group.
-
#replace_topic_rule(params = {}) ⇒ Struct
Replaces the rule.
-
#search_index(params = {}) ⇒ Types::SearchIndexResponse
The query search index.
-
#set_default_authorizer(params = {}) ⇒ Types::SetDefaultAuthorizerResponse
Sets the default authorizer.
-
#set_default_policy_version(params = {}) ⇒ Struct
Sets the specified version of the specified policy as the policy's default (operative) version.
-
#set_logging_options(params = {}) ⇒ Struct
Sets the logging options.
-
#set_v2_logging_level(params = {}) ⇒ Struct
Sets the logging level.
-
#set_v2_logging_options(params = {}) ⇒ Struct
Sets the logging options for the V2 logging service.
-
#start_audit_mitigation_actions_task(params = {}) ⇒ Types::StartAuditMitigationActionsTaskResponse
Starts a task that applies a set of mitigation actions to the specified target.
-
#start_detect_mitigation_actions_task(params = {}) ⇒ Types::StartDetectMitigationActionsTaskResponse
Starts a Device Defender ML Detect mitigation actions task.
-
#start_on_demand_audit_task(params = {}) ⇒ Types::StartOnDemandAuditTaskResponse
Starts an on-demand Device Defender audit.
-
#start_thing_registration_task(params = {}) ⇒ Types::StartThingRegistrationTaskResponse
Creates a bulk thing provisioning task.
-
#stop_thing_registration_task(params = {}) ⇒ Struct
Cancels a bulk thing provisioning task.
-
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
-
#test_authorization(params = {}) ⇒ Types::TestAuthorizationResponse
Tests if a specified principal is authorized to perform an IoT action on a specified resource.
-
#test_invoke_authorizer(params = {}) ⇒ Types::TestInvokeAuthorizerResponse
Tests a custom authorization behavior by invoking a specified custom authorizer.
-
#transfer_certificate(params = {}) ⇒ Types::TransferCertificateResponse
Transfers the specified certificate to the specified Amazon Web Services account.
-
#untag_resource(params = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
-
#update_account_audit_configuration(params = {}) ⇒ Struct
Configures or reconfigures the Device Defender audit settings for this account.
-
#update_audit_suppression(params = {}) ⇒ Struct
Updates a Device Defender audit suppression.
-
#update_authorizer(params = {}) ⇒ Types::UpdateAuthorizerResponse
Updates an authorizer.
-
#update_billing_group(params = {}) ⇒ Types::UpdateBillingGroupResponse
Updates information about the billing group.
-
#update_ca_certificate(params = {}) ⇒ Struct
Updates a registered CA certificate.
-
#update_certificate(params = {}) ⇒ Struct
Updates the status of the specified certificate.
-
#update_custom_metric(params = {}) ⇒ Types::UpdateCustomMetricResponse
Updates a Device Defender detect custom metric.
-
#update_dimension(params = {}) ⇒ Types::UpdateDimensionResponse
Updates the definition for a dimension.
-
#update_domain_configuration(params = {}) ⇒ Types::UpdateDomainConfigurationResponse
Updates values stored in the domain configuration.
-
#update_dynamic_thing_group(params = {}) ⇒ Types::UpdateDynamicThingGroupResponse
Updates a dynamic thing group.
-
#update_event_configurations(params = {}) ⇒ Struct
Updates the event configurations.
-
#update_fleet_metric(params = {}) ⇒ Struct
Updates the data for a fleet metric.
-
#update_indexing_configuration(params = {}) ⇒ Struct
Updates the search configuration.
-
#update_job(params = {}) ⇒ Struct
Updates supported fields of the specified job.
-
#update_mitigation_action(params = {}) ⇒ Types::UpdateMitigationActionResponse
Updates the definition for the specified mitigation action.
-
#update_provisioning_template(params = {}) ⇒ Struct
Updates a provisioning template.
-
#update_role_alias(params = {}) ⇒ Types::UpdateRoleAliasResponse
Updates a role alias.
-
#update_scheduled_audit(params = {}) ⇒ Types::UpdateScheduledAuditResponse
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
-
#update_security_profile(params = {}) ⇒ Types::UpdateSecurityProfileResponse
Updates a Device Defender security profile.
-
#update_stream(params = {}) ⇒ Types::UpdateStreamResponse
Updates an existing stream.
-
#update_thing(params = {}) ⇒ Struct
Updates the data for a thing.
-
#update_thing_group(params = {}) ⇒ Types::UpdateThingGroupResponse
Update a thing group.
-
#update_thing_groups_for_thing(params = {}) ⇒ Struct
Updates the groups to which the thing belongs.
-
#update_topic_rule_destination(params = {}) ⇒ Struct
Updates a topic rule destination.
-
#validate_security_profile_behaviors(params = {}) ⇒ Types::ValidateSecurityProfileBehaviorsResponse
Validates a Device Defender security profile behaviors specification.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
348 349 350 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 348 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.
Requires permission to access the AcceptCertificateTransfer action.
385 386 387 388 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 385 def accept_certificate_transfer(params = {}, = {}) req = build_request(:accept_certificate_transfer, params) req.send_request() end |
#add_thing_to_billing_group(params = {}) ⇒ Struct
Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
428 429 430 431 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 428 def add_thing_to_billing_group(params = {}, = {}) req = build_request(:add_thing_to_billing_group, params) req.send_request() end |
#add_thing_to_thing_group(params = {}) ⇒ Struct
Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
473 474 475 476 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 473 def add_thing_to_thing_group(params = {}, = {}) req = build_request(:add_thing_to_thing_group, params) req.send_request() 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
Requires permission to access the AssociateTargetsWithJob action.
541 542 543 544 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 541 def associate_targets_with_job(params = {}, = {}) req = build_request(:associate_targets_with_job, params) req.send_request() end |
#attach_policy(params = {}) ⇒ Struct
Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
577 578 579 580 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 577 def attach_policy(params = {}, = {}) req = build_request(:attach_policy, params) req.send_request() end |
#attach_principal_policy(params = {}) ⇒ Struct
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.
Requires permission to access the AttachPrincipalPolicy action.
613 614 615 616 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 613 def attach_principal_policy(params = {}, = {}) req = build_request(:attach_principal_policy, params) req.send_request() end |
#attach_security_profile(params = {}) ⇒ Struct
Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
Requires permission to access the AttachSecurityProfile action.
646 647 648 649 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 646 def attach_security_profile(params = {}, = {}) req = build_request(:attach_security_profile, params) req.send_request() end |
#attach_thing_principal(params = {}) ⇒ Struct
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the AttachThingPrincipal action.
679 680 681 682 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 679 def attach_thing_principal(params = {}, = {}) req = build_request(:attach_thing_principal, params) req.send_request() end |
#cancel_audit_mitigation_actions_task(params = {}) ⇒ Struct
Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
Requires permission to access the CancelAuditMitigationActionsTask action.
707 708 709 710 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 707 def cancel_audit_mitigation_actions_task(params = {}, = {}) req = build_request(:cancel_audit_mitigation_actions_task, params) req.send_request() 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 isn't in progress, an "InvalidRequestException" occurs.
Requires permission to access the CancelAuditTask action.
736 737 738 739 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 736 def cancel_audit_task(params = {}, = {}) req = build_request(:cancel_audit_task, params) req.send_request() 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, 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.
Requires permission to access the CancelCertificateTransfer action.
774 775 776 777 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 774 def cancel_certificate_transfer(params = {}, = {}) req = build_request(:cancel_certificate_transfer, params) req.send_request() end |
#cancel_detect_mitigation_actions_task(params = {}) ⇒ Struct
Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
801 802 803 804 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 801 def cancel_detect_mitigation_actions_task(params = {}, = {}) req = build_request(:cancel_detect_mitigation_actions_task, params) req.send_request() end |
#cancel_job(params = {}) ⇒ Types::CancelJobResponse
Cancels a job.
Requires permission to access the CancelJob action.
856 857 858 859 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 856 def cancel_job(params = {}, = {}) req = build_request(:cancel_job, params) req.send_request() end |
#cancel_job_execution(params = {}) ⇒ Struct
Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
917 918 919 920 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 917 def cancel_job_execution(params = {}, = {}) req = build_request(:cancel_job_execution, params) req.send_request() end |
#clear_default_authorizer(params = {}) ⇒ Struct
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
934 935 936 937 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 934 def (params = {}, = {}) req = build_request(:clear_default_authorizer, params) req.send_request() end |
#confirm_topic_rule_destination(params = {}) ⇒ Struct
Confirms a topic rule destination. When you create a rule requiring a
destination, IoT sends a confirmation message to the endpoint or base
address you specify. The message includes a token which you pass back
when calling ConfirmTopicRuleDestination
to confirm that you own or
have access to the endpoint.
Requires permission to access the ConfirmTopicRuleDestination action.
966 967 968 969 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 966 def confirm_topic_rule_destination(params = {}, = {}) req = build_request(:confirm_topic_rule_destination, params) req.send_request() end |
#create_audit_suppression(params = {}) ⇒ Struct
Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
1033 1034 1035 1036 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1033 def create_audit_suppression(params = {}, = {}) req = build_request(:create_audit_suppression, params) req.send_request() end |
#create_authorizer(params = {}) ⇒ Types::CreateAuthorizerResponse
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
1122 1123 1124 1125 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1122 def (params = {}, = {}) req = build_request(:create_authorizer, params) req.send_request() end |
#create_billing_group(params = {}) ⇒ Types::CreateBillingGroupResponse
Creates a billing group.
Requires permission to access the CreateBillingGroup action.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1173 def create_billing_group(params = {}, = {}) req = build_request(:create_billing_group, params) req.send_request() 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, NIST P-384, or NIST P-512 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
Requires permission to access the CreateCertificateFromCsr action.
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 Amazon Web Services 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"
1264 1265 1266 1267 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1264 def create_certificate_from_csr(params = {}, = {}) req = build_request(:create_certificate_from_csr, params) req.send_request() end |
#create_custom_metric(params = {}) ⇒ Types::CreateCustomMetricResponse
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
1335 1336 1337 1338 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1335 def create_custom_metric(params = {}, = {}) req = build_request(:create_custom_metric, params) req.send_request() end |
#create_dimension(params = {}) ⇒ Types::CreateDimensionResponse
Create a dimension that you can use to limit the scope of a metric
used in a security profile for IoT Device Defender. For example, using
a TOPIC_FILTER
dimension, you can narrow down the scope of the
metric only to MQTT topics whose name match the pattern specified in
the dimension.
Requires permission to access the CreateDimension action.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1403 def create_dimension(params = {}, = {}) req = build_request(:create_dimension, params) req.send_request() end |
#create_domain_configuration(params = {}) ⇒ Types::CreateDomainConfigurationResponse
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1492 def create_domain_configuration(params = {}, = {}) req = build_request(:create_domain_configuration, params) req.send_request() end |
#create_dynamic_thing_group(params = {}) ⇒ Types::CreateDynamicThingGroupResponse
Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
1582 1583 1584 1585 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1582 def create_dynamic_thing_group(params = {}, = {}) req = build_request(:create_dynamic_thing_group, params) req.send_request() end |
#create_fleet_metric(params = {}) ⇒ Types::CreateFleetMetricResponse
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1666 def create_fleet_metric(params = {}, = {}) req = build_request(:create_fleet_metric, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates a job.
Requires permission to access the CreateJob action.
1845 1846 1847 1848 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1845 def create_job(params = {}, = {}) req = build_request(:create_job, params) req.send_request() end |
#create_job_template(params = {}) ⇒ Types::CreateJobTemplateResponse
Creates a job template.
Requires permission to access the CreateJobTemplate action.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1974 def create_job_template(params = {}, = {}) req = build_request(:create_job_template, params) req.send_request() 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. You can also call CreateKeysAndCertificate
over MQTT from a device, for more information, see Provisioning MQTT
API.
Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.
Requires permission to access the CreateKeysAndCertificate action.
2021 2022 2023 2024 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2021 def create_keys_and_certificate(params = {}, = {}) req = build_request(:create_keys_and_certificate, params) req.send_request() end |
#create_mitigation_action(params = {}) ⇒ Types::CreateMitigationActionResponse
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
Requires permission to access the CreateMitigationAction action.
2099 2100 2101 2102 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2099 def create_mitigation_action(params = {}, = {}) req = build_request(:create_mitigation_action, params) req.send_request() end |
#create_ota_update(params = {}) ⇒ Types::CreateOTAUpdateResponse
Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
2279 2280 2281 2282 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2279 def create_ota_update(params = {}, = {}) req = build_request(:create_ota_update, params) req.send_request() end |
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates an 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.
Requires permission to access the CreatePolicy action.
2347 2348 2349 2350 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2347 def create_policy(params = {}, = {}) req = build_request(:create_policy, params) req.send_request() end |
#create_policy_version(params = {}) ⇒ Types::CreatePolicyVersionResponse
Creates a new version of the specified 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).
Requires permission to access the CreatePolicyVersion action.
2406 2407 2408 2409 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2406 def create_policy_version(params = {}, = {}) req = build_request(:create_policy_version, params) req.send_request() end |
#create_provisioning_claim(params = {}) ⇒ Types::CreateProvisioningClaimResponse
Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
2445 2446 2447 2448 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2445 def create_provisioning_claim(params = {}, = {}) req = build_request(:create_provisioning_claim, params) req.send_request() end |
#create_provisioning_template(params = {}) ⇒ Types::CreateProvisioningTemplateResponse
Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
2538 2539 2540 2541 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2538 def create_provisioning_template(params = {}, = {}) req = build_request(:create_provisioning_template, params) req.send_request() end |
#create_provisioning_template_version(params = {}) ⇒ Types::CreateProvisioningTemplateVersionResponse
Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
2585 2586 2587 2588 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2585 def create_provisioning_template_version(params = {}, = {}) req = build_request(:create_provisioning_template_version, params) req.send_request() end |
#create_role_alias(params = {}) ⇒ Types::CreateRoleAliasResponse
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
2652 2653 2654 2655 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2652 def create_role_alias(params = {}, = {}) req = build_request(:create_role_alias, params) req.send_request() end |
#create_scheduled_audit(params = {}) ⇒ Types::CreateScheduledAuditResponse
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
2721 2722 2723 2724 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2721 def create_scheduled_audit(params = {}, = {}) req = build_request(:create_scheduled_audit, params) req.send_request() end |
#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse
Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
2839 2840 2841 2842 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2839 def create_security_profile(params = {}, = {}) req = build_request(:create_security_profile, params) req.send_request() 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.
Requires permission to access the CreateStream action.
2911 2912 2913 2914 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2911 def create_stream(params = {}, = {}) req = build_request(:create_stream, params) req.send_request() end |
#create_thing(params = {}) ⇒ Types::CreateThingResponse
Creates a thing record in the registry. If this call is made multiple
times using the same thing name and configuration, the call will
succeed. If this call is made with the same thing name but different
configuration a ResourceAlreadyExistsException
is thrown.
Requires permission to access the CreateThing action.
2980 2981 2982 2983 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2980 def create_thing(params = {}, = {}) req = build_request(:create_thing, params) req.send_request() end |
#create_thing_group(params = {}) ⇒ Types::CreateThingGroupResponse
Create a thing group.
Requires permission to access the CreateThingGroup action.
3047 3048 3049 3050 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3047 def create_thing_group(params = {}, = {}) req = build_request(:create_thing_group, params) req.send_request() end |
#create_thing_type(params = {}) ⇒ Types::CreateThingTypeResponse
Creates a new thing type.
Requires permission to access the CreateThingType action.
3101 3102 3103 3104 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3101 def create_thing_type(params = {}, = {}) req = build_request(:create_thing_type, params) req.send_request() 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.
Requires permission to access the CreateTopicRule action.
3505 3506 3507 3508 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3505 def create_topic_rule(params = {}, = {}) req = build_request(:create_topic_rule, params) req.send_request() end |
#create_topic_rule_destination(params = {}) ⇒ Types::CreateTopicRuleDestinationResponse
Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
3560 3561 3562 3563 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3560 def create_topic_rule_destination(params = {}, = {}) req = build_request(:create_topic_rule_destination, params) req.send_request() 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.
Requires permission to access the DeleteAccountAuditConfiguration action.
3589 3590 3591 3592 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3589 def delete_account_audit_configuration(params = {}, = {}) req = build_request(:delete_account_audit_configuration, params) req.send_request() end |
#delete_audit_suppression(params = {}) ⇒ Struct
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
3634 3635 3636 3637 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3634 def delete_audit_suppression(params = {}, = {}) req = build_request(:delete_audit_suppression, params) req.send_request() end |
#delete_authorizer(params = {}) ⇒ Struct
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
3660 3661 3662 3663 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3660 def (params = {}, = {}) req = build_request(:delete_authorizer, params) req.send_request() end |
#delete_billing_group(params = {}) ⇒ Struct
Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
3693 3694 3695 3696 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3693 def delete_billing_group(params = {}, = {}) req = build_request(:delete_billing_group, params) req.send_request() end |
#delete_ca_certificate(params = {}) ⇒ Struct
Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
3720 3721 3722 3723 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3720 def delete_ca_certificate(params = {}, = {}) req = build_request(:delete_ca_certificate, params) req.send_request() end |
#delete_certificate(params = {}) ⇒ Struct
Deletes the specified certificate.
A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.
Requires permission to access the DeleteCertificate action.
3758 3759 3760 3761 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3758 def delete_certificate(params = {}, = {}) req = build_request(:delete_certificate, params) req.send_request() end |
#delete_custom_metric(params = {}) ⇒ Struct
Deletes a Device Defender detect custom metric.
Requires permission to access the DeleteCustomMetric action.
metricName
set to your custom
metric name.
3793 3794 3795 3796 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3793 def delete_custom_metric(params = {}, = {}) req = build_request(:delete_custom_metric, params) req.send_request() end |
#delete_dimension(params = {}) ⇒ Struct
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
3820 3821 3822 3823 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3820 def delete_dimension(params = {}, = {}) req = build_request(:delete_dimension, params) req.send_request() end |
#delete_domain_configuration(params = {}) ⇒ Struct
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
3847 3848 3849 3850 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3847 def delete_domain_configuration(params = {}, = {}) req = build_request(:delete_domain_configuration, params) req.send_request() end |
#delete_dynamic_thing_group(params = {}) ⇒ Struct
Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
3877 3878 3879 3880 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3877 def delete_dynamic_thing_group(params = {}, = {}) req = build_request(:delete_dynamic_thing_group, params) req.send_request() end |
#delete_fleet_metric(params = {}) ⇒ Struct
Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.
Requires permission to access the DeleteFleetMetric action.
3909 3910 3911 3912 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3909 def delete_fleet_metric(params = {}, = {}) req = build_request(:delete_fleet_metric, params) req.send_request() 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.
Requires permission to access the DeleteJob action.
3977 3978 3979 3980 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3977 def delete_job(params = {}, = {}) req = build_request(:delete_job, params) req.send_request() end |
#delete_job_execution(params = {}) ⇒ Struct
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
4045 4046 4047 4048 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4045 def delete_job_execution(params = {}, = {}) req = build_request(:delete_job_execution, params) req.send_request() end |
#delete_job_template(params = {}) ⇒ Struct
Deletes the specified job template.
4065 4066 4067 4068 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4065 def delete_job_template(params = {}, = {}) req = build_request(:delete_job_template, params) req.send_request() end |
#delete_mitigation_action(params = {}) ⇒ Struct
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
4092 4093 4094 4095 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4092 def delete_mitigation_action(params = {}, = {}) req = build_request(:delete_mitigation_action, params) req.send_request() end |
#delete_ota_update(params = {}) ⇒ Struct
Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
4131 4132 4133 4134 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4131 def delete_ota_update(params = {}, = {}) req = build_request(:delete_ota_update, params) req.send_request() 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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
Requires permission to access the DeletePolicy action.
4174 4175 4176 4177 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4174 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() 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 action. 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.
Requires permission to access the DeletePolicyVersion action.
4208 4209 4210 4211 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4208 def delete_policy_version(params = {}, = {}) req = build_request(:delete_policy_version, params) req.send_request() end |
#delete_provisioning_template(params = {}) ⇒ Struct
Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
4235 4236 4237 4238 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4235 def delete_provisioning_template(params = {}, = {}) req = build_request(:delete_provisioning_template, params) req.send_request() end |
#delete_provisioning_template_version(params = {}) ⇒ Struct
Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
4266 4267 4268 4269 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4266 def delete_provisioning_template_version(params = {}, = {}) req = build_request(:delete_provisioning_template_version, params) req.send_request() end |
#delete_registration_code(params = {}) ⇒ Struct
Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
4283 4284 4285 4286 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4283 def delete_registration_code(params = {}, = {}) req = build_request(:delete_registration_code, params) req.send_request() end |
#delete_role_alias(params = {}) ⇒ Struct
Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
4309 4310 4311 4312 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4309 def delete_role_alias(params = {}, = {}) req = build_request(:delete_role_alias, params) req.send_request() end |
#delete_scheduled_audit(params = {}) ⇒ Struct
Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
4335 4336 4337 4338 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4335 def delete_scheduled_audit(params = {}, = {}) req = build_request(:delete_scheduled_audit, params) req.send_request() end |
#delete_security_profile(params = {}) ⇒ Struct
Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
4368 4369 4370 4371 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4368 def delete_security_profile(params = {}, = {}) req = build_request(:delete_security_profile, params) req.send_request() end |
#delete_stream(params = {}) ⇒ Struct
Deletes a stream.
Requires permission to access the DeleteStream action.
4394 4395 4396 4397 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4394 def delete_stream(params = {}, = {}) req = build_request(:delete_stream, params) req.send_request() 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.
Requires permission to access the DeleteThing action.
4428 4429 4430 4431 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4428 def delete_thing(params = {}, = {}) req = build_request(:delete_thing, params) req.send_request() end |
#delete_thing_group(params = {}) ⇒ Struct
Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
4458 4459 4460 4461 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4458 def delete_thing_group(params = {}, = {}) req = build_request(:delete_thing_group, params) req.send_request() 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.
Requires permission to access the DeleteThingType action.
4489 4490 4491 4492 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4489 def delete_thing_type(params = {}, = {}) req = build_request(:delete_thing_type, params) req.send_request() end |
#delete_topic_rule(params = {}) ⇒ Struct
Deletes the rule.
Requires permission to access the DeleteTopicRule action.
4515 4516 4517 4518 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4515 def delete_topic_rule(params = {}, = {}) req = build_request(:delete_topic_rule, params) req.send_request() end |
#delete_topic_rule_destination(params = {}) ⇒ Struct
Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
4542 4543 4544 4545 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4542 def delete_topic_rule_destination(params = {}, = {}) req = build_request(:delete_topic_rule_destination, params) req.send_request() end |
#delete_v2_logging_level(params = {}) ⇒ Struct
Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
4573 4574 4575 4576 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4573 def delete_v2_logging_level(params = {}, = {}) req = build_request(:delete_v2_logging_level, params) req.send_request() end |
#deprecate_thing_type(params = {}) ⇒ Struct
Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
4606 4607 4608 4609 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4606 def deprecate_thing_type(params = {}, = {}) req = build_request(:deprecate_thing_type, params) req.send_request() 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.
Requires permission to access the DescribeAccountAuditConfiguration action.
4640 4641 4642 4643 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4640 def describe_account_audit_configuration(params = {}, = {}) req = build_request(:describe_account_audit_configuration, params) req.send_request() end |
#describe_audit_finding(params = {}) ⇒ Types::DescribeAuditFindingResponse
Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
Requires permission to access the DescribeAuditFinding action.
4708 4709 4710 4711 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4708 def describe_audit_finding(params = {}, = {}) req = build_request(:describe_audit_finding, params) req.send_request() end |
#describe_audit_mitigation_actions_task(params = {}) ⇒ Types::DescribeAuditMitigationActionsTaskResponse
Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.
4773 4774 4775 4776 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4773 def describe_audit_mitigation_actions_task(params = {}, = {}) req = build_request(:describe_audit_mitigation_actions_task, params) req.send_request() end |
#describe_audit_suppression(params = {}) ⇒ Types::DescribeAuditSuppressionResponse
Gets information about a Device Defender audit suppression.
4834 4835 4836 4837 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4834 def describe_audit_suppression(params = {}, = {}) req = build_request(:describe_audit_suppression, params) req.send_request() end |
#describe_audit_task(params = {}) ⇒ Types::DescribeAuditTaskResponse
Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
4889 4890 4891 4892 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4889 def describe_audit_task(params = {}, = {}) req = build_request(:describe_audit_task, params) req.send_request() end |
#describe_authorizer(params = {}) ⇒ Types::DescribeAuthorizerResponse
Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
4931 4932 4933 4934 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4931 def (params = {}, = {}) req = build_request(:describe_authorizer, params) req.send_request() end |
#describe_billing_group(params = {}) ⇒ Types::DescribeBillingGroupResponse
Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
4973 4974 4975 4976 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4973 def describe_billing_group(params = {}, = {}) req = build_request(:describe_billing_group, params) req.send_request() end |
#describe_ca_certificate(params = {}) ⇒ Types::DescribeCACertificateResponse
Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
5021 5022 5023 5024 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5021 def describe_ca_certificate(params = {}, = {}) req = build_request(:describe_ca_certificate, params) req.send_request() end |
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResponse
Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
5072 5073 5074 5075 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5072 def describe_certificate(params = {}, = {}) req = build_request(:describe_certificate, params) req.send_request() end |
#describe_custom_metric(params = {}) ⇒ Types::DescribeCustomMetricResponse
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
5114 5115 5116 5117 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5114 def describe_custom_metric(params = {}, = {}) req = build_request(:describe_custom_metric, params) req.send_request() end |
#describe_default_authorizer(params = {}) ⇒ Types::DescribeDefaultAuthorizerResponse
Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
5148 5149 5150 5151 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5148 def (params = {}, = {}) req = build_request(:describe_default_authorizer, params) req.send_request() end |
#describe_detect_mitigation_actions_task(params = {}) ⇒ Types::DescribeDetectMitigationActionsTaskResponse
Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
5208 5209 5210 5211 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5208 def describe_detect_mitigation_actions_task(params = {}, = {}) req = build_request(:describe_detect_mitigation_actions_task, params) req.send_request() end |
#describe_dimension(params = {}) ⇒ Types::DescribeDimensionResponse
Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
5252 5253 5254 5255 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5252 def describe_dimension(params = {}, = {}) req = build_request(:describe_dimension, params) req.send_request() end |
#describe_domain_configuration(params = {}) ⇒ Types::DescribeDomainConfigurationResponse
Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
5305 5306 5307 5308 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5305 def describe_domain_configuration(params = {}, = {}) req = build_request(:describe_domain_configuration, params) req.send_request() end |
#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse
Returns a unique endpoint specific to the Amazon Web Services account making the call.
Requires permission to access the DescribeEndpoint action.
5362 5363 5364 5365 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5362 def describe_endpoint(params = {}, = {}) req = build_request(:describe_endpoint, params) req.send_request() end |
#describe_event_configurations(params = {}) ⇒ Types::DescribeEventConfigurationsResponse
Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
5391 5392 5393 5394 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5391 def describe_event_configurations(params = {}, = {}) req = build_request(:describe_event_configurations, params) req.send_request() end |
#describe_fleet_metric(params = {}) ⇒ Types::DescribeFleetMetricResponse
Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
5449 5450 5451 5452 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5449 def describe_fleet_metric(params = {}, = {}) req = build_request(:describe_fleet_metric, params) req.send_request() end |
#describe_index(params = {}) ⇒ Types::DescribeIndexResponse
Describes a search index.
Requires permission to access the DescribeIndex action.
5485 5486 5487 5488 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5485 def describe_index(params = {}, = {}) req = build_request(:describe_index, params) req.send_request() end |
#describe_job(params = {}) ⇒ Types::DescribeJobResponse
Describes a job.
Requires permission to access the DescribeJob action.
5562 5563 5564 5565 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5562 def describe_job(params = {}, = {}) req = build_request(:describe_job, params) req.send_request() end |
#describe_job_execution(params = {}) ⇒ Types::DescribeJobExecutionResponse
Describes a job execution.
Requires permission to access the DescribeJobExecution action.
5614 5615 5616 5617 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5614 def describe_job_execution(params = {}, = {}) req = build_request(:describe_job_execution, params) req.send_request() end |
#describe_job_template(params = {}) ⇒ Types::DescribeJobTemplateResponse
Returns information about a job template.
5671 5672 5673 5674 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5671 def describe_job_template(params = {}, = {}) req = build_request(:describe_job_template, params) req.send_request() end |
#describe_managed_job_template(params = {}) ⇒ Types::DescribeManagedJobTemplateResponse
View details of a managed job template.
5720 5721 5722 5723 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5720 def describe_managed_job_template(params = {}, = {}) req = build_request(:describe_managed_job_template, params) req.send_request() end |
#describe_mitigation_action(params = {}) ⇒ Types::DescribeMitigationActionResponse
Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
5775 5776 5777 5778 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5775 def describe_mitigation_action(params = {}, = {}) req = build_request(:describe_mitigation_action, params) req.send_request() end |
#describe_provisioning_template(params = {}) ⇒ Types::DescribeProvisioningTemplateResponse
Returns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
5829 5830 5831 5832 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5829 def describe_provisioning_template(params = {}, = {}) req = build_request(:describe_provisioning_template, params) req.send_request() end |
#describe_provisioning_template_version(params = {}) ⇒ Types::DescribeProvisioningTemplateVersionResponse
Returns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
5872 5873 5874 5875 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5872 def describe_provisioning_template_version(params = {}, = {}) req = build_request(:describe_provisioning_template_version, params) req.send_request() end |
#describe_role_alias(params = {}) ⇒ Types::DescribeRoleAliasResponse
Describes a role alias.
Requires permission to access the DescribeRoleAlias action.
5910 5911 5912 5913 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5910 def describe_role_alias(params = {}, = {}) req = build_request(:describe_role_alias, params) req.send_request() end |
#describe_scheduled_audit(params = {}) ⇒ Types::DescribeScheduledAuditResponse
Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
5953 5954 5955 5956 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5953 def describe_scheduled_audit(params = {}, = {}) req = build_request(:describe_scheduled_audit, params) req.send_request() end |
#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse
Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.