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.
422 423 424 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 422 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.
459 460 461 462 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 459 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.
502 503 504 505 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 502 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.
547 548 549 550 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 547 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.
621 622 623 624 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 621 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.
657 658 659 660 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 657 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.
693 694 695 696 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 693 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.
726 727 728 729 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 726 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.
759 760 761 762 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 759 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.
787 788 789 790 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 787 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.
816 817 818 819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 816 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.
854 855 856 857 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 854 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.
881 882 883 884 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 881 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.
936 937 938 939 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 936 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.
997 998 999 1000 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 997 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.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1014 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.
1046 1047 1048 1049 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1046 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.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1119 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.
1208 1209 1210 1211 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1208 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.
1259 1260 1261 1262 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1259 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"
1352 1353 1354 1355 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1352 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.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1428 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.
1499 1500 1501 1502 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1499 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.
1567 1568 1569 1570 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1567 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.
1668 1669 1670 1671 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1668 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.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1758 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.
1842 1843 1844 1845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1842 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.
2055 2056 2057 2058 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2055 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.
2206 2207 2208 2209 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2206 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.
2253 2254 2255 2256 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2253 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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2331 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.
2512 2513 2514 2515 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2512 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.
2569 2570 2571 2572 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2569 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.
2650 2651 2652 2653 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2650 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.
2718 2719 2720 2721 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2718 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.
2777 2778 2779 2780 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2777 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.
2816 2817 2818 2819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2816 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.
2915 2916 2917 2918 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2915 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.
2962 2963 2964 2965 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2962 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.
3029 3030 3031 3032 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3029 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.
3098 3099 3100 3101 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3098 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.
3225 3226 3227 3228 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3225 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.
3297 3298 3299 3300 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3297 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.
3366 3367 3368 3369 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3366 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.
3436 3437 3438 3439 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3436 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.
3490 3491 3492 3493 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3490 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.
3956 3957 3958 3959 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3956 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.
4011 4012 4013 4014 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4011 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.
4040 4041 4042 4043 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4040 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.
4091 4092 4093 4094 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4091 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.
4117 4118 4119 4120 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4117 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.
4150 4151 4152 4153 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4150 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.
4177 4178 4179 4180 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4177 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.
4215 4216 4217 4218 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4215 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).
4246 4247 4248 4249 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4246 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.
4281 4282 4283 4284 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4281 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.
4308 4309 4310 4311 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4308 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.
4335 4336 4337 4338 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4335 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.
4365 4366 4367 4368 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4365 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.
4397 4398 4399 4400 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4397 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.
4471 4472 4473 4474 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4471 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.
4545 4546 4547 4548 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4545 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.
4565 4566 4567 4568 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4565 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.
4592 4593 4594 4595 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4592 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.
4631 4632 4633 4634 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4631 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.
4669 4670 4671 4672 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4669 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.
4706 4707 4708 4709 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4706 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.
4749 4750 4751 4752 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4749 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.
4783 4784 4785 4786 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4783 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.
4810 4811 4812 4813 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4810 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.
4841 4842 4843 4844 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4841 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.
4858 4859 4860 4861 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4858 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.
4884 4885 4886 4887 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4884 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.
4910 4911 4912 4913 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4910 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.
4943 4944 4945 4946 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4943 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.
4969 4970 4971 4972 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4969 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.
5003 5004 5005 5006 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5003 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.
5033 5034 5035 5036 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5033 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.
5064 5065 5066 5067 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5064 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.
5090 5091 5092 5093 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5090 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.
5117 5118 5119 5120 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5117 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.
5148 5149 5150 5151 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5148 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.
5181 5182 5183 5184 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5181 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.
5215 5216 5217 5218 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5215 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.
5291 5292 5293 5294 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5291 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.
5356 5357 5358 5359 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5356 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.
5427 5428 5429 5430 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5427 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.
5482 5483 5484 5485 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5482 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.
5524 5525 5526 5527 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5524 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.
5566 5567 5568 5569 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5566 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.
5614 5615 5616 5617 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5614 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.
5665 5666 5667 5668 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5665 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.
5709 5710 5711 5712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5709 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.
5751 5752 5753 5754 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5751 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.
5785 5786 5787 5788 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5785 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.
5845 5846 5847 5848 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5845 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.
5889 5890 5891 5892 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5889 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.
5946 5947 5948 5949 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5946 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.
6009 6010 6011 6012 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6009 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.
6038 6039 6040 6041 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6038 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.
6096 6097 6098 6099 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6096 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.
6132 6133 6134 6135 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6132 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.
6219 6220 6221 6222 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6219 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.
6271 6272 6273 6274 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6271 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.
6335 6336 6337 6338 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6335 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.
6384 6385 6386 6387 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6384 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.
6439 6440 6441 6442 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6439 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.
6493 6494 6495 6496 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6493 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.
6536 6537 6538 6539 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6536 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.
6574 6575 6576 6577 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6574 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.
6617 6618 6619 6620 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6617 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.
6699 6700 6701 6702 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6699 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.
6742 6743 6744 6745 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6742 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.
6789 6790 6791 6792 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6789 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.
6846 6847 6848 6849 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6846 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.
6901 6902 6903 6904 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6901 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.
6945 6946 6947 6948 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6945 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.
6981 6982 6983 6984 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6981 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.
7020 7021 7022 7023 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7020 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.
7052 7053 7054 7055 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7052 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.
7091 7092 7093 7094 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7091 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.
7117 7118 7119 7120 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7117 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.
7143 7144 7145 7146 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7143 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.
7196 7197 7198 7199 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7196 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.
7254 7255 7256 7257 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7254 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.
7298 7299 7300 7301 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7298 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.
7346 7347 7348 7349 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7346 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.
7392 7393 7394 7395 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7392 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.
7424 7425 7426 7427 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7424 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.
7452 7453 7454 7455 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7452 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.
7529 7530 7531 7532 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7529 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.
7571 7572 7573 7574 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7571 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.
7596 7597 7598 7599 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7596 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.
7649 7650 7651 7652 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7649 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.
7709 7710 7711 7712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7709 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.
7754 7755 7756 7757 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7754 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.
7804 7805 7806 7807 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7804 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.
7832 7833 7834 7835 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7832 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.
7888 7889 7890 7891 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7888 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.
8174 8175 8176 8177 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8174 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.
8217 8218 8219 8220 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8217 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.
8244 8245 8246 8247 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8244 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.
8346 8347 8348 8349 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8346 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.
8400 8401 8402 8403 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8400 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.
8536 8537 8538 8539 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8536 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.
8601 8602 8603 8604 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8601 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.
8672 8673 8674 8675 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8672 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.
8765 8766 8767 8768 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8765 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.
8831 8832 8833 8834 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8831 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.
8881 8882 8883 8884 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8881 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.
8929 8930 8931 8932 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8929 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.
8985 8986 8987 8988 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8985 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.
9029 9030 9031 9032 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9029 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.
9082 9083 9084 9085 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9082 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.
9137 9138 9139 9140 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9137 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.
9179 9180 9181 9182 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9179 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.
9254 9255 9256 9257 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9254 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.
9335 9336 9337 9338 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9335 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.
9377 9378 9379 9380 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9377 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.
9426 9427 9428 9429 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9426 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.
9470 9471 9472 9473 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9470 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.
9512 9513 9514 9515 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9512 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.
9567 9568 9569 9570 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9567 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.
9648 9649 9650 9651 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9648 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.
9692 9693 9694 9695 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9692 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.
9792 9793 9794 9795 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9792 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.
9838 9839 9840 9841 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9838 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.
9910 9911 9912 9913 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9910 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.
9960 9961 9962 9963 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9960 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.
10007 10008 10009 10010 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10007 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.
10059 10060 10061 10062 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10059 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.
10117 10118 10119 10120 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10117 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.
10161 10162 10163 10164 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10161 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.
10208 10209 10210 10211 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10208 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.
10262 10263 10264 10265 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10262 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.
10298 10299 10300 10301 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10298 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.
10359 10360 10361 10362 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10359 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.
10408 10409 10410 10411 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10408 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.
10456 10457 10458 10459 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10456 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.
10504 10505 10506 10507 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10504 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.
10591 10592 10593 10594 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10591 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.
10636 10637 10638 10639 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10636 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.
10682 10683 10684 10685 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10682 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.
10738 10739 10740 10741 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10738 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.
10792 10793 10794 10795 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10792 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.
10840 10841 10842 10843 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10840 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.
10884 10885 10886 10887 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10884 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.
10929 10930 10931 10932 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10929 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.
10976 10977 10978 10979 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10976 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.
11034 11035 11036 11037 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11034 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.
11082 11083 11084 11085 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11082 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.
11131 11132 11133 11134 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11131 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.
11178 11179 11180 11181 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11178 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.
11226 11227 11228 11229 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11226 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.
11280 11281 11282 11283 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11280 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.
11362 11363 11364 11365 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11362 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.
11410 11411 11412 11413 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11410 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.
11462 11463 11464 11465 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11462 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.
11518 11519 11520 11521 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11518 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.
11573 11574 11575 11576 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11573 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.
11623 11624 11625 11626 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11623 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.
11736 11737 11738 11739 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11736 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).
11766 11767 11768 11769 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11766 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.
11865 11866 11867 11868 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11865 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.
11919 11920 11921 11922 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11919 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.
11957 11958 11959 11960 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11957 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.
12014 12015 12016 12017 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12014 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.
12055 12056 12057 12058 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12055 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.
12099 12100 12101 12102 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12099 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.
12142 12143 12144 12145 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12142 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.
12594 12595 12596 12597 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12594 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.
12678 12679 12680 12681 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12678 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.
12713 12714 12715 12716 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12713 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.
12746 12747 12748 12749 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12746 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.
12778 12779 12780 12781 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12778 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.
12811 12812 12813 12814 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12811 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.
12845 12846 12847 12848 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12845 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.
12909 12910 12911 12912 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12909 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.
12980 12981 12982 12983 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12980 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.
13016 13017 13018 13019 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13016 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.
13063 13064 13065 13066 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13063 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.
13090 13091 13092 13093 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13090 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.
13126 13127 13128 13129 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13126 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.
13206 13207 13208 13209 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13206 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.
13281 13282 13283 13284 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13281 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.
13334 13335 13336 13337 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13334 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.
13364 13365 13366 13367 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13364 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.
13426 13427 13428 13429 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13426 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.
13484 13485 13486 13487 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13484 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.
13542 13543 13544 13545 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13542 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.
13587 13588 13589 13590 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13587 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.
13637 13638 13639 13640 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13637 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.
13685 13686 13687 13688 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13685 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.
13730 13731 13732 13733 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13730 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.
13778 13779 13780 13781 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13778 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.
13829 13830 13831 13832 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13829 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.
13892 13893 13894 13895 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13892 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.
13961 13962 13963 13964 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13961 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.
13992 13993 13994 13995 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13992 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.
14063 14064 14065 14066 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14063 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.
14134 14135 14136 14137 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14134 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.
14239 14240 14241 14242 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14239 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.
14304 14305 14306 14307 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14304 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.
14360 14361 14362 14363 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14360 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.
14401 14402 14403 14404 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14401 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.
14468 14469 14470 14471 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14468 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.
14529 14530 14531 14532 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14529 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.
14574 14575 14576 14577 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14574 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.
14635 14636 14637 14638 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14635 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.
14828 14829 14830 14831 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14828 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.
14889 14890 14891 14892 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14889 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.
14949 14950 14951 14952 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14949 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.
14998 14999 15000 15001 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14998 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.
15040 15041 15042 15043 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15040 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.
15101 15102 15103 15104 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15101 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.
15169 15170 15171 15172 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15169 def validate_security_profile_behaviors(params = {}, = {}) req = build_request(:validate_security_profile_behaviors, params) req.send_request() end |