Class: Aws::IoT::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoT::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb
Overview
An API client for IoT. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoT::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_certificate_transfer(params = {}) ⇒ Struct
Accepts a pending certificate transfer.
-
#add_thing_to_billing_group(params = {}) ⇒ Struct
Adds a thing to a billing group.
-
#add_thing_to_thing_group(params = {}) ⇒ Struct
Adds a thing to a thing group.
-
#associate_sbom_with_package_version(params = {}) ⇒ Types::AssociateSbomWithPackageVersionResponse
Associates a software bill of materials (SBOM) with a specific software package version.
-
#associate_targets_with_job(params = {}) ⇒ Types::AssociateTargetsWithJobResponse
Associates a group with a continuous job.
-
#attach_policy(params = {}) ⇒ Struct
Attaches the specified policy to the specified principal (certificate or other credential).
-
#attach_principal_policy(params = {}) ⇒ Struct
Attaches the specified policy to the specified principal (certificate or other credential).
-
#attach_security_profile(params = {}) ⇒ Struct
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.
-
#disassociate_sbom_from_package_version(params = {}) ⇒ Struct
Disassociates a software bill of materials (SBOM) from a specific software package version.
-
#enable_topic_rule(params = {}) ⇒ Struct
Enables the rule.
-
#get_behavior_model_training_summaries(params = {}) ⇒ Types::GetBehaviorModelTrainingSummariesResponse
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_sbom_validation_results(params = {}) ⇒ Types::ListSbomValidationResultsResponse
The validation results for all software bill of materials (SBOM) attached to a specific software package version.
-
#list_scheduled_audits(params = {}) ⇒ Types::ListScheduledAuditsResponse
Lists all of your scheduled audits.
-
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
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.
446 447 448 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 446 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.
483 484 485 486 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 483 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.
526 527 528 529 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 526 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.
571 572 573 574 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 571 def add_thing_to_thing_group(params = {}, = {}) req = build_request(:add_thing_to_thing_group, params) req.send_request() end |
#associate_sbom_with_package_version(params = {}) ⇒ Types::AssociateSbomWithPackageVersionResponse
Associates a software bill of materials (SBOM) with a specific software package version.
Requires permission to access the AssociateSbomWithPackageVersion action.
637 638 639 640 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 637 def associate_sbom_with_package_version(params = {}, = {}) req = build_request(:associate_sbom_with_package_version, params) req.send_request() end |
#associate_targets_with_job(params = {}) ⇒ Types::AssociateTargetsWithJobResponse
Associates a group with a continuous job. The following criteria must be met:
The job must have been created with the
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.
711 712 713 714 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 711 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.
747 748 749 750 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 747 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.
783 784 785 786 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 783 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.
816 817 818 819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 816 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.
849 850 851 852 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 849 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.
877 878 879 880 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 877 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.
906 907 908 909 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 906 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.
944 945 946 947 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 944 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.
971 972 973 974 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 971 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.
1026 1027 1028 1029 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1026 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.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1087 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.
1104 1105 1106 1107 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1104 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.
1136 1137 1138 1139 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1136 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.
1209 1210 1211 1212 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1209 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.
1298 1299 1300 1301 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1298 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.
1349 1350 1351 1352 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1349 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"
1442 1443 1444 1445 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1442 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.
1518 1519 1520 1521 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1518 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.
1589 1590 1591 1592 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1589 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.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1657 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.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1758 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.
1848 1849 1850 1851 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1848 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.
1932 1933 1934 1935 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 1932 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.
2145 2146 2147 2148 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2145 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.
2296 2297 2298 2299 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2296 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.
2343 2344 2345 2346 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2343 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.
2421 2422 2423 2424 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2421 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.
2602 2603 2604 2605 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2602 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.
2659 2660 2661 2662 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2659 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.
2757 2758 2759 2760 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2757 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.
2825 2826 2827 2828 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2825 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.
2884 2885 2886 2887 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2884 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.
2923 2924 2925 2926 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 2923 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.
3022 3023 3024 3025 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3022 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.
3069 3070 3071 3072 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3069 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.
3136 3137 3138 3139 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3136 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.
3205 3206 3207 3208 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3205 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.
3332 3333 3334 3335 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3332 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.
3404 3405 3406 3407 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3404 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.
3473 3474 3475 3476 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3473 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.
3543 3544 3545 3546 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3543 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.
3597 3598 3599 3600 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 3597 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.
4063 4064 4065 4066 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4063 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.
4118 4119 4120 4121 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4118 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.
4147 4148 4149 4150 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4147 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.
4198 4199 4200 4201 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4198 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.
4224 4225 4226 4227 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4224 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.
4257 4258 4259 4260 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4257 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.
4284 4285 4286 4287 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4284 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.
4322 4323 4324 4325 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4322 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).
4353 4354 4355 4356 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4353 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.
4388 4389 4390 4391 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4388 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.
4415 4416 4417 4418 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4415 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.
4442 4443 4444 4445 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4442 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.
4472 4473 4474 4475 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4472 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.
4504 4505 4506 4507 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4504 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.
4578 4579 4580 4581 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4578 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.
4652 4653 4654 4655 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4652 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.
4672 4673 4674 4675 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4672 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.
4699 4700 4701 4702 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4699 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.
4738 4739 4740 4741 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4738 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.
4776 4777 4778 4779 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4776 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.
4813 4814 4815 4816 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4813 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.
4856 4857 4858 4859 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4856 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.
4890 4891 4892 4893 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4890 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.
4917 4918 4919 4920 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4917 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.
4948 4949 4950 4951 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4948 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.
4965 4966 4967 4968 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4965 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.
4991 4992 4993 4994 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 4991 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.
5017 5018 5019 5020 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5017 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.
5050 5051 5052 5053 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5050 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.
5076 5077 5078 5079 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5076 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.
5110 5111 5112 5113 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5110 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.
5140 5141 5142 5143 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5140 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.
5171 5172 5173 5174 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5171 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.
5197 5198 5199 5200 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5197 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.
5224 5225 5226 5227 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5224 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.
5255 5256 5257 5258 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5255 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.
5288 5289 5290 5291 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5288 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.
5322 5323 5324 5325 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5322 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.
5398 5399 5400 5401 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5398 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.
5463 5464 5465 5466 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5463 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.
5534 5535 5536 5537 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5534 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.
5589 5590 5591 5592 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5589 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.
5631 5632 5633 5634 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5631 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.
5673 5674 5675 5676 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5673 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.
5721 5722 5723 5724 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5721 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.
5772 5773 5774 5775 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5772 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.
5816 5817 5818 5819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5816 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.
5858 5859 5860 5861 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5858 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.
5892 5893 5894 5895 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5892 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.
5952 5953 5954 5955 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5952 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.
5996 5997 5998 5999 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 5996 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.
6053 6054 6055 6056 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6053 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.
6116 6117 6118 6119 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6116 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.
6145 6146 6147 6148 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6145 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.
6203 6204 6205 6206 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6203 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.
6239 6240 6241 6242 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6239 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.
6331 6332 6333 6334 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6331 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.
6383 6384 6385 6386 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6383 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.
6447 6448 6449 6450 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6447 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.
6496 6497 6498 6499 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6496 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.
6551 6552 6553 6554 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6551 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.
6605 6606 6607 6608 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6605 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.
6648 6649 6650 6651 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6648 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.
6686 6687 6688 6689 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6686 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.
6729 6730 6731 6732 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6729 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.
6811 6812 6813 6814 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6811 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.
6854 6855 6856 6857 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6854 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.
6901 6902 6903 6904 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6901 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.
6958 6959 6960 6961 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 6958 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.
7013 7014 7015 7016 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7013 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.
7057 7058 7059 7060 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7057 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.
7093 7094 7095 7096 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7093 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.
7132 7133 7134 7135 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7132 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.
7164 7165 7166 7167 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7164 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.
7203 7204 7205 7206 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7203 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.
7229 7230 7231 7232 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7229 def disable_topic_rule(params = {}, = {}) req = build_request(:disable_topic_rule, params) req.send_request() end |
#disassociate_sbom_from_package_version(params = {}) ⇒ Struct
Disassociates a software bill of materials (SBOM) from a specific software package version.
Requires permission to access the DisassociateSbomWithPackageVersion action.
7270 7271 7272 7273 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7270 def disassociate_sbom_from_package_version(params = {}, = {}) req = build_request(:disassociate_sbom_from_package_version, params) req.send_request() end |
#enable_topic_rule(params = {}) ⇒ Struct
Enables the rule.
Requires permission to access the EnableTopicRule action.
7296 7297 7298 7299 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7296 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.
7349 7350 7351 7352 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7349 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.
7407 7408 7409 7410 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7407 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.
7451 7452 7453 7454 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7451 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.
7499 7500 7501 7502 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7499 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.
7545 7546 7547 7548 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7545 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.
7582 7583 7584 7585 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7582 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.
7610 7611 7612 7613 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7610 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.
7687 7688 7689 7690 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7687 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.
7729 7730 7731 7732 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7729 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.
7754 7755 7756 7757 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7754 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.
7819 7820 7821 7822 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7819 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.
7879 7880 7881 7882 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7879 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.
7924 7925 7926 7927 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7924 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.
7974 7975 7976 7977 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 7974 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.
8002 8003 8004 8005 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8002 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.
8058 8059 8060 8061 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8058 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.
8344 8345 8346 8347 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8344 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.
8387 8388 8389 8390 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8387 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.
8414 8415 8416 8417 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8414 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.
8516 8517 8518 8519 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8516 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.
8570 8571 8572 8573 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8570 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.
8706 8707 8708 8709 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8706 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.
8771 8772 8773 8774 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8771 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.
8842 8843 8844 8845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8842 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.
8935 8936 8937 8938 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 8935 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.
9001 9002 9003 9004 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9001 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.
9051 9052 9053 9054 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9051 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.
9099 9100 9101 9102 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9099 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.
9155 9156 9157 9158 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9155 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.
9199 9200 9201 9202 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9199 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.
9252 9253 9254 9255 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9252 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.
9307 9308 9309 9310 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9307 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.
9349 9350 9351 9352 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9349 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.
9424 9425 9426 9427 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9424 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.
9505 9506 9507 9508 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9505 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.
9547 9548 9549 9550 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9547 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.
9596 9597 9598 9599 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9596 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.
9640 9641 9642 9643 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9640 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.
9682 9683 9684 9685 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9682 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.
9737 9738 9739 9740 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9737 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.
9818 9819 9820 9821 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9818 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.
9862 9863 9864 9865 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9862 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.
9962 9963 9964 9965 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 9962 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.
10008 10009 10010 10011 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10008 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.
10080 10081 10082 10083 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10080 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.
10130 10131 10132 10133 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10130 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.
10177 10178 10179 10180 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10177 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.
10229 10230 10231 10232 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10229 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.
10287 10288 10289 10290 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10287 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.
10331 10332 10333 10334 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10331 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.
10378 10379 10380 10381 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10378 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.
10432 10433 10434 10435 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10432 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.
10468 10469 10470 10471 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10468 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.
10529 10530 10531 10532 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10529 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.
10578 10579 10580 10581 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10578 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.
10626 10627 10628 10629 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10626 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.
10674 10675 10676 10677 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10674 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.
10761 10762 10763 10764 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10761 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.
10806 10807 10808 10809 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10806 def list_role_aliases(params = {}, = {}) req = build_request(:list_role_aliases, params) req.send_request() end |
#list_sbom_validation_results(params = {}) ⇒ Types::ListSbomValidationResultsResponse
The validation results for all software bill of materials (SBOM) attached to a specific software package version.
Requires permission to access the ListSbomValidationResults action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10865 10866 10867 10868 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10865 def list_sbom_validation_results(params = {}, = {}) req = build_request(:list_sbom_validation_results, params) req.send_request() end |
#list_scheduled_audits(params = {}) ⇒ Types::ListScheduledAuditsResponse
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10911 10912 10913 10914 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10911 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.
10967 10968 10969 10970 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 10967 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.
11021 11022 11023 11024 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11021 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.
11069 11070 11071 11072 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11069 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.
11113 11114 11115 11116 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11113 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.
11158 11159 11160 11161 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11158 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.
11205 11206 11207 11208 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11205 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.
11263 11264 11265 11266 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11263 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.
11311 11312 11313 11314 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11311 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.
11360 11361 11362 11363 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11360 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.
11407 11408 11409 11410 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11407 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.
11455 11456 11457 11458 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11455 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.
11509 11510 11511 11512 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11509 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.
11591 11592 11593 11594 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11591 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.
11639 11640 11641 11642 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11639 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.
11691 11692 11693 11694 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11691 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.
11747 11748 11749 11750 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11747 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.
11802 11803 11804 11805 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11802 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.
11852 11853 11854 11855 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11852 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.
11965 11966 11967 11968 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11965 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).
11995 11996 11997 11998 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 11995 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.
12094 12095 12096 12097 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12094 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.
12148 12149 12150 12151 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12148 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.
12186 12187 12188 12189 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12186 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.
12243 12244 12245 12246 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12243 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.
12284 12285 12286 12287 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12284 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.
12328 12329 12330 12331 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12328 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.
12371 12372 12373 12374 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12371 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.
12823 12824 12825 12826 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12823 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.
12907 12908 12909 12910 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12907 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.
12942 12943 12944 12945 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12942 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.
12975 12976 12977 12978 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 12975 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.
13007 13008 13009 13010 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13007 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.
13040 13041 13042 13043 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13040 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.
13074 13075 13076 13077 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13074 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.
13138 13139 13140 13141 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13138 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.
13209 13210 13211 13212 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13209 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.
13245 13246 13247 13248 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13245 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.
13292 13293 13294 13295 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13292 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.
13319 13320 13321 13322 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13319 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.
13355 13356 13357 13358 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13355 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.
13435 13436 13437 13438 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13435 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.
13510 13511 13512 13513 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13510 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.
13563 13564 13565 13566 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13563 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.
13593 13594 13595 13596 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13593 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.
13655 13656 13657 13658 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13655 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.
13713 13714 13715 13716 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13713 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.
13771 13772 13773 13774 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13771 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.
13816 13817 13818 13819 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13816 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.
13866 13867 13868 13869 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13866 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.
13914 13915 13916 13917 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13914 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.
13959 13960 13961 13962 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 13959 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.
14007 14008 14009 14010 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14007 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.
14058 14059 14060 14061 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14058 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.
14121 14122 14123 14124 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14121 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.
14190 14191 14192 14193 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14190 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.
14221 14222 14223 14224 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14221 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.
14292 14293 14294 14295 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14292 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.
14363 14364 14365 14366 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14363 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.
14468 14469 14470 14471 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14468 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.
14533 14534 14535 14536 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14533 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.
14589 14590 14591 14592 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14589 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.
14630 14631 14632 14633 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14630 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.
14712 14713 14714 14715 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14712 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.
14773 14774 14775 14776 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14773 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.
14818 14819 14820 14821 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14818 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.
14879 14880 14881 14882 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 14879 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.
15072 15073 15074 15075 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15072 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.
15133 15134 15135 15136 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15133 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.
15193 15194 15195 15196 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15193 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.
15242 15243 15244 15245 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15242 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.
15284 15285 15286 15287 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15284 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.
15345 15346 15347 15348 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15345 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.
15413 15414 15415 15416 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb', line 15413 def validate_security_profile_behaviors(params = {}, = {}) req = build_request(:validate_security_profile_behaviors, params) req.send_request() end |