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_sbom_with_package_version(params = {}) ⇒ Types::AssociateSbomWithPackageVersionResponse
Associates the selected software bill of materials (SBOM) with a specific software package version.
-
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_command(params = {}) ⇒ Types::CreateCommandResponse
Creates a command.
-
#create_custom_metric(params = {}) ⇒ Types::CreateCustomMetricResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#create_dimension(params = {}) ⇒ Types::CreateDimensionResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_command(params = {}) ⇒ Types::DeleteCommandResponse
Delete a command resource.
-
#delete_command_execution(params = {}) ⇒ Struct
Delete a command execution.
-
#delete_custom_metric(params = {}) ⇒ Struct
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#delete_dimension(params = {}) ⇒ Struct
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#describe_default_authorizer(params = {}) ⇒ Types::DescribeDefaultAuthorizerResponse
Describes the default authorizer.
-
#describe_detect_mitigation_actions_task(params = {}) ⇒ Types::DescribeDetectMitigationActionsTaskResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#describe_dimension(params = {}) ⇒ Types::DescribeDimensionResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#describe_domain_configuration(params = {}) ⇒ Types::DescribeDomainConfigurationResponse
Gets summary information about a domain configuration.
-
#describe_encryption_configuration(params = {}) ⇒ Types::DescribeEncryptionConfigurationResponse
Retrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core.
-
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#detach_thing_principal(params = {}) ⇒ Struct
Detaches the specified principal from the specified thing.
-
#disable_topic_rule(params = {}) ⇒ Struct
Disables the rule.
-
#disassociate_sbom_from_package_version(params = {}) ⇒ Struct
Disassociates the selected software bill of materials (SBOM) from a specific software package version.
-
#enable_topic_rule(params = {}) ⇒ Struct
Enables the rule.
-
#get_behavior_model_training_summaries(params = {}) ⇒ Types::GetBehaviorModelTrainingSummariesResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_command(params = {}) ⇒ Types::GetCommandResponse
Gets information about the specified command.
-
#get_command_execution(params = {}) ⇒ Types::GetCommandExecutionResponse
Gets information about the specific command execution on a single device.
-
#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_thing_connectivity_data(params = {}) ⇒ Types::GetThingConnectivityDataResponse
Retrieves the live connectivity status per device.
-
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_command_executions(params = {}) ⇒ Types::ListCommandExecutionsResponse
List all command executions.
-
#list_commands(params = {}) ⇒ Types::ListCommandsResponse
List all commands in your account.
-
#list_custom_metrics(params = {}) ⇒ Types::ListCustomMetricsResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#list_detect_mitigation_actions_executions(params = {}) ⇒ Types::ListDetectMitigationActionsExecutionsResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#list_detect_mitigation_actions_tasks(params = {}) ⇒ Types::ListDetectMitigationActionsTasksResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#list_dimensions(params = {}) ⇒ Types::ListDimensionsResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_principal_things_v2(params = {}) ⇒ Types::ListPrincipalThingsV2Response
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_sbom_validation_results(params = {}) ⇒ Types::ListSbomValidationResultsResponse
The validation results for all software bill of materials (SBOM) attached to a specific software package version.
-
#list_scheduled_audits(params = {}) ⇒ Types::ListScheduledAuditsResponse
Lists all of your scheduled audits.
-
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#list_security_profiles_for_target(params = {}) ⇒ Types::ListSecurityProfilesForTargetResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_principals_v2(params = {}) ⇒ Types::ListThingPrincipalsV2Response
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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#put_verification_state_on_violation(params = {}) ⇒ Struct
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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
Searches the specified 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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_command(params = {}) ⇒ Types::UpdateCommandResponse
Update information about a command or mark a command for deprecation.
-
#update_custom_metric(params = {}) ⇒ Types::UpdateCustomMetricResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#update_dimension(params = {}) ⇒ Types::UpdateDimensionResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_encryption_configuration(params = {}) ⇒ Struct
Updates the encryption configuration.
-
#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
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. -
#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_thing_type(params = {}) ⇒ Struct
Updates a thing type.
-
#update_topic_rule_destination(params = {}) ⇒ Struct
Updates a topic rule destination.
-
#validate_security_profile_behaviors(params = {}) ⇒ Types::ValidateSecurityProfileBehaviorsResponse
The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026.
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.
479 480 481 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 479 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.
516 517 518 519 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 516 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.
559 560 561 562 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 559 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.
604 605 606 607 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 604 def add_thing_to_thing_group(params = {}, = {}) req = build_request(:add_thing_to_thing_group, params) req.send_request() end |
#associate_sbom_with_package_version(params = {}) ⇒ Types::AssociateSbomWithPackageVersionResponse
Associates the selected software bill of materials (SBOM) with a specific software package version.
Requires permission to access the AssociateSbomWithPackageVersion action.
670 671 672 673 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 670 def associate_sbom_with_package_version(params = {}, = {}) req = build_request(:associate_sbom_with_package_version, 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
targetSelectionfield 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.
744 745 746 747 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 744 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.
780 781 782 783 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 780 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.
816 817 818 819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 816 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.
859 860 861 862 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 859 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.
909 910 911 912 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 909 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.
937 938 939 940 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 937 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.
966 967 968 969 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 966 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.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1004 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.
1041 1042 1043 1044 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1041 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.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1096 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.
1157 1158 1159 1160 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1157 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.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1174 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.
1206 1207 1208 1209 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1206 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.
1279 1280 1281 1282 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1279 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.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1368 def (params = {}, = {}) req = build_request(:create_authorizer, params) req.send_request() end |
#create_billing_group(params = {}) ⇒ Types::CreateBillingGroupResponse
Creates a billing group. If this call is made multiple times using the
same billing group name and configuration, the call will succeed. If
this call is made with the same billing group name but different
configuration a ResourceAlreadyExistsException is thrown.
Requires permission to access the CreateBillingGroup action.
1422 1423 1424 1425 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1422 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"
1515 1516 1517 1518 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1515 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.
1591 1592 1593 1594 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1591 def create_certificate_provider(params = {}, = {}) req = build_request(:create_certificate_provider, params) req.send_request() end |
#create_command(params = {}) ⇒ Types::CreateCommandResponse
Creates a command. A command contains reusable configurations that can be applied before they are sent to the devices.
1735 1736 1737 1738 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1735 def create_command(params = {}, = {}) req = build_request(:create_command, 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.
1816 1817 1818 1819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1816 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.
1894 1895 1896 1897 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1894 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.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2074 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.
2164 2165 2166 2167 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2164 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.
2248 2249 2250 2251 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2248 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.
2461 2462 2463 2464 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2461 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.
2612 2613 2614 2615 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2612 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.
2659 2660 2661 2662 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2659 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.
2737 2738 2739 2740 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2737 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.
2918 2919 2920 2921 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2918 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.
2975 2976 2977 2978 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2975 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.
3073 3074 3075 3076 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3073 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.
3141 3142 3143 3144 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3141 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.
3200 3201 3202 3203 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3200 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.
3239 3240 3241 3242 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3239 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.
3338 3339 3340 3341 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3338 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.
3385 3386 3387 3388 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3385 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.
The value of credentialDurationSeconds must be less than or
equal to the maximum session duration of the IAM role that the role
alias references. For more information, see Modifying a role maximum
session duration (Amazon Web Services API) from the Amazon Web
Services Identity and Access Management User Guide.
3460 3461 3462 3463 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3460 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.
3529 3530 3531 3532 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3529 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.
3666 3667 3668 3669 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3666 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.
3738 3739 3740 3741 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3738 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.
3807 3808 3809 3810 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3807 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.
3877 3878 3879 3880 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3877 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. If this call is made multiple times using
the same thing type name and configuration, the call will succeed. If
this call is made with the same thing type name but different
configuration a ResourceAlreadyExistsException is thrown.
Requires permission to access the CreateThingType action.
3943 3944 3945 3946 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3943 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.
4457 4458 4459 4460 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4457 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.
4524 4525 4526 4527 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4524 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.
4553 4554 4555 4556 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4553 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.
4604 4605 4606 4607 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4604 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.
4630 4631 4632 4633 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4630 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.
4663 4664 4665 4666 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4663 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.
4690 4691 4692 4693 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4690 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.
4728 4729 4730 4731 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4728 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).
4759 4760 4761 4762 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4759 def delete_certificate_provider(params = {}, = {}) req = build_request(:delete_certificate_provider, params) req.send_request() end |
#delete_command(params = {}) ⇒ Types::DeleteCommandResponse
Delete a command resource.
4785 4786 4787 4788 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4785 def delete_command(params = {}, = {}) req = build_request(:delete_command, params) req.send_request() end |
#delete_command_execution(params = {}) ⇒ Struct
Delete a command execution.
4816 4817 4818 4819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4816 def delete_command_execution(params = {}, = {}) req = build_request(:delete_command_execution, 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.
4861 4862 4863 4864 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4861 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.
4898 4899 4900 4901 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4898 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.
4925 4926 4927 4928 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4925 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.
4955 4956 4957 4958 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4955 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.
4987 4988 4989 4990 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4987 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.
5061 5062 5063 5064 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5061 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.
5135 5136 5137 5138 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5135 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.
5155 5156 5157 5158 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5155 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.
5182 5183 5184 5185 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5182 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.
5221 5222 5223 5224 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5221 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.
5259 5260 5261 5262 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5259 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.
5296 5297 5298 5299 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5296 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.
5339 5340 5341 5342 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5339 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.
5373 5374 5375 5376 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5373 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.
5400 5401 5402 5403 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5400 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.
5431 5432 5433 5434 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5431 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.
5448 5449 5450 5451 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5448 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.
5474 5475 5476 5477 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5474 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.
5500 5501 5502 5503 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5500 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.
5543 5544 5545 5546 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5543 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.
5569 5570 5571 5572 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5569 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.
5603 5604 5605 5606 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5603 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.
5633 5634 5635 5636 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5633 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.
5664 5665 5666 5667 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5664 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.
5690 5691 5692 5693 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5690 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.
5717 5718 5719 5720 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5717 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.
5748 5749 5750 5751 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5748 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.
5781 5782 5783 5784 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5781 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.
5817 5818 5819 5820 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5817 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.
5893 5894 5895 5896 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5893 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.
5958 5959 5960 5961 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5958 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.
6029 6030 6031 6032 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6029 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.
6084 6085 6086 6087 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6084 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.
6126 6127 6128 6129 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6126 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.
6168 6169 6170 6171 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6168 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.
6216 6217 6218 6219 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6216 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.
6267 6268 6269 6270 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6267 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.
6311 6312 6313 6314 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6311 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.
6363 6364 6365 6366 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6363 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.
6397 6398 6399 6400 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6397 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.
6467 6468 6469 6470 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6467 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.
6521 6522 6523 6524 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6521 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.
6586 6587 6588 6589 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6586 def describe_domain_configuration(params = {}, = {}) req = build_request(:describe_domain_configuration, params) req.send_request() end |
#describe_encryption_configuration(params = {}) ⇒ Types::DescribeEncryptionConfigurationResponse
Retrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.
6639 6640 6641 6642 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6639 def describe_encryption_configuration(params = {}, = {}) req = build_request(:describe_encryption_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.
6702 6703 6704 6705 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6702 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.
6731 6732 6733 6734 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6731 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.
6789 6790 6791 6792 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6789 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.
6825 6826 6827 6828 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6825 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.
6917 6918 6919 6920 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6917 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.
6969 6970 6971 6972 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6969 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.
7033 7034 7035 7036 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7033 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.
7082 7083 7084 7085 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7082 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.
7137 7138 7139 7140 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7137 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.
7191 7192 7193 7194 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7191 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.
7234 7235 7236 7237 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7234 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.
7272 7273 7274 7275 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7272 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.
7315 7316 7317 7318 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7315 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.
7407 7408 7409 7410 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7407 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.
7450 7451 7452 7453 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7450 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.
7497 7498 7499 7500 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7497 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.
7554 7555 7556 7557 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7554 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.
7609 7610 7611 7612 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7609 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.
7657 7658 7659 7660 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7657 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.
7693 7694 7695 7696 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7693 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.
7732 7733 7734 7735 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7732 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.
7774 7775 7776 7777 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7774 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.
7813 7814 7815 7816 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7813 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.
7839 7840 7841 7842 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7839 def disable_topic_rule(params = {}, = {}) req = build_request(:disable_topic_rule, params) req.send_request() end |
#disassociate_sbom_from_package_version(params = {}) ⇒ Struct
Disassociates the selected software bill of materials (SBOM) from a specific software package version.
Requires permission to access the DisassociateSbomWithPackageVersion action.
7880 7881 7882 7883 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7880 def disassociate_sbom_from_package_version(params = {}, = {}) req = build_request(:disassociate_sbom_from_package_version, params) req.send_request() end |
#enable_topic_rule(params = {}) ⇒ Struct
Enables the rule.
Requires permission to access the EnableTopicRule action.
7906 7907 7908 7909 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7906 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.
7969 7970 7971 7972 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7969 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.
8027 8028 8029 8030 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8027 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.
8071 8072 8073 8074 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8071 def get_cardinality(params = {}, = {}) req = build_request(:get_cardinality, params) req.send_request() end |
#get_command(params = {}) ⇒ Types::GetCommandResponse
Gets information about the specified command.
8152 8153 8154 8155 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8152 def get_command(params = {}, = {}) req = build_request(:get_command, params) req.send_request() end |
#get_command_execution(params = {}) ⇒ Types::GetCommandExecutionResponse
Gets information about the specific command execution on a single device.
8228 8229 8230 8231 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8228 def get_command_execution(params = {}, = {}) req = build_request(:get_command_execution, 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.
8276 8277 8278 8279 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8276 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.
8324 8325 8326 8327 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8324 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.
8361 8362 8363 8364 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8361 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.
8389 8390 8391 8392 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8389 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.
8466 8467 8468 8469 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8466 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.
8508 8509 8510 8511 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8508 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.
8533 8534 8535 8536 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8533 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.
8598 8599 8600 8601 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8598 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.
8658 8659 8660 8661 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8658 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.
8703 8704 8705 8706 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8703 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.
8753 8754 8755 8756 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8753 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.
8781 8782 8783 8784 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8781 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.
8837 8838 8839 8840 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8837 def get_statistics(params = {}, = {}) req = build_request(:get_statistics, params) req.send_request() end |
#get_thing_connectivity_data(params = {}) ⇒ Types::GetThingConnectivityDataResponse
Retrieves the live connectivity status per device. If a device has
never connected to IoT Core or was disconnected for more than 1 hour
before fleet indexing's thingConnectivityIndexingMode was enabled,
the response will have the connected field set to false with no
additional session details.
8899 8900 8901 8902 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8899 def get_thing_connectivity_data(params = {}, = {}) req = build_request(:get_thing_connectivity_data, params) req.send_request() end |
#get_topic_rule(params = {}) ⇒ Types::GetTopicRuleResponse
Gets information about the rule.
Requires permission to access the GetTopicRule action.
9219 9220 9221 9222 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9219 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.
9267 9268 9269 9270 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9267 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.
9309 9310 9311 9312 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9309 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.
9421 9422 9423 9424 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9421 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.
9475 9476 9477 9478 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9475 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.
9611 9612 9613 9614 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9611 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.
9676 9677 9678 9679 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9676 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.
9747 9748 9749 9750 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9747 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.
9840 9841 9842 9843 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9840 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.
9906 9907 9908 9909 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9906 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.
9956 9957 9958 9959 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9956 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.
10004 10005 10006 10007 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10004 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.
10060 10061 10062 10063 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10060 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.
10104 10105 10106 10107 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10104 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.
10157 10158 10159 10160 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10157 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.
10212 10213 10214 10215 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10212 def list_certificates_by_ca(params = {}, = {}) req = build_request(:list_certificates_by_ca, params) req.send_request() end |
#list_command_executions(params = {}) ⇒ Types::ListCommandExecutionsResponse
List all command executions.
You must provide only the
startedTimeFilteror thecompletedTimeFilterinformation. If you provide both time filters, the API will generate an error. You can use this information to retrieve a list of command executions within a specific timeframe.You must provide only the
commandArnor thethingArninformation depending on whether you want to list executions for a specific command or an IoT thing. If you provide both fields, the API will generate an error.
For more information about considerations for using this API, see List command executions in your account (CLI).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10319 10320 10321 10322 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10319 def list_command_executions(params = {}, = {}) req = build_request(:list_command_executions, params) req.send_request() end |
#list_commands(params = {}) ⇒ Types::ListCommandsResponse
List all commands in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10384 10385 10386 10387 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10384 def list_commands(params = {}, = {}) req = build_request(:list_commands, 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.
10436 10437 10438 10439 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10436 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.
10521 10522 10523 10524 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10521 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.
10612 10613 10614 10615 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10612 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.
10664 10665 10666 10667 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10664 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.
10713 10714 10715 10716 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10713 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.
10757 10758 10759 10760 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10757 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.
10799 10800 10801 10802 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10799 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.
10854 10855 10856 10857 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10854 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.
10935 10936 10937 10938 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10935 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.
10979 10980 10981 10982 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10979 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.
11079 11080 11081 11082 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11079 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.
11125 11126 11127 11128 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11125 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.
11197 11198 11199 11200 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11197 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.
11247 11248 11249 11250 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11247 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.
11294 11295 11296 11297 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11294 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.
11346 11347 11348 11349 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11346 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.
11404 11405 11406 11407 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11404 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.
11448 11449 11450 11451 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11448 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.
11495 11496 11497 11498 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11495 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.
11549 11550 11551 11552 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11549 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.
11585 11586 11587 11588 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11585 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.
11646 11647 11648 11649 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11646 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.
11695 11696 11697 11698 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11695 def list_principal_things(params = {}, = {}) req = build_request(:list_principal_things, params) req.send_request() end |
#list_principal_things_v2(params = {}) ⇒ Types::ListPrincipalThingsV2Response
Lists the things associated with the specified principal. A principal can be an X.509 certificate or an Amazon Cognito ID.
Requires permission to access the ListPrincipalThings action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11764 11765 11766 11767 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11764 def list_principal_things_v2(params = {}, = {}) req = build_request(:list_principal_things_v2, 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.
11812 11813 11814 11815 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11812 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.
11860 11861 11862 11863 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11860 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.
11947 11948 11949 11950 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11947 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.
11992 11993 11994 11995 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11992 def list_role_aliases(params = {}, = {}) req = build_request(:list_role_aliases, params) req.send_request() end |
#list_sbom_validation_results(params = {}) ⇒ Types::ListSbomValidationResultsResponse
The validation results for all software bill of materials (SBOM) attached to a specific software package version.
Requires permission to access the ListSbomValidationResults action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12051 12052 12053 12054 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12051 def list_sbom_validation_results(params = {}, = {}) req = build_request(:list_sbom_validation_results, 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.
12097 12098 12099 12100 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12097 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.
12163 12164 12165 12166 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12163 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.
12227 12228 12229 12230 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12227 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.
12275 12276 12277 12278 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12275 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.
12319 12320 12321 12322 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12319 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.
12364 12365 12366 12367 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12364 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.
12421 12422 12423 12424 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12421 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.
12479 12480 12481 12482 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12479 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.
12527 12528 12529 12530 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12527 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.
12576 12577 12578 12579 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12576 def list_thing_principals(params = {}, = {}) req = build_request(:list_thing_principals, params) req.send_request() end |
#list_thing_principals_v2(params = {}) ⇒ Types::ListThingPrincipalsV2Response
Lists the principals associated with the specified thing. A principal can be an X.509 certificate or an Amazon Cognito ID.
Requires permission to access the ListThingPrincipals action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12644 12645 12646 12647 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12644 def list_thing_principals_v2(params = {}, = {}) req = build_request(:list_thing_principals_v2, 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.
12691 12692 12693 12694 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12691 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.
12739 12740 12741 12742 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12739 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.
12797 12798 12799 12800 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12797 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.
12879 12880 12881 12882 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12879 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.
12927 12928 12929 12930 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12927 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.
12979 12980 12981 12982 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12979 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.
13040 13041 13042 13043 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13040 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.
13095 13096 13097 13098 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13095 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.
13145 13146 13147 13148 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13145 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.
13268 13269 13270 13271 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13268 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).
13308 13309 13310 13311 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13308 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.
13407 13408 13409 13410 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13407 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.
13461 13462 13463 13464 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13461 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.
13499 13500 13501 13502 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13499 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.
13556 13557 13558 13559 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13556 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.
13597 13598 13599 13600 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13597 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.
13641 13642 13643 13644 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13641 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.
13684 13685 13686 13687 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13684 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.
14184 14185 14186 14187 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14184 def replace_topic_rule(params = {}, = {}) req = build_request(:replace_topic_rule, params) req.send_request() end |
#search_index(params = {}) ⇒ Types::SearchIndexResponse
Searches the specified index.
If a device has never connected to IoT Core or was disconnected for
more than 1 hour before fleet indexing's
thingConnectivityIndexingMode was enabled, the connectivity object
for this device in the response will have the connected field set to
false with no additional session details.
Requires permission to access the SearchIndex action.
14278 14279 14280 14281 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14278 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.
14313 14314 14315 14316 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14313 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.
14346 14347 14348 14349 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14346 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.
14378 14379 14380 14381 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14378 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.
14411 14412 14413 14414 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14411 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.
14455 14456 14457 14458 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14455 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.
14519 14520 14521 14522 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14519 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.
14600 14601 14602 14603 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14600 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.
14636 14637 14638 14639 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14636 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.
14683 14684 14685 14686 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14683 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.
14710 14711 14712 14713 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14710 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.
14746 14747 14748 14749 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14746 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.
14825 14826 14827 14828 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14825 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.
14900 14901 14902 14903 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14900 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 accepted by the recipient.
No notification is sent to the transfer destination's account. The caller is responsible for notifying 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.
Customer managed key behavior: When you use a customer managed key
to encrypt your data and then transfer the certificate to a customer
in a different account using the TransferCertificate operation, the
certificates will no longer be encrypted by their customer managed key
configuration. During the transfer process, certificates are encrypted
using Amazon Web Services IoT Core owned keys.
While a certificate is in the PENDING_TRANSFER state, it's always protected by Amazon Web Services IoT Core owned keys, regardless of the customer managed key configuration of either the source or destination account.
Once the transfer is completed through AcceptCertificateTransfer, RejectCertificateTransfer, or CancelCertificateTransfer, the certificate will be protected by the customer managed key configuration of the account that owns the certificate after the transfer operation:
If the transfer is accepted: The certificate is encrypted by the target account's customer managed key configuration.
If the transfer is rejected or cancelled: The certificate is protected by the source account's customer managed key configuration.
14978 14979 14980 14981 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14978 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.
15008 15009 15010 15011 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15008 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.
15073 15074 15075 15076 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15073 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.
15131 15132 15133 15134 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15131 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.
15189 15190 15191 15192 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15189 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.
15234 15235 15236 15237 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15234 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.
15284 15285 15286 15287 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15284 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.
15332 15333 15334 15335 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15332 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.
15377 15378 15379 15380 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15377 def update_certificate_provider(params = {}, = {}) req = build_request(:update_certificate_provider, params) req.send_request() end |
#update_command(params = {}) ⇒ Types::UpdateCommandResponse
Update information about a command or mark a command for deprecation.
15423 15424 15425 15426 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15423 def update_command(params = {}, = {}) req = build_request(:update_command, 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.
15481 15482 15483 15484 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15481 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.
15542 15543 15544 15545 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15542 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.
15684 15685 15686 15687 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15684 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.
15753 15754 15755 15756 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15753 def update_dynamic_thing_group(params = {}, = {}) req = build_request(:update_dynamic_thing_group, params) req.send_request() end |
#update_encryption_configuration(params = {}) ⇒ Struct
Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account.
Before using this API, you must set up permissions for Amazon Web Services IoT Core to access KMS. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.
15807 15808 15809 15810 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15807 def update_encryption_configuration(params = {}, = {}) req = build_request(:update_encryption_configuration, params) req.send_request() end |
#update_event_configurations(params = {}) ⇒ Struct
Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
15838 15839 15840 15841 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15838 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.
15909 15910 15911 15912 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15909 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.
15983 15984 15985 15986 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15983 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.
16088 16089 16090 16091 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16088 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.
16153 16154 16155 16156 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16153 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.
16209 16210 16211 16212 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16209 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.
16250 16251 16252 16253 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16250 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.
16332 16333 16334 16335 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16332 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.
16393 16394 16395 16396 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16393 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.
The value of credentialDurationSeconds must be less than or
equal to the maximum session duration of the IAM role that the role
alias references. For more information, see Modifying a role maximum
session duration (Amazon Web Services API) from the Amazon Web
Services Identity and Access Management User Guide.
16446 16447 16448 16449 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16446 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.
16507 16508 16509 16510 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16507 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.
16710 16711 16712 16713 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16710 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.
16771 16772 16773 16774 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16771 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.
16831 16832 16833 16834 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16831 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.
16880 16881 16882 16883 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16880 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.
16922 16923 16924 16925 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16922 def update_thing_groups_for_thing(params = {}, = {}) req = build_request(:update_thing_groups_for_thing, params) req.send_request() end |
#update_thing_type(params = {}) ⇒ Struct
Updates a thing type.
16960 16961 16962 16963 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 16960 def update_thing_type(params = {}, = {}) req = build_request(:update_thing_type, 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.
17021 17022 17023 17024 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 17021 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.
17099 17100 17101 17102 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 17099 def validate_security_profile_behaviors(params = {}, = {}) req = build_request(:validate_security_profile_behaviors, params) req.send_request() end |