Class: Aws::IoT::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoT::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb
Overview
An API client for IoT. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoT::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_certificate_transfer(params = {}) ⇒ Struct
Accepts a pending certificate transfer.
-
#add_thing_to_billing_group(params = {}) ⇒ Struct
Adds a thing to a billing group.
-
#add_thing_to_thing_group(params = {}) ⇒ Struct
Adds a thing to a thing group.
-
#associate_targets_with_job(params = {}) ⇒ Types::AssociateTargetsWithJobResponse
Associates a group with a continuous job.
-
#attach_policy(params = {}) ⇒ Struct
Attaches the specified policy to the specified principal (certificate or other credential).
-
#attach_principal_policy(params = {}) ⇒ Struct
Attaches the specified policy to the specified principal (certificate or other credential).
-
#attach_security_profile(params = {}) ⇒ Struct
Associates a Device Defender security profile with a thing group or this account.
-
#attach_thing_principal(params = {}) ⇒ Struct
Attaches the specified principal to the specified thing.
-
#cancel_audit_mitigation_actions_task(params = {}) ⇒ Struct
Cancels a mitigation action task that is in progress.
-
#cancel_audit_task(params = {}) ⇒ Struct
Cancels an audit that is in progress.
-
#cancel_certificate_transfer(params = {}) ⇒ Struct
Cancels a pending transfer for the specified certificate.
-
#cancel_detect_mitigation_actions_task(params = {}) ⇒ Struct
Cancels a Device Defender ML Detect mitigation action.
-
#cancel_job(params = {}) ⇒ Types::CancelJobResponse
Cancels a job.
-
#cancel_job_execution(params = {}) ⇒ Struct
Cancels the execution of a job for a given thing.
-
#clear_default_authorizer(params = {}) ⇒ Struct
Clears the default authorizer.
-
#confirm_topic_rule_destination(params = {}) ⇒ Struct
Confirms a topic rule destination.
-
#create_audit_suppression(params = {}) ⇒ Struct
Creates a Device Defender audit suppression.
-
#create_authorizer(params = {}) ⇒ Types::CreateAuthorizerResponse
Creates an authorizer.
-
#create_billing_group(params = {}) ⇒ Types::CreateBillingGroupResponse
Creates a billing group.
-
#create_certificate_from_csr(params = {}) ⇒ Types::CreateCertificateFromCsrResponse
Creates an X.509 certificate using the specified certificate signing request.
-
#create_certificate_provider(params = {}) ⇒ Types::CreateCertificateProviderResponse
Creates an Amazon Web Services IoT Core certificate provider.
-
#create_custom_metric(params = {}) ⇒ Types::CreateCustomMetricResponse
Use this API to define a Custom Metric published by your devices to Device Defender.
-
#create_dimension(params = {}) ⇒ Types::CreateDimensionResponse
Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender.
-
#create_domain_configuration(params = {}) ⇒ Types::CreateDomainConfigurationResponse
Creates a domain configuration.
-
#create_dynamic_thing_group(params = {}) ⇒ Types::CreateDynamicThingGroupResponse
Creates a dynamic thing group.
-
#create_fleet_metric(params = {}) ⇒ Types::CreateFleetMetricResponse
Creates a fleet metric.
-
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates a job.
-
#create_job_template(params = {}) ⇒ Types::CreateJobTemplateResponse
Creates a job template.
-
#create_keys_and_certificate(params = {}) ⇒ Types::CreateKeysAndCertificateResponse
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
-
#create_mitigation_action(params = {}) ⇒ Types::CreateMitigationActionResponse
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.
-
#create_ota_update(params = {}) ⇒ Types::CreateOTAUpdateResponse
Creates an IoT OTA update on a target group of things or groups.
-
#create_package(params = {}) ⇒ Types::CreatePackageResponse
Creates an IoT software package that can be deployed to your fleet.
-
#create_package_version(params = {}) ⇒ Types::CreatePackageVersionResponse
Creates a new version for an existing IoT software package.
-
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates an IoT policy.
-
#create_policy_version(params = {}) ⇒ Types::CreatePolicyVersionResponse
Creates a new version of the specified IoT policy.
-
#create_provisioning_claim(params = {}) ⇒ Types::CreateProvisioningClaimResponse
Creates a provisioning claim.
-
#create_provisioning_template(params = {}) ⇒ Types::CreateProvisioningTemplateResponse
Creates a provisioning template.
-
#create_provisioning_template_version(params = {}) ⇒ Types::CreateProvisioningTemplateVersionResponse
Creates a new version of a provisioning template.
-
#create_role_alias(params = {}) ⇒ Types::CreateRoleAliasResponse
Creates a role alias.
-
#create_scheduled_audit(params = {}) ⇒ Types::CreateScheduledAuditResponse
Creates a scheduled audit that is run at a specified time interval.
-
#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse
Creates a Device Defender security profile.
-
#create_stream(params = {}) ⇒ Types::CreateStreamResponse
Creates a stream for delivering one or more large files in chunks over MQTT.
-
#create_thing(params = {}) ⇒ Types::CreateThingResponse
Creates a thing record in the registry.
-
#create_thing_group(params = {}) ⇒ Types::CreateThingGroupResponse
Create a thing group.
-
#create_thing_type(params = {}) ⇒ Types::CreateThingTypeResponse
Creates a new thing type.
-
#create_topic_rule(params = {}) ⇒ Struct
Creates a rule.
-
#create_topic_rule_destination(params = {}) ⇒ Types::CreateTopicRuleDestinationResponse
Creates a topic rule destination.
-
#delete_account_audit_configuration(params = {}) ⇒ Struct
Restores the default settings for Device Defender audits for this account.
-
#delete_audit_suppression(params = {}) ⇒ Struct
Deletes a Device Defender audit suppression.
-
#delete_authorizer(params = {}) ⇒ Struct
Deletes an authorizer.
-
#delete_billing_group(params = {}) ⇒ Struct
Deletes the billing group.
-
#delete_ca_certificate(params = {}) ⇒ Struct
Deletes a registered CA certificate.
-
#delete_certificate(params = {}) ⇒ Struct
Deletes the specified certificate.
-
#delete_certificate_provider(params = {}) ⇒ Struct
Deletes a certificate provider.
-
#delete_custom_metric(params = {}) ⇒ Struct
Deletes a Device Defender detect custom metric.
-
#delete_dimension(params = {}) ⇒ Struct
Removes the specified dimension from your Amazon Web Services accounts.
-
#delete_domain_configuration(params = {}) ⇒ Struct
Deletes the specified domain configuration.
-
#delete_dynamic_thing_group(params = {}) ⇒ Struct
Deletes a dynamic thing group.
-
#delete_fleet_metric(params = {}) ⇒ Struct
Deletes the specified fleet metric.
-
#delete_job(params = {}) ⇒ Struct
Deletes a job and its related job executions.
-
#delete_job_execution(params = {}) ⇒ Struct
Deletes a job execution.
-
#delete_job_template(params = {}) ⇒ Struct
Deletes the specified job template.
-
#delete_mitigation_action(params = {}) ⇒ Struct
Deletes a defined mitigation action from your Amazon Web Services accounts.
-
#delete_ota_update(params = {}) ⇒ Struct
Delete an OTA update.
-
#delete_package(params = {}) ⇒ Struct
Deletes a specific version from a software package.
-
#delete_package_version(params = {}) ⇒ Struct
Deletes a specific version from a software package.
-
#delete_policy(params = {}) ⇒ Struct
Deletes the specified policy.
-
#delete_policy_version(params = {}) ⇒ Struct
Deletes the specified version of the specified policy.
-
#delete_provisioning_template(params = {}) ⇒ Struct
Deletes a provisioning template.
-
#delete_provisioning_template_version(params = {}) ⇒ Struct
Deletes a provisioning template version.
-
#delete_registration_code(params = {}) ⇒ Struct
Deletes a CA certificate registration code.
-
#delete_role_alias(params = {}) ⇒ Struct
Deletes a role alias.
-
#delete_scheduled_audit(params = {}) ⇒ Struct
Deletes a scheduled audit.
-
#delete_security_profile(params = {}) ⇒ Struct
Deletes a Device Defender security profile.
-
#delete_stream(params = {}) ⇒ Struct
Deletes a stream.
-
#delete_thing(params = {}) ⇒ Struct
Deletes the specified thing.
-
#delete_thing_group(params = {}) ⇒ Struct
Deletes a thing group.
-
#delete_thing_type(params = {}) ⇒ Struct
Deletes the specified thing type.
-
#delete_topic_rule(params = {}) ⇒ Struct
Deletes the rule.
-
#delete_topic_rule_destination(params = {}) ⇒ Struct
Deletes a topic rule destination.
-
#delete_v2_logging_level(params = {}) ⇒ Struct
Deletes a logging level.
-
#deprecate_thing_type(params = {}) ⇒ Struct
Deprecates a thing type.
-
#describe_account_audit_configuration(params = {}) ⇒ Types::DescribeAccountAuditConfigurationResponse
Gets information about the Device Defender audit settings for this account.
-
#describe_audit_finding(params = {}) ⇒ Types::DescribeAuditFindingResponse
Gets information about a single audit finding.
-
#describe_audit_mitigation_actions_task(params = {}) ⇒ Types::DescribeAuditMitigationActionsTaskResponse
Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.
-
#describe_audit_suppression(params = {}) ⇒ Types::DescribeAuditSuppressionResponse
Gets information about a Device Defender audit suppression.
-
#describe_audit_task(params = {}) ⇒ Types::DescribeAuditTaskResponse
Gets information about a Device Defender audit.
-
#describe_authorizer(params = {}) ⇒ Types::DescribeAuthorizerResponse
Describes an authorizer.
-
#describe_billing_group(params = {}) ⇒ Types::DescribeBillingGroupResponse
Returns information about a billing group.
-
#describe_ca_certificate(params = {}) ⇒ Types::DescribeCACertificateResponse
Describes a registered CA certificate.
-
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResponse
Gets information about the specified certificate.
-
#describe_certificate_provider(params = {}) ⇒ Types::DescribeCertificateProviderResponse
Describes a certificate provider.
-
#describe_custom_metric(params = {}) ⇒ Types::DescribeCustomMetricResponse
Gets information about a Device Defender detect custom metric.
-
#describe_default_authorizer(params = {}) ⇒ Types::DescribeDefaultAuthorizerResponse
Describes the default authorizer.
-
#describe_detect_mitigation_actions_task(params = {}) ⇒ Types::DescribeDetectMitigationActionsTaskResponse
Gets information about a Device Defender ML Detect mitigation action.
-
#describe_dimension(params = {}) ⇒ Types::DescribeDimensionResponse
Provides details about a dimension that is defined in your Amazon Web Services accounts.
-
#describe_domain_configuration(params = {}) ⇒ Types::DescribeDomainConfigurationResponse
Gets summary information about a domain configuration.
-
#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse
Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.
-
#describe_event_configurations(params = {}) ⇒ Types::DescribeEventConfigurationsResponse
Describes event configurations.
-
#describe_fleet_metric(params = {}) ⇒ Types::DescribeFleetMetricResponse
Gets information about the specified fleet metric.
-
#describe_index(params = {}) ⇒ Types::DescribeIndexResponse
Describes a search index.
-
#describe_job(params = {}) ⇒ Types::DescribeJobResponse
Describes a job.
-
#describe_job_execution(params = {}) ⇒ Types::DescribeJobExecutionResponse
Describes a job execution.
-
#describe_job_template(params = {}) ⇒ Types::DescribeJobTemplateResponse
Returns information about a job template.
-
#describe_managed_job_template(params = {}) ⇒ Types::DescribeManagedJobTemplateResponse
View details of a managed job template.
-
#describe_mitigation_action(params = {}) ⇒ Types::DescribeMitigationActionResponse
Gets information about a mitigation action.
-
#describe_provisioning_template(params = {}) ⇒ Types::DescribeProvisioningTemplateResponse
Returns information about a provisioning template.
-
#describe_provisioning_template_version(params = {}) ⇒ Types::DescribeProvisioningTemplateVersionResponse
Returns information about a provisioning template version.
-
#describe_role_alias(params = {}) ⇒ Types::DescribeRoleAliasResponse
Describes a role alias.
-
#describe_scheduled_audit(params = {}) ⇒ Types::DescribeScheduledAuditResponse
Gets information about a scheduled audit.
-
#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse
Gets information about a Device Defender security profile.
-
#describe_stream(params = {}) ⇒ Types::DescribeStreamResponse
Gets information about a stream.
-
#describe_thing(params = {}) ⇒ Types::DescribeThingResponse
Gets information about the specified thing.
-
#describe_thing_group(params = {}) ⇒ Types::DescribeThingGroupResponse
Describe a thing group.
-
#describe_thing_registration_task(params = {}) ⇒ Types::DescribeThingRegistrationTaskResponse
Describes a bulk thing provisioning task.
-
#describe_thing_type(params = {}) ⇒ Types::DescribeThingTypeResponse
Gets information about the specified thing type.
-
#detach_policy(params = {}) ⇒ Struct
Detaches a policy from the specified target.
-
#detach_principal_policy(params = {}) ⇒ Struct
Removes the specified policy from the specified certificate.
-
#detach_security_profile(params = {}) ⇒ Struct
Disassociates a Device Defender security profile from a thing group or from this account.
-
#detach_thing_principal(params = {}) ⇒ Struct
Detaches the specified principal from the specified thing.
-
#disable_topic_rule(params = {}) ⇒ Struct
Disables the rule.
-
#enable_topic_rule(params = {}) ⇒ Struct
Enables the rule.
-
#get_behavior_model_training_summaries(params = {}) ⇒ Types::GetBehaviorModelTrainingSummariesResponse
Returns a Device Defender's ML Detect Security Profile training model's status.
-
#get_buckets_aggregation(params = {}) ⇒ Types::GetBucketsAggregationResponse
Aggregates on indexed data with search queries pertaining to particular fields.
-
#get_cardinality(params = {}) ⇒ Types::GetCardinalityResponse
Returns the approximate count of unique values that match the query.
-
#get_effective_policies(params = {}) ⇒ Types::GetEffectivePoliciesResponse
Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.
-
#get_indexing_configuration(params = {}) ⇒ Types::GetIndexingConfigurationResponse
Gets the indexing configuration.
-
#get_job_document(params = {}) ⇒ Types::GetJobDocumentResponse
Gets a job document.
-
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Gets the logging options.
-
#get_ota_update(params = {}) ⇒ Types::GetOTAUpdateResponse
Gets an OTA update.
-
#get_package(params = {}) ⇒ Types::GetPackageResponse
Gets information about the specified software package.
-
#get_package_configuration(params = {}) ⇒ Types::GetPackageConfigurationResponse
Gets information about the specified software package's configuration.
-
#get_package_version(params = {}) ⇒ Types::GetPackageVersionResponse
Gets information about the specified package version.
-
#get_percentiles(params = {}) ⇒ Types::GetPercentilesResponse
Groups the aggregated values that match the query into percentile groupings.
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Gets information about the specified policy with the policy document of the default version.
-
#get_policy_version(params = {}) ⇒ Types::GetPolicyVersionResponse
Gets information about the specified policy version.
-
#get_registration_code(params = {}) ⇒ Types::GetRegistrationCodeResponse
Gets a registration code used to register a CA certificate with IoT.
-
#get_statistics(params = {}) ⇒ Types::GetStatisticsResponse
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.
-
#get_topic_rule(params = {}) ⇒ Types::GetTopicRuleResponse
Gets information about the rule.
-
#get_topic_rule_destination(params = {}) ⇒ Types::GetTopicRuleDestinationResponse
Gets information about a topic rule destination.
-
#get_v2_logging_options(params = {}) ⇒ Types::GetV2LoggingOptionsResponse
Gets the fine grained logging options.
-
#list_active_violations(params = {}) ⇒ Types::ListActiveViolationsResponse
Lists the active violations for a given Device Defender security profile.
-
#list_attached_policies(params = {}) ⇒ Types::ListAttachedPoliciesResponse
Lists the policies attached to the specified thing group.
-
#list_audit_findings(params = {}) ⇒ Types::ListAuditFindingsResponse
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.
-
#list_audit_mitigation_actions_executions(params = {}) ⇒ Types::ListAuditMitigationActionsExecutionsResponse
Gets the status of audit mitigation action tasks that were executed.
-
#list_audit_mitigation_actions_tasks(params = {}) ⇒ Types::ListAuditMitigationActionsTasksResponse
Gets a list of audit mitigation action tasks that match the specified filters.
-
#list_audit_suppressions(params = {}) ⇒ Types::ListAuditSuppressionsResponse
Lists your Device Defender audit listings.
-
#list_audit_tasks(params = {}) ⇒ Types::ListAuditTasksResponse
Lists the Device Defender audits that have been performed during a given time period.
-
#list_authorizers(params = {}) ⇒ Types::ListAuthorizersResponse
Lists the authorizers registered in your account.
-
#list_billing_groups(params = {}) ⇒ Types::ListBillingGroupsResponse
Lists the billing groups you have created.
-
#list_ca_certificates(params = {}) ⇒ Types::ListCACertificatesResponse
Lists the CA certificates registered for your Amazon Web Services account.
-
#list_certificate_providers(params = {}) ⇒ Types::ListCertificateProvidersResponse
Lists all your certificate providers in your Amazon Web Services account.
-
#list_certificates(params = {}) ⇒ Types::ListCertificatesResponse
Lists the certificates registered in your Amazon Web Services account.
-
#list_certificates_by_ca(params = {}) ⇒ Types::ListCertificatesByCAResponse
List the device certificates signed by the specified CA certificate.
-
#list_custom_metrics(params = {}) ⇒ Types::ListCustomMetricsResponse
Lists your Device Defender detect custom metrics.
-
#list_detect_mitigation_actions_executions(params = {}) ⇒ Types::ListDetectMitigationActionsExecutionsResponse
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
-
#list_detect_mitigation_actions_tasks(params = {}) ⇒ Types::ListDetectMitigationActionsTasksResponse
List of Device Defender ML Detect mitigation actions tasks.
-
#list_dimensions(params = {}) ⇒ Types::ListDimensionsResponse
List the set of dimensions that are defined for your Amazon Web Services accounts.
-
#list_domain_configurations(params = {}) ⇒ Types::ListDomainConfigurationsResponse
Gets a list of domain configurations for the user.
-
#list_fleet_metrics(params = {}) ⇒ Types::ListFleetMetricsResponse
Lists all your fleet metrics.
-
#list_indices(params = {}) ⇒ Types::ListIndicesResponse
Lists the search indices.
-
#list_job_executions_for_job(params = {}) ⇒ Types::ListJobExecutionsForJobResponse
Lists the job executions for a job.
-
#list_job_executions_for_thing(params = {}) ⇒ Types::ListJobExecutionsForThingResponse
Lists the job executions for the specified thing.
-
#list_job_templates(params = {}) ⇒ Types::ListJobTemplatesResponse
Returns a list of job templates.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Lists jobs.
-
#list_managed_job_templates(params = {}) ⇒ Types::ListManagedJobTemplatesResponse
Returns a list of managed job templates.
-
#list_metric_values(params = {}) ⇒ Types::ListMetricValuesResponse
Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.
-
#list_mitigation_actions(params = {}) ⇒ Types::ListMitigationActionsResponse
Gets a list of all mitigation actions that match the specified filter criteria.
-
#list_ota_updates(params = {}) ⇒ Types::ListOTAUpdatesResponse
Lists OTA updates.
-
#list_outgoing_certificates(params = {}) ⇒ Types::ListOutgoingCertificatesResponse
Lists certificates that are being transferred but not yet accepted.
-
#list_package_versions(params = {}) ⇒ Types::ListPackageVersionsResponse
Lists the software package versions associated to the account.
-
#list_packages(params = {}) ⇒ Types::ListPackagesResponse
Lists the software packages associated to the account.
-
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Lists your policies.
-
#list_policy_principals(params = {}) ⇒ Types::ListPolicyPrincipalsResponse
Lists the principals associated with the specified policy.
-
#list_policy_versions(params = {}) ⇒ Types::ListPolicyVersionsResponse
Lists the versions of the specified policy and identifies the default version.
-
#list_principal_policies(params = {}) ⇒ Types::ListPrincipalPoliciesResponse
Lists the policies attached to the specified principal.
-
#list_principal_things(params = {}) ⇒ Types::ListPrincipalThingsResponse
Lists the things associated with the specified principal.
-
#list_provisioning_template_versions(params = {}) ⇒ Types::ListProvisioningTemplateVersionsResponse
A list of provisioning template versions.
-
#list_provisioning_templates(params = {}) ⇒ Types::ListProvisioningTemplatesResponse
Lists the provisioning templates in your Amazon Web Services account.
-
#list_related_resources_for_audit_finding(params = {}) ⇒ Types::ListRelatedResourcesForAuditFindingResponse
The related resources of an Audit finding.
-
#list_role_aliases(params = {}) ⇒ Types::ListRoleAliasesResponse
Lists the role aliases registered in your account.
-
#list_scheduled_audits(params = {}) ⇒ Types::ListScheduledAuditsResponse
Lists all of your scheduled audits.
-
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
Lists the Device Defender security profiles you've created.
-
#list_security_profiles_for_target(params = {}) ⇒ Types::ListSecurityProfilesForTargetResponse
Lists the Device Defender security profiles attached to a target (thing group).
-
#list_streams(params = {}) ⇒ Types::ListStreamsResponse
Lists all of the streams in your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
-
#list_targets_for_policy(params = {}) ⇒ Types::ListTargetsForPolicyResponse
List targets for the specified policy.
-
#list_targets_for_security_profile(params = {}) ⇒ Types::ListTargetsForSecurityProfileResponse
Lists the targets (thing groups) associated with a given Device Defender security profile.
-
#list_thing_groups(params = {}) ⇒ Types::ListThingGroupsResponse
List the thing groups in your account.
-
#list_thing_groups_for_thing(params = {}) ⇒ Types::ListThingGroupsForThingResponse
List the thing groups to which the specified thing belongs.
-
#list_thing_principals(params = {}) ⇒ Types::ListThingPrincipalsResponse
Lists the principals associated with the specified thing.
-
#list_thing_registration_task_reports(params = {}) ⇒ Types::ListThingRegistrationTaskReportsResponse
Information about the thing registration tasks.
-
#list_thing_registration_tasks(params = {}) ⇒ Types::ListThingRegistrationTasksResponse
List bulk thing provisioning tasks.
-
#list_thing_types(params = {}) ⇒ Types::ListThingTypesResponse
Lists the existing thing types.
-
#list_things(params = {}) ⇒ Types::ListThingsResponse
Lists your things.
-
#list_things_in_billing_group(params = {}) ⇒ Types::ListThingsInBillingGroupResponse
Lists the things you have added to the given billing group.
-
#list_things_in_thing_group(params = {}) ⇒ Types::ListThingsInThingGroupResponse
Lists the things in the specified group.
-
#list_topic_rule_destinations(params = {}) ⇒ Types::ListTopicRuleDestinationsResponse
Lists all the topic rule destinations in your Amazon Web Services account.
-
#list_topic_rules(params = {}) ⇒ Types::ListTopicRulesResponse
Lists the rules for the specific topic.
-
#list_v2_logging_levels(params = {}) ⇒ Types::ListV2LoggingLevelsResponse
Lists logging levels.
-
#list_violation_events(params = {}) ⇒ Types::ListViolationEventsResponse
Lists the Device Defender security profile violations discovered during the given time period.
-
#put_verification_state_on_violation(params = {}) ⇒ Struct
Set a verification state and provide a description of that verification state on a violation (detect alarm).
-
#register_ca_certificate(params = {}) ⇒ Types::RegisterCACertificateResponse
Registers a CA certificate with Amazon Web Services IoT Core.
-
#register_certificate(params = {}) ⇒ Types::RegisterCertificateResponse
Registers a device certificate with IoT in the same [certificate mode][1] as the signing CA.
-
#register_certificate_without_ca(params = {}) ⇒ Types::RegisterCertificateWithoutCAResponse
Register a certificate that does not have a certificate authority (CA).
-
#register_thing(params = {}) ⇒ Types::RegisterThingResponse
Provisions a thing in the device registry.
-
#reject_certificate_transfer(params = {}) ⇒ Struct
Rejects a pending certificate transfer.
-
#remove_thing_from_billing_group(params = {}) ⇒ Struct
Removes the given thing from the billing group.
-
#remove_thing_from_thing_group(params = {}) ⇒ Struct
Remove the specified thing from the specified group.
-
#replace_topic_rule(params = {}) ⇒ Struct
Replaces the rule.
-
#search_index(params = {}) ⇒ Types::SearchIndexResponse
The query search index.
-
#set_default_authorizer(params = {}) ⇒ Types::SetDefaultAuthorizerResponse
Sets the default authorizer.
-
#set_default_policy_version(params = {}) ⇒ Struct
Sets the specified version of the specified policy as the policy's default (operative) version.
-
#set_logging_options(params = {}) ⇒ Struct
Sets the logging options.
-
#set_v2_logging_level(params = {}) ⇒ Struct
Sets the logging level.
-
#set_v2_logging_options(params = {}) ⇒ Struct
Sets the logging options for the V2 logging service.
-
#start_audit_mitigation_actions_task(params = {}) ⇒ Types::StartAuditMitigationActionsTaskResponse
Starts a task that applies a set of mitigation actions to the specified target.
-
#start_detect_mitigation_actions_task(params = {}) ⇒ Types::StartDetectMitigationActionsTaskResponse
Starts a Device Defender ML Detect mitigation actions task.
-
#start_on_demand_audit_task(params = {}) ⇒ Types::StartOnDemandAuditTaskResponse
Starts an on-demand Device Defender audit.
-
#start_thing_registration_task(params = {}) ⇒ Types::StartThingRegistrationTaskResponse
Creates a bulk thing provisioning task.
-
#stop_thing_registration_task(params = {}) ⇒ Struct
Cancels a bulk thing provisioning task.
-
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
-
#test_authorization(params = {}) ⇒ Types::TestAuthorizationResponse
Tests if a specified principal is authorized to perform an IoT action on a specified resource.
-
#test_invoke_authorizer(params = {}) ⇒ Types::TestInvokeAuthorizerResponse
Tests a custom authorization behavior by invoking a specified custom authorizer.
-
#transfer_certificate(params = {}) ⇒ Types::TransferCertificateResponse
Transfers the specified certificate to the specified Amazon Web Services account.
-
#untag_resource(params = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
-
#update_account_audit_configuration(params = {}) ⇒ Struct
Configures or reconfigures the Device Defender audit settings for this account.
-
#update_audit_suppression(params = {}) ⇒ Struct
Updates a Device Defender audit suppression.
-
#update_authorizer(params = {}) ⇒ Types::UpdateAuthorizerResponse
Updates an authorizer.
-
#update_billing_group(params = {}) ⇒ Types::UpdateBillingGroupResponse
Updates information about the billing group.
-
#update_ca_certificate(params = {}) ⇒ Struct
Updates a registered CA certificate.
-
#update_certificate(params = {}) ⇒ Struct
Updates the status of the specified certificate.
-
#update_certificate_provider(params = {}) ⇒ Types::UpdateCertificateProviderResponse
Updates a certificate provider.
-
#update_custom_metric(params = {}) ⇒ Types::UpdateCustomMetricResponse
Updates a Device Defender detect custom metric.
-
#update_dimension(params = {}) ⇒ Types::UpdateDimensionResponse
Updates the definition for a dimension.
-
#update_domain_configuration(params = {}) ⇒ Types::UpdateDomainConfigurationResponse
Updates values stored in the domain configuration.
-
#update_dynamic_thing_group(params = {}) ⇒ Types::UpdateDynamicThingGroupResponse
Updates a dynamic thing group.
-
#update_event_configurations(params = {}) ⇒ Struct
Updates the event configurations.
-
#update_fleet_metric(params = {}) ⇒ Struct
Updates the data for a fleet metric.
-
#update_indexing_configuration(params = {}) ⇒ Struct
Updates the search configuration.
-
#update_job(params = {}) ⇒ Struct
Updates supported fields of the specified job.
-
#update_mitigation_action(params = {}) ⇒ Types::UpdateMitigationActionResponse
Updates the definition for the specified mitigation action.
-
#update_package(params = {}) ⇒ Struct
Updates the supported fields for a specific software package.
-
#update_package_configuration(params = {}) ⇒ Struct
Updates the software package configuration.
-
#update_package_version(params = {}) ⇒ Struct
Updates the supported fields for a specific package version.
-
#update_provisioning_template(params = {}) ⇒ Struct
Updates a provisioning template.
-
#update_role_alias(params = {}) ⇒ Types::UpdateRoleAliasResponse
Updates a role alias.
-
#update_scheduled_audit(params = {}) ⇒ Types::UpdateScheduledAuditResponse
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
-
#update_security_profile(params = {}) ⇒ Types::UpdateSecurityProfileResponse
Updates a Device Defender security profile.
-
#update_stream(params = {}) ⇒ Types::UpdateStreamResponse
Updates an existing stream.
-
#update_thing(params = {}) ⇒ Struct
Updates the data for a thing.
-
#update_thing_group(params = {}) ⇒ Types::UpdateThingGroupResponse
Update a thing group.
-
#update_thing_groups_for_thing(params = {}) ⇒ Struct
Updates the groups to which the thing belongs.
-
#update_topic_rule_destination(params = {}) ⇒ Struct
Updates a topic rule destination.
-
#validate_security_profile_behaviors(params = {}) ⇒ Types::ValidateSecurityProfileBehaviorsResponse
Validates a Device Defender security profile behaviors specification.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
434 435 436 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 434 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.
471 472 473 474 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 471 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.
514 515 516 517 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 514 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.
559 560 561 562 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 559 def add_thing_to_thing_group(params = {}, = {}) req = build_request(:add_thing_to_thing_group, params) req.send_request() end |
#associate_targets_with_job(params = {}) ⇒ Types::AssociateTargetsWithJobResponse
Associates a group with a continuous job. The following criteria must be met:
The job must have been created with the
targetSelection
field set to "CONTINUOUS".The job status must currently be "IN_PROGRESS".
The total number of targets associated with a job must not exceed
Requires permission to access the AssociateTargetsWithJob action.
633 634 635 636 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 633 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.
669 670 671 672 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 669 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.
705 706 707 708 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 705 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.
738 739 740 741 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 738 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.
771 772 773 774 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 771 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.
799 800 801 802 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 799 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.
828 829 830 831 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 828 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.
866 867 868 869 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 866 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.
893 894 895 896 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 893 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.
948 949 950 951 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 948 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.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1009 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.
1026 1027 1028 1029 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1026 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.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1058 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.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1131 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.
1220 1221 1222 1223 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1220 def (params = {}, = {}) req = build_request(:create_authorizer, params) req.send_request() end |
#create_billing_group(params = {}) ⇒ Types::CreateBillingGroupResponse
Creates a billing group.
Requires permission to access the CreateBillingGroup action.
1271 1272 1273 1274 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1271 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"
1364 1365 1366 1367 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1364 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.
1440 1441 1442 1443 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1440 def create_certificate_provider(params = {}, = {}) req = build_request(:create_certificate_provider, params) req.send_request() end |
#create_custom_metric(params = {}) ⇒ Types::CreateCustomMetricResponse
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1511 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.
1579 1580 1581 1582 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1579 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.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1680 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.
1770 1771 1772 1773 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1770 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.
1854 1855 1856 1857 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1854 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.
2067 2068 2069 2070 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2067 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.
2218 2219 2220 2221 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2218 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.
2265 2266 2267 2268 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2265 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.
2343 2344 2345 2346 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2343 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.
2524 2525 2526 2527 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2524 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.
2581 2582 2583 2584 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2581 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.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2662 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.
2730 2731 2732 2733 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2730 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.
2789 2790 2791 2792 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2789 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.
2828 2829 2830 2831 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2828 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.
2927 2928 2929 2930 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2927 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.
2974 2975 2976 2977 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2974 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.
3041 3042 3043 3044 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3041 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.
3110 3111 3112 3113 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3110 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.
3237 3238 3239 3240 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3237 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.
3309 3310 3311 3312 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3309 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.
3378 3379 3380 3381 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3378 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.
3448 3449 3450 3451 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3448 def create_thing_group(params = {}, = {}) req = build_request(:create_thing_group, params) req.send_request() end |
#create_thing_type(params = {}) ⇒ Types::CreateThingTypeResponse
Creates a new thing type.
Requires permission to access the CreateThingType action.
3502 3503 3504 3505 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3502 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.
3968 3969 3970 3971 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3968 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.
4023 4024 4025 4026 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4023 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.
4052 4053 4054 4055 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4052 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.
4103 4104 4105 4106 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4103 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.
4129 4130 4131 4132 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4129 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.
4162 4163 4164 4165 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4162 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.
4189 4190 4191 4192 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4189 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.
4227 4228 4229 4230 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4227 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).
4258 4259 4260 4261 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4258 def delete_certificate_provider(params = {}, = {}) req = build_request(:delete_certificate_provider, params) req.send_request() end |
#delete_custom_metric(params = {}) ⇒ Struct
Deletes a Device Defender detect custom metric.
Requires permission to access the DeleteCustomMetric action.
metricName
set to your custom
metric name.
4293 4294 4295 4296 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4293 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.
4320 4321 4322 4323 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4320 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.
4347 4348 4349 4350 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4347 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.
4377 4378 4379 4380 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4377 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.
4409 4410 4411 4412 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4409 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.
4483 4484 4485 4486 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4483 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.
4557 4558 4559 4560 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4557 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.
4577 4578 4579 4580 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4577 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.
4604 4605 4606 4607 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4604 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.
4643 4644 4645 4646 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4643 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.
4681 4682 4683 4684 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4681 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.
4718 4719 4720 4721 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4718 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.
4761 4762 4763 4764 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4761 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.
4795 4796 4797 4798 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4795 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.
4822 4823 4824 4825 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4822 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.
4853 4854 4855 4856 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4853 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.
4870 4871 4872 4873 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4870 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.
4896 4897 4898 4899 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4896 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.
4922 4923 4924 4925 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4922 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.
4955 4956 4957 4958 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4955 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.
4981 4982 4983 4984 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4981 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.
5015 5016 5017 5018 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5015 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.
5045 5046 5047 5048 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5045 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.
5076 5077 5078 5079 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5076 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.
5102 5103 5104 5105 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5102 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.
5129 5130 5131 5132 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5129 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.
5160 5161 5162 5163 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5160 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.
5193 5194 5195 5196 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5193 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.
5227 5228 5229 5230 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5227 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.
5303 5304 5305 5306 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5303 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.
5368 5369 5370 5371 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5368 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.
5439 5440 5441 5442 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5439 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.
5494 5495 5496 5497 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5494 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.
5536 5537 5538 5539 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5536 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.
5578 5579 5580 5581 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5578 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.
5626 5627 5628 5629 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5626 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.
5677 5678 5679 5680 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5677 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.
5721 5722 5723 5724 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5721 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.
5763 5764 5765 5766 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5763 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.
5797 5798 5799 5800 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5797 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.
5857 5858 5859 5860 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5857 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.
5901 5902 5903 5904 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5901 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.
5958 5959 5960 5961 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5958 def describe_domain_configuration(params = {}, = {}) req = build_request(:describe_domain_configuration, params) req.send_request() end |
#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse
Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.
DescribeEndpoint
is called, an endpoint is created.
All subsequent calls to DescribeEndpoint
return the same endpoint.
Requires permission to access the DescribeEndpoint action.
6021 6022 6023 6024 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6021 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.
6050 6051 6052 6053 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6050 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.
6108 6109 6110 6111 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6108 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.
6144 6145 6146 6147 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6144 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.
6231 6232 6233 6234 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6231 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.
6283 6284 6285 6286 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6283 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.
6347 6348 6349 6350 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6347 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.
6396 6397 6398 6399 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6396 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.
6451 6452 6453 6454 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6451 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.
6505 6506 6507 6508 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6505 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.
6548 6549 6550 6551 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6548 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.
6586 6587 6588 6589 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6586 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.
6629 6630 6631 6632 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6629 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.
6711 6712 6713 6714 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6711 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.
6754 6755 6756 6757 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6754 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.
6801 6802 6803 6804 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6801 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.
6858 6859 6860 6861 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6858 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.
6913 6914 6915 6916 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6913 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.
6957 6958 6959 6960 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6957 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.
6993 6994 6995 6996 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6993 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.
7032 7033 7034 7035 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7032 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.
7064 7065 7066 7067 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7064 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.
7103 7104 7105 7106 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7103 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.
7129 7130 7131 7132 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7129 def disable_topic_rule(params = {}, = {}) req = build_request(:disable_topic_rule, params) req.send_request() end |
#enable_topic_rule(params = {}) ⇒ Struct
Enables the rule.
Requires permission to access the EnableTopicRule action.
7155 7156 7157 7158 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7155 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.
7208 7209 7210 7211 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7208 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.
7266 7267 7268 7269 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7266 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.
7310 7311 7312 7313 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7310 def get_cardinality(params = {}, = {}) req = build_request(:get_cardinality, params) req.send_request() end |
#get_effective_policies(params = {}) ⇒ Types::GetEffectivePoliciesResponse
Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.
Requires permission to access the GetEffectivePolicies action.
7358 7359 7360 7361 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7358 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.
7404 7405 7406 7407 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7404 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.
7436 7437 7438 7439 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7436 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.
7464 7465 7466 7467 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7464 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.
7541 7542 7543 7544 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7541 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.
7583 7584 7585 7586 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7583 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.
7608 7609 7610 7611 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7608 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.
7661 7662 7663 7664 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7661 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.
7721 7722 7723 7724 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7721 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.
7766 7767 7768 7769 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7766 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.
7816 7817 7818 7819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7816 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.
7844 7845 7846 7847 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7844 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.
7900 7901 7902 7903 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7900 def get_statistics(params = {}, = {}) req = build_request(:get_statistics, params) req.send_request() end |
#get_topic_rule(params = {}) ⇒ Types::GetTopicRuleResponse
Gets information about the rule.
Requires permission to access the GetTopicRule action.
8186 8187 8188 8189 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8186 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.
8229 8230 8231 8232 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8229 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.
8256 8257 8258 8259 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8256 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.
8358 8359 8360 8361 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8358 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.
8412 8413 8414 8415 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8412 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.
8548 8549 8550 8551 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8548 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.
8613 8614 8615 8616 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8613 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.
8684 8685 8686 8687 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8684 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.
8777 8778 8779 8780 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8777 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.
8843 8844 8845 8846 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8843 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.
8893 8894 8895 8896 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8893 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.
8941 8942 8943 8944 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8941 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.
8997 8998 8999 9000 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8997 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.
9041 9042 9043 9044 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9041 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.
9094 9095 9096 9097 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9094 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.
9149 9150 9151 9152 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9149 def list_certificates_by_ca(params = {}, = {}) req = build_request(:list_certificates_by_ca, params) req.send_request() end |
#list_custom_metrics(params = {}) ⇒ Types::ListCustomMetricsResponse
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9191 9192 9193 9194 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9191 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.
9266 9267 9268 9269 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9266 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.
9347 9348 9349 9350 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9347 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.
9389 9390 9391 9392 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9389 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.
9438 9439 9440 9441 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9438 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.
9482 9483 9484 9485 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9482 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.
9524 9525 9526 9527 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9524 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.
9579 9580 9581 9582 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9579 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.
9660 9661 9662 9663 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9660 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.
9704 9705 9706 9707 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9704 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.
9804 9805 9806 9807 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9804 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.
9850 9851 9852 9853 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9850 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.
9922 9923 9924 9925 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9922 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.
9972 9973 9974 9975 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9972 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.
10019 10020 10021 10022 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10019 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.
10071 10072 10073 10074 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10071 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.
10129 10130 10131 10132 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10129 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.
10173 10174 10175 10176 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10173 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.
10220 10221 10222 10223 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10220 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.
10274 10275 10276 10277 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10274 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.
10310 10311 10312 10313 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10310 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.
10371 10372 10373 10374 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10371 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.
10420 10421 10422 10423 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10420 def list_principal_things(params = {}, = {}) req = build_request(:list_principal_things, params) req.send_request() end |
#list_provisioning_template_versions(params = {}) ⇒ Types::ListProvisioningTemplateVersionsResponse
A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10468 10469 10470 10471 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10468 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.
10516 10517 10518 10519 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10516 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.
10603 10604 10605 10606 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10603 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.
10648 10649 10650 10651 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10648 def list_role_aliases(params = {}, = {}) req = build_request(:list_role_aliases, params) req.send_request() end |
#list_scheduled_audits(params = {}) ⇒ Types::ListScheduledAuditsResponse
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10694 10695 10696 10697 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10694 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.
10750 10751 10752 10753 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10750 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.
10804 10805 10806 10807 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10804 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.
10852 10853 10854 10855 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10852 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.
10896 10897 10898 10899 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10896 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.
10941 10942 10943 10944 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10941 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.
10988 10989 10990 10991 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10988 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.
11046 11047 11048 11049 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11046 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.
11094 11095 11096 11097 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11094 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.
11143 11144 11145 11146 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11143 def list_thing_principals(params = {}, = {}) req = build_request(:list_thing_principals, params) req.send_request() end |
#list_thing_registration_task_reports(params = {}) ⇒ Types::ListThingRegistrationTaskReportsResponse
Information about the thing registration tasks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11190 11191 11192 11193 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11190 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.
11238 11239 11240 11241 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11238 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.
11292 11293 11294 11295 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11292 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.
11374 11375 11376 11377 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11374 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.
11422 11423 11424 11425 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11422 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.
11474 11475 11476 11477 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11474 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.
11530 11531 11532 11533 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11530 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.
11585 11586 11587 11588 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11585 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.
11635 11636 11637 11638 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11635 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.
11748 11749 11750 11751 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11748 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).
11778 11779 11780 11781 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11778 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.
11877 11878 11879 11880 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11877 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.
11931 11932 11933 11934 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11931 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.
11969 11970 11971 11972 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11969 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.
12026 12027 12028 12029 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12026 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.
12067 12068 12069 12070 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12067 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.
12111 12112 12113 12114 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12111 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.
12154 12155 12156 12157 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12154 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.
12606 12607 12608 12609 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12606 def replace_topic_rule(params = {}, = {}) req = build_request(:replace_topic_rule, params) req.send_request() end |
#search_index(params = {}) ⇒ Types::SearchIndexResponse
The query search index.
Requires permission to access the SearchIndex action.
12690 12691 12692 12693 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12690 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.
12725 12726 12727 12728 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12725 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.
12758 12759 12760 12761 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12758 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.
12790 12791 12792 12793 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12790 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.
12823 12824 12825 12826 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12823 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.
12857 12858 12859 12860 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12857 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.
12921 12922 12923 12924 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12921 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.
12992 12993 12994 12995 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12992 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.
13028 13029 13030 13031 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13028 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.
13075 13076 13077 13078 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13075 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.
13102 13103 13104 13105 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13102 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.
13138 13139 13140 13141 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13138 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.
13218 13219 13220 13221 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13218 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.
13293 13294 13295 13296 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13293 def (params = {}, = {}) req = build_request(:test_invoke_authorizer, params) req.send_request() end |
#transfer_certificate(params = {}) ⇒ Types::TransferCertificateResponse
Transfers the specified certificate to the specified Amazon Web Services account.
Requires permission to access the TransferCertificate action.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.
13346 13347 13348 13349 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13346 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.
13376 13377 13378 13379 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13376 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.
13438 13439 13440 13441 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13438 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.
13496 13497 13498 13499 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13496 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.
13554 13555 13556 13557 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13554 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.
13599 13600 13601 13602 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13599 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.
13649 13650 13651 13652 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13649 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.
13697 13698 13699 13700 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13697 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.
13742 13743 13744 13745 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13742 def update_certificate_provider(params = {}, = {}) req = build_request(:update_certificate_provider, params) req.send_request() end |
#update_custom_metric(params = {}) ⇒ Types::UpdateCustomMetricResponse
Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
13790 13791 13792 13793 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13790 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.
13841 13842 13843 13844 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13841 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.
13904 13905 13906 13907 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13904 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.
13973 13974 13975 13976 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13973 def update_dynamic_thing_group(params = {}, = {}) req = build_request(:update_dynamic_thing_group, params) req.send_request() end |
#update_event_configurations(params = {}) ⇒ Struct
Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
14004 14005 14006 14007 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14004 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.
14075 14076 14077 14078 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14075 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.
14146 14147 14148 14149 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14146 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.
14251 14252 14253 14254 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14251 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.
14316 14317 14318 14319 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14316 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.
14372 14373 14374 14375 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14372 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.
14413 14414 14415 14416 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14413 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.
14480 14481 14482 14483 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14480 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.
14541 14542 14543 14544 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14541 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.
14586 14587 14588 14589 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14586 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.
14647 14648 14649 14650 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14647 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.
14840 14841 14842 14843 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14840 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.
14901 14902 14903 14904 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14901 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.
14961 14962 14963 14964 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14961 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.
15010 15011 15012 15013 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15010 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.
15052 15053 15054 15055 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15052 def update_thing_groups_for_thing(params = {}, = {}) req = build_request(:update_thing_groups_for_thing, params) req.send_request() end |
#update_topic_rule_destination(params = {}) ⇒ Struct
Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
Requires permission to access the UpdateTopicRuleDestination action.
15113 15114 15115 15116 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15113 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.
15181 15182 15183 15184 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15181 def validate_security_profile_behaviors(params = {}, = {}) req = build_request(:validate_security_profile_behaviors, params) req.send_request() end |