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_certificate_provider(params = {}) ⇒ Types::CreateCertificateProviderResponse
Creates an Amazon Web Services IoT Core certificate provider.
-
#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_package(params = {}) ⇒ Types::CreatePackageResponse
Creates an IoT software package that can be deployed to your fleet.
-
#create_package_version(params = {}) ⇒ Types::CreatePackageVersionResponse
Creates a new version for an existing IoT software package.
-
#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_certificate_provider(params = {}) ⇒ Struct
Deletes a certificate provider.
-
#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_package(params = {}) ⇒ Struct
Deletes a specific version from a software package.
-
#delete_package_version(params = {}) ⇒ Struct
Deletes a specific version from a software package.
-
#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_certificate_provider(params = {}) ⇒ Types::DescribeCertificateProviderResponse
Describes a certificate provider.
-
#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 or creates 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_package(params = {}) ⇒ Types::GetPackageResponse
Gets information about the specified software package.
-
#get_package_configuration(params = {}) ⇒ Types::GetPackageConfigurationResponse
Gets information about the specified software package's configuration.
-
#get_package_version(params = {}) ⇒ Types::GetPackageVersionResponse
Gets information about the specified package version.
-
#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_certificate_providers(params = {}) ⇒ Types::ListCertificateProvidersResponse
Lists all your certificate providers in 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_package_versions(params = {}) ⇒ Types::ListPackageVersionsResponse
Lists the software package versions associated to the account.
-
#list_packages(params = {}) ⇒ Types::ListPackagesResponse
Lists the software packages associated to the account.
-
#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_related_resources_for_audit_finding(params = {}) ⇒ Types::ListRelatedResourcesForAuditFindingResponse
The related resources of an Audit finding.
-
#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_certificate_provider(params = {}) ⇒ Types::UpdateCertificateProviderResponse
Updates a certificate provider.
-
#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_package(params = {}) ⇒ Struct
Updates the supported fields for a specific software package.
-
#update_package_configuration(params = {}) ⇒ Struct
Updates the software package configuration.
-
#update_package_version(params = {}) ⇒ Struct
Updates the supported fields for a specific package version.
-
#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.
410 411 412 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 410 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.
447 448 449 450 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 447 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.
490 491 492 493 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 490 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.
535 536 537 538 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 535 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.
609 610 611 612 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 609 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.
645 646 647 648 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 645 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.
681 682 683 684 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 681 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.
714 715 716 717 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 714 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, Amazon Cognito identities or federated identities.
Requires permission to access the AttachThingPrincipal action.
747 748 749 750 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 747 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.
775 776 777 778 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 775 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.
804 805 806 807 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 804 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.
842 843 844 845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 842 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.
869 870 871 872 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 869 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.
924 925 926 927 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 924 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.
985 986 987 988 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 985 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.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1002 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.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1034 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.
1107 1108 1109 1110 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1107 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.
1196 1197 1198 1199 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1196 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.
1247 1248 1249 1250 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1247 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.
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. In
the following commands, we assume that 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.
You can also run the aws iot create-certificate-from-csr
part of the
command 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"
1340 1341 1342 1343 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1340 def create_certificate_from_csr(params = {}, = {}) req = build_request(:create_certificate_from_csr, params) req.send_request() end |
#create_certificate_provider(params = {}) ⇒ Types::CreateCertificateProviderResponse
Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.
Requires permission to access the CreateCertificateProvider action.
After you create a certificate provider, the behavior of
CreateCertificateFromCsr
API for fleet provisioning will change
and all API calls to CreateCertificateFromCsr
will invoke the
certificate provider to create the certificates. It can take up to a
few minutes for this behavior to change after a certificate provider
is created.
1416 1417 1418 1419 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1416 def create_certificate_provider(params = {}, = {}) req = build_request(:create_certificate_provider, 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.
1487 1488 1489 1490 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1487 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.
1555 1556 1557 1558 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1555 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.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1656 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.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1746 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.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1830 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.
2043 2044 2045 2046 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2043 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.
2194 2195 2196 2197 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2194 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.
2241 2242 2243 2244 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2241 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.
2319 2320 2321 2322 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2319 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.
2500 2501 2502 2503 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2500 def create_ota_update(params = {}, = {}) req = build_request(:create_ota_update, params) req.send_request() end |
#create_package(params = {}) ⇒ Types::CreatePackageResponse
Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
2557 2558 2559 2560 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2557 def create_package(params = {}, = {}) req = build_request(:create_package, params) req.send_request() end |
#create_package_version(params = {}) ⇒ Types::CreatePackageVersionResponse
Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
2638 2639 2640 2641 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2638 def create_package_version(params = {}, = {}) req = build_request(:create_package_version, 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.
2706 2707 2708 2709 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2706 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.
2765 2766 2767 2768 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2765 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.
2804 2805 2806 2807 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2804 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.
2903 2904 2905 2906 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2903 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.
2950 2951 2952 2953 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2950 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.
3017 3018 3019 3020 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3017 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.
3086 3087 3088 3089 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3086 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.
3213 3214 3215 3216 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3213 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.
3285 3286 3287 3288 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3285 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.
3354 3355 3356 3357 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3354 def create_thing(params = {}, = {}) req = build_request(:create_thing, params) req.send_request() end |
#create_thing_group(params = {}) ⇒ Types::CreateThingGroupResponse
Create a thing group.
If the ThingGroup
that you create has the exact same attributes as
an existing ThingGroup
, you will get a 200 success response.
Requires permission to access the CreateThingGroup action.
3424 3425 3426 3427 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3424 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.
3478 3479 3480 3481 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3478 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.
3944 3945 3946 3947 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3944 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.
3999 4000 4001 4002 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3999 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.
4028 4029 4030 4031 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4028 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.
4079 4080 4081 4082 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4079 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.
4105 4106 4107 4108 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4105 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.
4138 4139 4140 4141 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4138 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.
4165 4166 4167 4168 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4165 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.
4203 4204 4205 4206 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4203 def delete_certificate(params = {}, = {}) req = build_request(:delete_certificate, params) req.send_request() end |
#delete_certificate_provider(params = {}) ⇒ Struct
Deletes a certificate provider.
Requires permission to access the DeleteCertificateProvider action.
If you delete the certificate provider resource, the behavior of
CreateCertificateFromCsr
will resume, and IoT will create
certificates signed by IoT from a certificate signing request (CSR).
4234 4235 4236 4237 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4234 def delete_certificate_provider(params = {}, = {}) req = build_request(:delete_certificate_provider, 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.
4269 4270 4271 4272 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4269 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.
4296 4297 4298 4299 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4296 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.
4323 4324 4325 4326 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4323 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.
4353 4354 4355 4356 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4353 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.
4385 4386 4387 4388 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4385 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.
4459 4460 4461 4462 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4459 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.
4533 4534 4535 4536 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4533 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.
4553 4554 4555 4556 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4553 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.
4580 4581 4582 4583 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4580 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.
4619 4620 4621 4622 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4619 def delete_ota_update(params = {}, = {}) req = build_request(:delete_ota_update, params) req.send_request() end |
#delete_package(params = {}) ⇒ Struct
Deletes a specific version from a software package.
Note: All package versions must be deleted before deleting the software package.
Requires permission to access the DeletePackageVersion action.
4657 4658 4659 4660 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4657 def delete_package(params = {}, = {}) req = build_request(:delete_package, params) req.send_request() end |
#delete_package_version(params = {}) ⇒ Struct
Deletes a specific version from a software package.
Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.
4694 4695 4696 4697 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4694 def delete_package_version(params = {}, = {}) req = build_request(:delete_package_version, 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.
4737 4738 4739 4740 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4737 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.
4771 4772 4773 4774 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4771 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.
4798 4799 4800 4801 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4798 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.
4829 4830 4831 4832 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4829 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.
4846 4847 4848 4849 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4846 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.
4872 4873 4874 4875 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4872 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.
4898 4899 4900 4901 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4898 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.
4931 4932 4933 4934 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4931 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.
4957 4958 4959 4960 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4957 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.
4991 4992 4993 4994 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4991 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.
5021 5022 5023 5024 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5021 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.
5052 5053 5054 5055 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5052 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.
5078 5079 5080 5081 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5078 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.
5105 5106 5107 5108 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5105 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.
5136 5137 5138 5139 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5136 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.
5169 5170 5171 5172 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5169 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.
5203 5204 5205 5206 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5203 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.
5279 5280 5281 5282 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5279 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.
5344 5345 5346 5347 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5344 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.
5415 5416 5417 5418 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5415 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.
5470 5471 5472 5473 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5470 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.
5512 5513 5514 5515 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5512 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.
5554 5555 5556 5557 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5554 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.
5602 5603 5604 5605 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5602 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.
5653 5654 5655 5656 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5653 def describe_certificate(params = {}, = {}) req = build_request(:describe_certificate, params) req.send_request() end |
#describe_certificate_provider(params = {}) ⇒ Types::DescribeCertificateProviderResponse
Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
5697 5698 5699 5700 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5697 def describe_certificate_provider(params = {}, = {}) req = build_request(:describe_certificate_provider, 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.
5739 5740 5741 5742 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5739 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.
5773 5774 5775 5776 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5773 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.
5833 5834 5835 5836 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5833 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.
5877 5878 5879 5880 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5877 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.
5934 5935 5936 5937 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5934 def describe_domain_configuration(params = {}, = {}) req = build_request(:describe_domain_configuration, params) req.send_request() end |
#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse
Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.
DescribeEndpoint
is called, an endpoint is created.
All subsequent calls to DescribeEndpoint
return the same endpoint.
Requires permission to access the DescribeEndpoint action.
5997 5998 5999 6000 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5997 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.
6026 6027 6028 6029 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6026 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.
6084 6085 6086 6087 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6084 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.
6120 6121 6122 6123 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6120 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.
6207 6208 6209 6210 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6207 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.
6259 6260 6261 6262 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6259 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.
6323 6324 6325 6326 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6323 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.
6372 6373 6374 6375 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6372 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.
6427 6428 6429 6430 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6427 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.
6481 6482 6483 6484 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6481 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.
6524 6525 6526 6527 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6524 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.
6562 6563 6564 6565 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6562 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.
6605 6606 6607 6608 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6605 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.
6687 6688 6689 6690 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6687 def describe_security_profile(params = {}, = {}) req = build_request(:describe_security_profile, params) req.send_request() end |
#describe_stream(params = {}) ⇒ Types::DescribeStreamResponse
Gets information about a stream.
Requires permission to access the DescribeStream action.
6730 6731 6732 6733 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6730 def describe_stream(params = {}, = {}) req = build_request(:describe_stream, params) req.send_request() end |
#describe_thing(params = {}) ⇒ Types::DescribeThingResponse
Gets information about the specified thing.
Requires permission to access the DescribeThing action.
6777 6778 6779 6780 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6777 def describe_thing(params = {}, = {}) req = build_request(:describe_thing, params) req.send_request() end |
#describe_thing_group(params = {}) ⇒ Types::DescribeThingGroupResponse
Describe a thing group.
Requires permission to access the DescribeThingGroup action.
6834 6835 6836 6837 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6834 def describe_thing_group(params = {}, = {}) req = build_request(:describe_thing_group, params) req.send_request() end |
#describe_thing_registration_task(params = {}) ⇒ Types::DescribeThingRegistrationTaskResponse
Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
6889 6890 6891 6892 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6889 def describe_thing_registration_task(params = {}, = {}) req = build_request(:describe_thing_registration_task, params) req.send_request() end |
#describe_thing_type(params = {}) ⇒ Types::DescribeThingTypeResponse
Gets information about the specified thing type.
Requires permission to access the DescribeThingType action.
6933 6934 6935 6936 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6933 def describe_thing_type(params = {}, = {}) req = build_request(:describe_thing_type, params) req.send_request() end |
#detach_policy(params = {}) ⇒ Struct
Detaches a policy from the specified target.
Requires permission to access the DetachPolicy action.
6969 6970 6971 6972 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6969 def detach_policy(params = {}, = {}) req = build_request(:detach_policy, params) req.send_request() end |
#detach_principal_policy(params = {}) ⇒ Struct
Removes the specified policy from the specified certificate.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.
Requires permission to access the DetachPrincipalPolicy action.
7008 7009 7010 7011 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7008 def detach_principal_policy(params = {}, = {}) req = build_request(:detach_principal_policy, params) req.send_request() end |
#detach_security_profile(params = {}) ⇒ Struct
Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
7040 7041 7042 7043 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7040 def detach_security_profile(params = {}, = {}) req = build_request(:detach_security_profile, params) req.send_request() end |
#detach_thing_principal(params = {}) ⇒ Struct
Detaches the specified principal from 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 DetachThingPrincipal action.
7079 7080 7081 7082 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7079 def detach_thing_principal(params = {}, = {}) req = build_request(:detach_thing_principal, params) req.send_request() end |
#disable_topic_rule(params = {}) ⇒ Struct
Disables the rule.
Requires permission to access the DisableTopicRule action.
7105 7106 7107 7108 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7105 def disable_topic_rule(params = {}, = {}) req = build_request(:disable_topic_rule, params) req.send_request() end |
#enable_topic_rule(params = {}) ⇒ Struct
Enables the rule.
Requires permission to access the EnableTopicRule action.
7131 7132 7133 7134 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7131 def enable_topic_rule(params = {}, = {}) req = build_request(:enable_topic_rule, params) req.send_request() end |
#get_behavior_model_training_summaries(params = {}) ⇒ Types::GetBehaviorModelTrainingSummariesResponse
Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7184 7185 7186 7187 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7184 def get_behavior_model_training_summaries(params = {}, = {}) req = build_request(:get_behavior_model_training_summaries, params) req.send_request() end |
#get_buckets_aggregation(params = {}) ⇒ Types::GetBucketsAggregationResponse
Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
7242 7243 7244 7245 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7242 def get_buckets_aggregation(params = {}, = {}) req = build_request(:get_buckets_aggregation, params) req.send_request() end |
#get_cardinality(params = {}) ⇒ Types::GetCardinalityResponse
Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
7286 7287 7288 7289 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7286 def get_cardinality(params = {}, = {}) req = build_request(:get_cardinality, params) req.send_request() 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 IoT device gateway.
Requires permission to access the GetEffectivePolicies action.
7334 7335 7336 7337 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7334 def get_effective_policies(params = {}, = {}) req = build_request(:get_effective_policies, params) req.send_request() end |
#get_indexing_configuration(params = {}) ⇒ Types::GetIndexingConfigurationResponse
Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
7380 7381 7382 7383 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7380 def get_indexing_configuration(params = {}, = {}) req = build_request(:get_indexing_configuration, params) req.send_request() end |
#get_job_document(params = {}) ⇒ Types::GetJobDocumentResponse
Gets a job document.
Requires permission to access the GetJobDocument action.
7412 7413 7414 7415 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7412 def get_job_document(params = {}, = {}) req = build_request(:get_job_document, params) req.send_request() end |
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Gets the logging options.
NOTE: use of this command is not recommended. Use
GetV2LoggingOptions
instead.
Requires permission to access the GetLoggingOptions action.
7440 7441 7442 7443 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7440 def (params = {}, = {}) req = build_request(:get_logging_options, params) req.send_request() end |
#get_ota_update(params = {}) ⇒ Types::GetOTAUpdateResponse
Gets an OTA update.
Requires permission to access the GetOTAUpdate action.
7517 7518 7519 7520 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7517 def get_ota_update(params = {}, = {}) req = build_request(:get_ota_update, params) req.send_request() end |
#get_package(params = {}) ⇒ Types::GetPackageResponse
Gets information about the specified software package.
Requires permission to access the GetPackage action.
7559 7560 7561 7562 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7559 def get_package(params = {}, = {}) req = build_request(:get_package, params) req.send_request() end |
#get_package_configuration(params = {}) ⇒ Types::GetPackageConfigurationResponse
Gets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
7584 7585 7586 7587 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7584 def get_package_configuration(params = {}, = {}) req = build_request(:get_package_configuration, params) req.send_request() end |
#get_package_version(params = {}) ⇒ Types::GetPackageVersionResponse
Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
7637 7638 7639 7640 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7637 def get_package_version(params = {}, = {}) req = build_request(:get_package_version, params) req.send_request() end |
#get_percentiles(params = {}) ⇒ Types::GetPercentilesResponse
Groups the aggregated values that match the query into percentile
groupings. The default percentile groupings are: 1,5,25,50,75,95,99,
although you can specify your own when you call GetPercentiles
. This
function returns a value for each percentile group specified (or the
default percentile groupings). The percentile group "1" contains the
aggregated field value that occurs in approximately one percent of the
values that match the query. The percentile group "5" contains the
aggregated field value that occurs in approximately five percent of
the values that match the query, and so on. The result is an
approximation, the more values that match the query, the more accurate
the percentile values.
Requires permission to access the GetPercentiles action.
7697 7698 7699 7700 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7697 def get_percentiles(params = {}, = {}) req = build_request(:get_percentiles, params) req.send_request() end |
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Gets information about the specified policy with the policy document of the default version.
Requires permission to access the GetPolicy action.
7742 7743 7744 7745 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7742 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() end |
#get_policy_version(params = {}) ⇒ Types::GetPolicyVersionResponse
Gets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
7792 7793 7794 7795 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7792 def get_policy_version(params = {}, = {}) req = build_request(:get_policy_version, params) req.send_request() end |
#get_registration_code(params = {}) ⇒ Types::GetRegistrationCodeResponse
Gets a registration code used to register a CA certificate with IoT.
IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code.
Requires permission to access the GetRegistrationCode action.
7820 7821 7822 7823 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7820 def get_registration_code(params = {}, = {}) req = build_request(:get_registration_code, params) req.send_request() end |
#get_statistics(params = {}) ⇒ Types::GetStatisticsResponse
Returns the count, average, sum, minimum, maximum, sum of squares,
variance, and standard deviation for the specified aggregated field.
If the aggregation field is of type String
, only the count statistic
is returned.
Requires permission to access the GetStatistics action.
7876 7877 7878 7879 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7876 def get_statistics(params = {}, = {}) req = build_request(:get_statistics, params) req.send_request() end |
#get_topic_rule(params = {}) ⇒ Types::GetTopicRuleResponse
Gets information about the rule.
Requires permission to access the GetTopicRule action.
8162 8163 8164 8165 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8162 def get_topic_rule(params = {}, = {}) req = build_request(:get_topic_rule, params) req.send_request() end |
#get_topic_rule_destination(params = {}) ⇒ Types::GetTopicRuleDestinationResponse
Gets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
8205 8206 8207 8208 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8205 def get_topic_rule_destination(params = {}, = {}) req = build_request(:get_topic_rule_destination, params) req.send_request() end |
#get_v2_logging_options(params = {}) ⇒ Types::GetV2LoggingOptionsResponse
Gets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
8232 8233 8234 8235 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8232 def (params = {}, = {}) req = build_request(:get_v2_logging_options, params) req.send_request() end |
#list_active_violations(params = {}) ⇒ Types::ListActiveViolationsResponse
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8334 8335 8336 8337 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8334 def list_active_violations(params = {}, = {}) req = build_request(:list_active_violations, params) req.send_request() end |
#list_attached_policies(params = {}) ⇒ Types::ListAttachedPoliciesResponse
Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8388 8389 8390 8391 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8388 def list_attached_policies(params = {}, = {}) req = build_request(:list_attached_policies, params) req.send_request() 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 90 days.)
Requires permission to access the ListAuditFindings action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8524 8525 8526 8527 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8524 def list_audit_findings(params = {}, = {}) req = build_request(:list_audit_findings, params) req.send_request() end |
#list_audit_mitigation_actions_executions(params = {}) ⇒ Types::ListAuditMitigationActionsExecutionsResponse
Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8589 8590 8591 8592 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8589 def list_audit_mitigation_actions_executions(params = {}, = {}) req = build_request(:list_audit_mitigation_actions_executions, params) req.send_request() end |
#list_audit_mitigation_actions_tasks(params = {}) ⇒ Types::ListAuditMitigationActionsTasksResponse
Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8660 8661 8662 8663 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8660 def list_audit_mitigation_actions_tasks(params = {}, = {}) req = build_request(:list_audit_mitigation_actions_tasks, params) req.send_request() end |
#list_audit_suppressions(params = {}) ⇒ Types::ListAuditSuppressionsResponse
Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8753 8754 8755 8756 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8753 def list_audit_suppressions(params = {}, = {}) req = build_request(:list_audit_suppressions, params) req.send_request() end |
#list_audit_tasks(params = {}) ⇒ Types::ListAuditTasksResponse
Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8819 8820 8821 8822 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8819 def list_audit_tasks(params = {}, = {}) req = build_request(:list_audit_tasks, params) req.send_request() end |
#list_authorizers(params = {}) ⇒ Types::ListAuthorizersResponse
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8869 8870 8871 8872 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8869 def (params = {}, = {}) req = build_request(:list_authorizers, params) req.send_request() end |
#list_billing_groups(params = {}) ⇒ Types::ListBillingGroupsResponse
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8917 8918 8919 8920 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8917 def list_billing_groups(params = {}, = {}) req = build_request(:list_billing_groups, params) req.send_request() end |
#list_ca_certificates(params = {}) ⇒ Types::ListCACertificatesResponse
Lists the CA certificates registered for your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCACertificates action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8973 8974 8975 8976 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8973 def list_ca_certificates(params = {}, = {}) req = build_request(:list_ca_certificates, params) req.send_request() end |
#list_certificate_providers(params = {}) ⇒ Types::ListCertificateProvidersResponse
Lists all your certificate providers in your Amazon Web Services account.
Requires permission to access the ListCertificateProviders action.
9017 9018 9019 9020 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9017 def list_certificate_providers(params = {}, = {}) req = build_request(:list_certificate_providers, params) req.send_request() end |
#list_certificates(params = {}) ⇒ Types::ListCertificatesResponse
Lists the certificates registered in your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCertificates action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9070 9071 9072 9073 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9070 def list_certificates(params = {}, = {}) req = build_request(:list_certificates, params) req.send_request() end |
#list_certificates_by_ca(params = {}) ⇒ Types::ListCertificatesByCAResponse
List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9125 9126 9127 9128 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9125 def list_certificates_by_ca(params = {}, = {}) req = build_request(:list_certificates_by_ca, params) req.send_request() end |
#list_custom_metrics(params = {}) ⇒ Types::ListCustomMetricsResponse
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9167 9168 9169 9170 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9167 def list_custom_metrics(params = {}, = {}) req = build_request(:list_custom_metrics, params) req.send_request() end |
#list_detect_mitigation_actions_executions(params = {}) ⇒ Types::ListDetectMitigationActionsExecutionsResponse
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9242 9243 9244 9245 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9242 def list_detect_mitigation_actions_executions(params = {}, = {}) req = build_request(:list_detect_mitigation_actions_executions, params) req.send_request() end |
#list_detect_mitigation_actions_tasks(params = {}) ⇒ Types::ListDetectMitigationActionsTasksResponse
List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9323 9324 9325 9326 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9323 def list_detect_mitigation_actions_tasks(params = {}, = {}) req = build_request(:list_detect_mitigation_actions_tasks, params) req.send_request() end |
#list_dimensions(params = {}) ⇒ Types::ListDimensionsResponse
List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9365 9366 9367 9368 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9365 def list_dimensions(params = {}, = {}) req = build_request(:list_dimensions, params) req.send_request() end |
#list_domain_configurations(params = {}) ⇒ Types::ListDomainConfigurationsResponse
Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
Requires permission to access the ListDomainConfigurations action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9414 9415 9416 9417 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9414 def list_domain_configurations(params = {}, = {}) req = build_request(:list_domain_configurations, params) req.send_request() end |
#list_fleet_metrics(params = {}) ⇒ Types::ListFleetMetricsResponse
Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9458 9459 9460 9461 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9458 def list_fleet_metrics(params = {}, = {}) req = build_request(:list_fleet_metrics, params) req.send_request() end |
#list_indices(params = {}) ⇒ Types::ListIndicesResponse
Lists the search indices.
Requires permission to access the ListIndices action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9500 9501 9502 9503 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9500 def list_indices(params = {}, = {}) req = build_request(:list_indices, params) req.send_request() end |
#list_job_executions_for_job(params = {}) ⇒ Types::ListJobExecutionsForJobResponse
Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9555 9556 9557 9558 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9555 def list_job_executions_for_job(params = {}, = {}) req = build_request(:list_job_executions_for_job, params) req.send_request() end |
#list_job_executions_for_thing(params = {}) ⇒ Types::ListJobExecutionsForThingResponse
Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9636 9637 9638 9639 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9636 def list_job_executions_for_thing(params = {}, = {}) req = build_request(:list_job_executions_for_thing, params) req.send_request() end |
#list_job_templates(params = {}) ⇒ Types::ListJobTemplatesResponse
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9680 9681 9682 9683 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9680 def list_job_templates(params = {}, = {}) req = build_request(:list_job_templates, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists jobs.
Requires permission to access the ListJobs action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9780 9781 9782 9783 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9780 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_managed_job_templates(params = {}) ⇒ Types::ListManagedJobTemplatesResponse
Returns a list of managed job templates.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9826 9827 9828 9829 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9826 def list_managed_job_templates(params = {}, = {}) req = build_request(:list_managed_job_templates, params) req.send_request() end |
#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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9898 9899 9900 9901 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9898 def list_metric_values(params = {}, = {}) req = build_request(:list_metric_values, params) req.send_request() end |
#list_mitigation_actions(params = {}) ⇒ Types::ListMitigationActionsResponse
Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9948 9949 9950 9951 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9948 def list_mitigation_actions(params = {}, = {}) req = build_request(:list_mitigation_actions, params) req.send_request() end |
#list_ota_updates(params = {}) ⇒ Types::ListOTAUpdatesResponse
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9995 9996 9997 9998 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9995 def list_ota_updates(params = {}, = {}) req = build_request(:list_ota_updates, params) req.send_request() end |
#list_outgoing_certificates(params = {}) ⇒ Types::ListOutgoingCertificatesResponse
Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10047 10048 10049 10050 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10047 def list_outgoing_certificates(params = {}, = {}) req = build_request(:list_outgoing_certificates, params) req.send_request() end |
#list_package_versions(params = {}) ⇒ Types::ListPackageVersionsResponse
Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10105 10106 10107 10108 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10105 def list_package_versions(params = {}, = {}) req = build_request(:list_package_versions, params) req.send_request() end |
#list_packages(params = {}) ⇒ Types::ListPackagesResponse
Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10149 10150 10151 10152 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10149 def list_packages(params = {}, = {}) req = build_request(:list_packages, params) req.send_request() end |
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Lists your policies.
Requires permission to access the ListPolicies action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10196 10197 10198 10199 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10196 def list_policies(params = {}, = {}) req = build_request(:list_policies, params) req.send_request() end |
#list_policy_principals(params = {}) ⇒ Types::ListPolicyPrincipalsResponse
Lists the principals associated with the specified policy.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.
Requires permission to access the ListPolicyPrincipals action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10250 10251 10252 10253 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10250 def list_policy_principals(params = {}, = {}) req = build_request(:list_policy_principals, params) req.send_request() end |
#list_policy_versions(params = {}) ⇒ Types::ListPolicyVersionsResponse
Lists the versions of the specified policy and identifies the default version.
Requires permission to access the ListPolicyVersions action.
10286 10287 10288 10289 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10286 def list_policy_versions(params = {}, = {}) req = build_request(:list_policy_versions, params) req.send_request() 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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.
Requires permission to access the ListPrincipalPolicies action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10347 10348 10349 10350 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10347 def list_principal_policies(params = {}, = {}) req = build_request(:list_principal_policies, params) req.send_request() end |
#list_principal_things(params = {}) ⇒ Types::ListPrincipalThingsResponse
Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListPrincipalThings action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10396 10397 10398 10399 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10396 def list_principal_things(params = {}, = {}) req = build_request(:list_principal_things, params) req.send_request() end |
#list_provisioning_template_versions(params = {}) ⇒ Types::ListProvisioningTemplateVersionsResponse
A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10444 10445 10446 10447 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10444 def list_provisioning_template_versions(params = {}, = {}) req = build_request(:list_provisioning_template_versions, params) req.send_request() end |
#list_provisioning_templates(params = {}) ⇒ Types::ListProvisioningTemplatesResponse
Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10492 10493 10494 10495 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10492 def list_provisioning_templates(params = {}, = {}) req = build_request(:list_provisioning_templates, params) req.send_request() end |
#list_related_resources_for_audit_finding(params = {}) ⇒ Types::ListRelatedResourcesForAuditFindingResponse
The related resources of an Audit finding. The following resources can be returned from calling this API:
DEVICE_CERTIFICATE
CA_CERTIFICATE
IOT_POLICY
COGNITO_IDENTITY_POOL
CLIENT_ID
ACCOUNT_SETTINGS
ROLE_ALIAS
IAM_ROLE
ISSUER_CERTIFICATE
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10579 10580 10581 10582 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10579 def (params = {}, = {}) req = build_request(:list_related_resources_for_audit_finding, params) req.send_request() end |
#list_role_aliases(params = {}) ⇒ Types::ListRoleAliasesResponse
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10624 10625 10626 10627 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10624 def list_role_aliases(params = {}, = {}) req = build_request(:list_role_aliases, params) req.send_request() end |
#list_scheduled_audits(params = {}) ⇒ Types::ListScheduledAuditsResponse
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10670 10671 10672 10673 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10670 def list_scheduled_audits(params = {}, = {}) req = build_request(:list_scheduled_audits, params) req.send_request() end |
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.
Requires permission to access the ListSecurityProfiles action.
dimensionName
and metricName
cannot be used in the same request.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10726 10727 10728 10729 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10726 def list_security_profiles(params = {}, = {}) req = build_request(:list_security_profiles, params) req.send_request() end |
#list_security_profiles_for_target(params = {}) ⇒ Types::ListSecurityProfilesForTargetResponse
Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10780 10781 10782 10783 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10780 def list_security_profiles_for_target(params = {}, = {}) req = build_request(:list_security_profiles_for_target, params) req.send_request() end |
#list_streams(params = {}) ⇒ Types::ListStreamsResponse
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10828 10829 10830 10831 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10828 def list_streams(params = {}, = {}) req = build_request(:list_streams, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10872 10873 10874 10875 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10872 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_targets_for_policy(params = {}) ⇒ Types::ListTargetsForPolicyResponse
List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10917 10918 10919 10920 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10917 def list_targets_for_policy(params = {}, = {}) req = build_request(:list_targets_for_policy, params) req.send_request() end |
#list_targets_for_security_profile(params = {}) ⇒ Types::ListTargetsForSecurityProfileResponse
Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10964 10965 10966 10967 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10964 def list_targets_for_security_profile(params = {}, = {}) req = build_request(:list_targets_for_security_profile, params) req.send_request() end |
#list_thing_groups(params = {}) ⇒ Types::ListThingGroupsResponse
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11022 11023 11024 11025 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11022 def list_thing_groups(params = {}, = {}) req = build_request(:list_thing_groups, params) req.send_request() end |
#list_thing_groups_for_thing(params = {}) ⇒ Types::ListThingGroupsForThingResponse
List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11070 11071 11072 11073 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11070 def list_thing_groups_for_thing(params = {}, = {}) req = build_request(:list_thing_groups_for_thing, params) req.send_request() end |
#list_thing_principals(params = {}) ⇒ Types::ListThingPrincipalsResponse
Lists the principals associated with 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 ListThingPrincipals action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11119 11120 11121 11122 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11119 def list_thing_principals(params = {}, = {}) req = build_request(:list_thing_principals, params) req.send_request() end |
#list_thing_registration_task_reports(params = {}) ⇒ Types::ListThingRegistrationTaskReportsResponse
Information about the thing registration tasks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11166 11167 11168 11169 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11166 def list_thing_registration_task_reports(params = {}, = {}) req = build_request(:list_thing_registration_task_reports, params) req.send_request() end |
#list_thing_registration_tasks(params = {}) ⇒ Types::ListThingRegistrationTasksResponse
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11214 11215 11216 11217 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11214 def list_thing_registration_tasks(params = {}, = {}) req = build_request(:list_thing_registration_tasks, params) req.send_request() end |
#list_thing_types(params = {}) ⇒ Types::ListThingTypesResponse
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11268 11269 11270 11271 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11268 def list_thing_types(params = {}, = {}) req = build_request(:list_thing_types, params) req.send_request() end |
#list_things(params = {}) ⇒ Types::ListThingsResponse
Lists your things. Use the attributeName and attributeValue
parameters to filter your things. For example, calling ListThings
with attributeName=Color and attributeValue=Red retrieves all things
in the registry that contain an attribute Color with the value
Red. For more information, see List Things from the Amazon
Web Services IoT Core Developer Guide.
Requires permission to access the ListThings action.
Access denied
error is returned. You will also not be charged if no attributes or
pagination token was provided in request and no pagination token and
no results were returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11350 11351 11352 11353 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11350 def list_things(params = {}, = {}) req = build_request(:list_things, params) req.send_request() end |
#list_things_in_billing_group(params = {}) ⇒ Types::ListThingsInBillingGroupResponse
Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11398 11399 11400 11401 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11398 def list_things_in_billing_group(params = {}, = {}) req = build_request(:list_things_in_billing_group, params) req.send_request() end |
#list_things_in_thing_group(params = {}) ⇒ Types::ListThingsInThingGroupResponse
Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11450 11451 11452 11453 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11450 def list_things_in_thing_group(params = {}, = {}) req = build_request(:list_things_in_thing_group, params) req.send_request() end |
#list_topic_rule_destinations(params = {}) ⇒ Types::ListTopicRuleDestinationsResponse
Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11506 11507 11508 11509 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11506 def list_topic_rule_destinations(params = {}, = {}) req = build_request(:list_topic_rule_destinations, params) req.send_request() end |
#list_topic_rules(params = {}) ⇒ Types::ListTopicRulesResponse
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11561 11562 11563 11564 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11561 def list_topic_rules(params = {}, = {}) req = build_request(:list_topic_rules, params) req.send_request() end |
#list_v2_logging_levels(params = {}) ⇒ Types::ListV2LoggingLevelsResponse
Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11611 11612 11613 11614 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11611 def list_v2_logging_levels(params = {}, = {}) req = build_request(:list_v2_logging_levels, params) req.send_request() end |
#list_violation_events(params = {}) ⇒ Types::ListViolationEventsResponse
Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
Requires permission to access the ListViolationEvents action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11724 11725 11726 11727 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11724 def list_violation_events(params = {}, = {}) req = build_request(:list_violation_events, params) req.send_request() end |
#put_verification_state_on_violation(params = {}) ⇒ Struct
Set a verification state and provide a description of that verification state on a violation (detect alarm).
11754 11755 11756 11757 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11754 def put_verification_state_on_violation(params = {}, = {}) req = build_request(:put_verification_state_on_violation, params) req.send_request() end |
#register_ca_certificate(params = {}) ⇒ Types::RegisterCACertificateResponse
Registers a CA certificate with Amazon Web Services IoT Core. There is
no limit to the number of CA certificates you can register in your
Amazon Web Services account. You can register up to 10 CA certificates
with the same CA subject field
per Amazon Web Services account.
Requires permission to access the RegisterCACertificate action.
11853 11854 11855 11856 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11853 def register_ca_certificate(params = {}, = {}) req = build_request(:register_ca_certificate, params) req.send_request() end |
#register_certificate(params = {}) ⇒ Types::RegisterCertificateResponse
Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
Requires permission to access the RegisterCertificate action.
11907 11908 11909 11910 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11907 def register_certificate(params = {}, = {}) req = build_request(:register_certificate, params) req.send_request() end |
#register_certificate_without_ca(params = {}) ⇒ Types::RegisterCertificateWithoutCAResponse
Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
11945 11946 11947 11948 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11945 def register_certificate_without_ca(params = {}, = {}) req = build_request(:register_certificate_without_ca, params) req.send_request() end |
#register_thing(params = {}) ⇒ Types::RegisterThingResponse
Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.
Requires permission to access the RegisterThing action.
12002 12003 12004 12005 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12002 def register_thing(params = {}, = {}) req = build_request(:register_thing, params) req.send_request() end |
#reject_certificate_transfer(params = {}) ⇒ Struct
Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
Requires permission to access the RejectCertificateTransfer action.
12043 12044 12045 12046 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12043 def reject_certificate_transfer(params = {}, = {}) req = build_request(:reject_certificate_transfer, params) req.send_request() end |
#remove_thing_from_billing_group(params = {}) ⇒ Struct
Removes the given thing from the billing group.
Requires permission to access the RemoveThingFromBillingGroup action.
12087 12088 12089 12090 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12087 def remove_thing_from_billing_group(params = {}, = {}) req = build_request(:remove_thing_from_billing_group, params) req.send_request() end |
#remove_thing_from_thing_group(params = {}) ⇒ Struct
Remove the specified thing from the specified group.
You must specify either a thingGroupArn
or a thingGroupName
to
identify the thing group and either a thingArn
or a thingName
to
identify the thing to remove from the thing group.
Requires permission to access the RemoveThingFromThingGroup action.
12130 12131 12132 12133 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12130 def remove_thing_from_thing_group(params = {}, = {}) req = build_request(:remove_thing_from_thing_group, params) req.send_request() end |
#replace_topic_rule(params = {}) ⇒ Struct
Replaces the rule. You must specify all parameters for the new 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 ReplaceTopicRule action.
12582 12583 12584 12585 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12582 def replace_topic_rule(params = {}, = {}) req = build_request(:replace_topic_rule, params) req.send_request() end |
#search_index(params = {}) ⇒ Types::SearchIndexResponse
The query search index.
Requires permission to access the SearchIndex action.
12666 12667 12668 12669 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12666 def search_index(params = {}, = {}) req = build_request(:search_index, params) req.send_request() end |
#set_default_authorizer(params = {}) ⇒ Types::SetDefaultAuthorizerResponse
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
Requires permission to access the SetDefaultAuthorizer action.
12701 12702 12703 12704 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12701 def (params = {}, = {}) req = build_request(:set_default_authorizer, params) req.send_request() end |
#set_default_policy_version(params = {}) ⇒ Struct
Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.
Requires permission to access the SetDefaultPolicyVersion action.
12734 12735 12736 12737 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12734 def set_default_policy_version(params = {}, = {}) req = build_request(:set_default_policy_version, params) req.send_request() end |
#set_logging_options(params = {}) ⇒ Struct
Sets the logging options.
NOTE: use of this command is not recommended. Use
SetV2LoggingOptions
instead.
Requires permission to access the SetLoggingOptions action.
12766 12767 12768 12769 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12766 def (params = {}, = {}) req = build_request(:set_logging_options, params) req.send_request() end |
#set_v2_logging_level(params = {}) ⇒ Struct
Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.
12799 12800 12801 12802 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12799 def set_v2_logging_level(params = {}, = {}) req = build_request(:set_v2_logging_level, params) req.send_request() end |
#set_v2_logging_options(params = {}) ⇒ Struct
Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
12833 12834 12835 12836 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12833 def (params = {}, = {}) req = build_request(:set_v2_logging_options, params) req.send_request() end |
#start_audit_mitigation_actions_task(params = {}) ⇒ Types::StartAuditMitigationActionsTaskResponse
Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
12897 12898 12899 12900 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12897 def start_audit_mitigation_actions_task(params = {}, = {}) req = build_request(:start_audit_mitigation_actions_task, params) req.send_request() end |
#start_detect_mitigation_actions_task(params = {}) ⇒ Types::StartDetectMitigationActionsTaskResponse
Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
12968 12969 12970 12971 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12968 def start_detect_mitigation_actions_task(params = {}, = {}) req = build_request(:start_detect_mitigation_actions_task, params) req.send_request() end |
#start_on_demand_audit_task(params = {}) ⇒ Types::StartOnDemandAuditTaskResponse
Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
13004 13005 13006 13007 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13004 def start_on_demand_audit_task(params = {}, = {}) req = build_request(:start_on_demand_audit_task, params) req.send_request() end |
#start_thing_registration_task(params = {}) ⇒ Types::StartThingRegistrationTaskResponse
Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
13051 13052 13053 13054 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13051 def start_thing_registration_task(params = {}, = {}) req = build_request(:start_thing_registration_task, params) req.send_request() end |
#stop_thing_registration_task(params = {}) ⇒ Struct
Cancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
13078 13079 13080 13081 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13078 def stop_thing_registration_task(params = {}, = {}) req = build_request(:stop_thing_registration_task, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
Requires permission to access the TagResource action.
13114 13115 13116 13117 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13114 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_authorization(params = {}) ⇒ Types::TestAuthorizationResponse
Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestAuthorization action.
13194 13195 13196 13197 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13194 def (params = {}, = {}) req = build_request(:test_authorization, params) req.send_request() end |
#test_invoke_authorizer(params = {}) ⇒ Types::TestInvokeAuthorizerResponse
Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestInvokeAuthorizer action.
13269 13270 13271 13272 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13269 def (params = {}, = {}) req = build_request(:test_invoke_authorizer, params) req.send_request() end |
#transfer_certificate(params = {}) ⇒ Types::TransferCertificateResponse
Transfers the specified certificate to the specified Amazon Web Services account.
Requires permission to access the TransferCertificate action.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.
13322 13323 13324 13325 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13322 def transfer_certificate(params = {}, = {}) req = build_request(:transfer_certificate, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
13352 13353 13354 13355 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13352 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account_audit_configuration(params = {}) ⇒ Struct
Configures or reconfigures 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 UpdateAccountAuditConfiguration action.
13414 13415 13416 13417 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13414 def update_account_audit_configuration(params = {}, = {}) req = build_request(:update_account_audit_configuration, params) req.send_request() end |
#update_audit_suppression(params = {}) ⇒ Struct
Updates a Device Defender audit suppression.
13472 13473 13474 13475 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13472 def update_audit_suppression(params = {}, = {}) req = build_request(:update_audit_suppression, params) req.send_request() end |
#update_authorizer(params = {}) ⇒ Types::UpdateAuthorizerResponse
Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
13530 13531 13532 13533 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13530 def (params = {}, = {}) req = build_request(:update_authorizer, params) req.send_request() end |
#update_billing_group(params = {}) ⇒ Types::UpdateBillingGroupResponse
Updates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
13575 13576 13577 13578 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13575 def update_billing_group(params = {}, = {}) req = build_request(:update_billing_group, params) req.send_request() end |
#update_ca_certificate(params = {}) ⇒ Struct
Updates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
13625 13626 13627 13628 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13625 def update_ca_certificate(params = {}, = {}) req = build_request(:update_ca_certificate, params) req.send_request() end |
#update_certificate(params = {}) ⇒ Struct
Updates the status of the specified certificate. This operation is idempotent.
Requires permission to access the UpdateCertificate action.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
13673 13674 13675 13676 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13673 def update_certificate(params = {}, = {}) req = build_request(:update_certificate, params) req.send_request() end |
#update_certificate_provider(params = {}) ⇒ Types::UpdateCertificateProviderResponse
Updates a certificate provider.
Requires permission to access the UpdateCertificateProvider action.
13718 13719 13720 13721 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13718 def update_certificate_provider(params = {}, = {}) req = build_request(:update_certificate_provider, params) req.send_request() end |
#update_custom_metric(params = {}) ⇒ Types::UpdateCustomMetricResponse
Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
13766 13767 13768 13769 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13766 def update_custom_metric(params = {}, = {}) req = build_request(:update_custom_metric, params) req.send_request() end |
#update_dimension(params = {}) ⇒ Types::UpdateDimensionResponse
Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
Requires permission to access the UpdateDimension action.
13817 13818 13819 13820 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13817 def update_dimension(params = {}, = {}) req = build_request(:update_dimension, params) req.send_request() end |
#update_domain_configuration(params = {}) ⇒ Types::UpdateDomainConfigurationResponse
Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
Requires permission to access the UpdateDomainConfiguration action.
13880 13881 13882 13883 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13880 def update_domain_configuration(params = {}, = {}) req = build_request(:update_domain_configuration, params) req.send_request() end |
#update_dynamic_thing_group(params = {}) ⇒ Types::UpdateDynamicThingGroupResponse
Updates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
13949 13950 13951 13952 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13949 def update_dynamic_thing_group(params = {}, = {}) req = build_request(:update_dynamic_thing_group, params) req.send_request() end |
#update_event_configurations(params = {}) ⇒ Struct
Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
13980 13981 13982 13983 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13980 def update_event_configurations(params = {}, = {}) req = build_request(:update_event_configurations, params) req.send_request() end |
#update_fleet_metric(params = {}) ⇒ Struct
Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
14051 14052 14053 14054 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14051 def update_fleet_metric(params = {}, = {}) req = build_request(:update_fleet_metric, params) req.send_request() end |
#update_indexing_configuration(params = {}) ⇒ Struct
Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
14122 14123 14124 14125 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14122 def update_indexing_configuration(params = {}, = {}) req = build_request(:update_indexing_configuration, params) req.send_request() end |
#update_job(params = {}) ⇒ Struct
Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
14227 14228 14229 14230 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14227 def update_job(params = {}, = {}) req = build_request(:update_job, params) req.send_request() end |
#update_mitigation_action(params = {}) ⇒ Types::UpdateMitigationActionResponse
Updates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
14292 14293 14294 14295 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14292 def update_mitigation_action(params = {}, = {}) req = build_request(:update_mitigation_action, params) req.send_request() end |
#update_package(params = {}) ⇒ Struct
Updates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
14348 14349 14350 14351 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14348 def update_package(params = {}, = {}) req = build_request(:update_package, params) req.send_request() end |
#update_package_configuration(params = {}) ⇒ Struct
Updates the software package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
14389 14390 14391 14392 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14389 def update_package_configuration(params = {}, = {}) req = build_request(:update_package_configuration, params) req.send_request() end |
#update_package_version(params = {}) ⇒ Struct
Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
14456 14457 14458 14459 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14456 def update_package_version(params = {}, = {}) req = build_request(:update_package_version, params) req.send_request() end |
#update_provisioning_template(params = {}) ⇒ Struct
Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
14517 14518 14519 14520 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14517 def update_provisioning_template(params = {}, = {}) req = build_request(:update_provisioning_template, params) req.send_request() end |
#update_role_alias(params = {}) ⇒ Types::UpdateRoleAliasResponse
Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
14562 14563 14564 14565 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14562 def update_role_alias(params = {}, = {}) req = build_request(:update_role_alias, params) req.send_request() end |
#update_scheduled_audit(params = {}) ⇒ Types::UpdateScheduledAuditResponse
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
14623 14624 14625 14626 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14623 def update_scheduled_audit(params = {}, = {}) req = build_request(:update_scheduled_audit, params) req.send_request() end |
#update_security_profile(params = {}) ⇒ Types::UpdateSecurityProfileResponse
Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
14816 14817 14818 14819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14816 def update_security_profile(params = {}, = {}) req = build_request(:update_security_profile, params) req.send_request() end |
#update_stream(params = {}) ⇒ Types::UpdateStreamResponse
Updates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
14877 14878 14879 14880 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14877 def update_stream(params = {}, = {}) req = build_request(:update_stream, params) req.send_request() end |
#update_thing(params = {}) ⇒ Struct
Updates the data for a thing.
Requires permission to access the UpdateThing action.
14937 14938 14939 14940 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14937 def update_thing(params = {}, = {}) req = build_request(:update_thing, params) req.send_request() end |
#update_thing_group(params = {}) ⇒ Types::UpdateThingGroupResponse
Update a thing group.
Requires permission to access the UpdateThingGroup action.
14986 14987 14988 14989 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14986 def update_thing_group(params = {}, = {}) req = build_request(:update_thing_group, params) req.send_request() end |
#update_thing_groups_for_thing(params = {}) ⇒ Struct
Updates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
15028 15029 15030 15031 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15028 def update_thing_groups_for_thing(params = {}, = {}) req = build_request(:update_thing_groups_for_thing, params) req.send_request() end |
#update_topic_rule_destination(params = {}) ⇒ Struct
Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
Requires permission to access the UpdateTopicRuleDestination action.
15089 15090 15091 15092 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15089 def update_topic_rule_destination(params = {}, = {}) req = build_request(:update_topic_rule_destination, params) req.send_request() end |
#validate_security_profile_behaviors(params = {}) ⇒ Types::ValidateSecurityProfileBehaviorsResponse
Validates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
15157 15158 15159 15160 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15157 def validate_security_profile_behaviors(params = {}, = {}) req = build_request(:validate_security_profile_behaviors, params) req.send_request() end |