Package 'paws.internet.of.things'

Title: 'Amazon Web Services' Internet of Things Services
Description: Interface to 'Amazon Web Services' internet of things ('IoT') services, including data collection, management, and analysis for IoT devices. <https://aws.amazon.com/iot/>.
Authors: David Kretch [aut], Adam Banker [aut], Dyfan Jones [cre], Amazon.com, Inc. [cph]
Maintainer: Dyfan Jones <[email protected]>
License: Apache License (>= 2.0)
Version: 0.8.0
Built: 2024-12-20 02:59:54 UTC
Source: https://github.com/paws-r/paws

Help Index


AWS Greengrass

Description

AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.

Usage

greengrass(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- greengrass(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_role_to_group Associates a role with a group
associate_service_role_to_account Associates a role with your account
create_connector_definition Creates a connector definition
create_connector_definition_version Creates a version of a connector definition which has already been defined
create_core_definition Creates a core definition
create_core_definition_version Creates a version of a core definition that has already been defined
create_deployment Creates a deployment
create_device_definition Creates a device definition
create_device_definition_version Creates a version of a device definition that has already been defined
create_function_definition Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group
create_function_definition_version Creates a version of a Lambda function definition that has already been defined
create_group Creates a group
create_group_certificate_authority Creates a CA for the group
create_group_version Creates a version of a group which has already been defined
create_logger_definition Creates a logger definition
create_logger_definition_version Creates a version of a logger definition that has already been defined
create_resource_definition Creates a resource definition which contains a list of resources to be used in a group
create_resource_definition_version Creates a version of a resource definition that has already been defined
create_software_update_job Creates a software update for a core or group of cores (specified as an IoT thing group
create_subscription_definition Creates a subscription definition
create_subscription_definition_version Creates a version of a subscription definition which has already been defined
delete_connector_definition Deletes a connector definition
delete_core_definition Deletes a core definition
delete_device_definition Deletes a device definition
delete_function_definition Deletes a Lambda function definition
delete_group Deletes a group
delete_logger_definition Deletes a logger definition
delete_resource_definition Deletes a resource definition
delete_subscription_definition Deletes a subscription definition
disassociate_role_from_group Disassociates the role from a group
disassociate_service_role_from_account Disassociates the service role from your account
get_associated_role Retrieves the role associated with a particular group
get_bulk_deployment_status Returns the status of a bulk deployment
get_connectivity_info Retrieves the connectivity information for a core
get_connector_definition Retrieves information about a connector definition
get_connector_definition_version Retrieves information about a connector definition version, including the connectors that the version contains
get_core_definition Retrieves information about a core definition version
get_core_definition_version Retrieves information about a core definition version
get_deployment_status Returns the status of a deployment
get_device_definition Retrieves information about a device definition
get_device_definition_version Retrieves information about a device definition version
get_function_definition Retrieves information about a Lambda function definition, including its creation time and latest version
get_function_definition_version Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations
get_group Retrieves information about a group
get_group_certificate_authority Retreives the CA associated with a group
get_group_certificate_configuration Retrieves the current configuration for the CA used by the group
get_group_version Retrieves information about a group version
get_logger_definition Retrieves information about a logger definition
get_logger_definition_version Retrieves information about a logger definition version
get_resource_definition Retrieves information about a resource definition, including its creation time and latest version
get_resource_definition_version Retrieves information about a resource definition version, including which resources are included in the version
get_service_role_for_account Retrieves the service role that is attached to your account
get_subscription_definition Retrieves information about a subscription definition
get_subscription_definition_version Retrieves information about a subscription definition version
get_thing_runtime_configuration Get the runtime configuration of a thing
list_bulk_deployment_detailed_reports Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status
list_bulk_deployments Returns a list of bulk deployments
list_connector_definitions Retrieves a list of connector definitions
list_connector_definition_versions Lists the versions of a connector definition, which are containers for connectors
list_core_definitions Retrieves a list of core definitions
list_core_definition_versions Lists the versions of a core definition
list_deployments Returns a history of deployments for the group
list_device_definitions Retrieves a list of device definitions
list_device_definition_versions Lists the versions of a device definition
list_function_definitions Retrieves a list of Lambda function definitions
list_function_definition_versions Lists the versions of a Lambda function definition
list_group_certificate_authorities Retrieves the current CAs for a group
list_groups Retrieves a list of groups
list_group_versions Lists the versions of a group
list_logger_definitions Retrieves a list of logger definitions
list_logger_definition_versions Lists the versions of a logger definition
list_resource_definitions Retrieves a list of resource definitions
list_resource_definition_versions Lists the versions of a resource definition
list_subscription_definitions Retrieves a list of subscription definitions
list_subscription_definition_versions Lists the versions of a subscription definition
list_tags_for_resource Retrieves a list of resource tags for a resource arn
reset_deployments Resets a group's deployments
start_bulk_deployment Deploys multiple groups in one operation
stop_bulk_deployment Stops the execution of a bulk deployment
tag_resource Adds tags to a Greengrass resource
untag_resource Remove resource tags from a Greengrass Resource
update_connectivity_info Updates the connectivity information for the core
update_connector_definition Updates a connector definition
update_core_definition Updates a core definition
update_device_definition Updates a device definition
update_function_definition Updates a Lambda function definition
update_group Updates a group
update_group_certificate_configuration Updates the Certificate expiry time for a group
update_logger_definition Updates a logger definition
update_resource_definition Updates a resource definition
update_subscription_definition Updates a subscription definition
update_thing_runtime_configuration Updates the runtime configuration of a thing

Examples

## Not run: 
svc <- greengrass()
svc$associate_role_to_group(
  Foo = 123
)

## End(Not run)

AWS IoT

Description

AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

The service endpoints that expose this API are listed in AWS IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.

The service name used by AWS Signature Version 4 to sign the request is: execute-api.

For more information about how AWS IoT works, see the Developer Guide.

For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.

Usage

iot(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- iot(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

accept_certificate_transfer Accepts a pending certificate transfer
add_thing_to_billing_group Adds a thing to a billing group
add_thing_to_thing_group Adds a thing to a thing group
associate_targets_with_job Associates a group with a continuous job
attach_policy Attaches a policy to the specified target
attach_principal_policy Attaches the specified policy to the specified principal (certificate or other credential)
attach_security_profile Associates a Device Defender security profile with a thing group or this account
attach_thing_principal Attaches the specified principal to the specified thing
cancel_audit_mitigation_actions_task Cancels a mitigation action task that is in progress
cancel_audit_task Cancels an audit that is in progress
cancel_certificate_transfer Cancels a pending transfer for the specified certificate
cancel_detect_mitigation_actions_task Cancels a Device Defender ML Detect mitigation action
cancel_job Cancels a job
cancel_job_execution Cancels the execution of a job for a given thing
clear_default_authorizer Clears the default authorizer
confirm_topic_rule_destination Confirms a topic rule destination
create_audit_suppression Creates a Device Defender audit suppression
create_authorizer Creates an authorizer
create_billing_group Creates a billing group
create_certificate_from_csr Creates an X
create_custom_metric Use this API to define a Custom Metric published by your devices to Device Defender
create_dimension Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender
create_domain_configuration Creates a domain configuration
create_dynamic_thing_group Creates a dynamic thing group
create_job Creates a job
create_keys_and_certificate Creates a 2048-bit RSA key pair and issues an X
create_mitigation_action Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask
create_ota_update Creates an AWS IoT OTAUpdate on a target group of things or groups
create_policy Creates an AWS IoT policy
create_policy_version Creates a new version of the specified AWS IoT policy
create_provisioning_claim Creates a provisioning claim
create_provisioning_template Creates a fleet provisioning template
create_provisioning_template_version Creates a new version of a fleet provisioning template
create_role_alias Creates a role alias
create_scheduled_audit Creates a scheduled audit that is run at a specified time interval
create_security_profile Creates a Device Defender security profile
create_stream Creates a stream for delivering one or more large files in chunks over MQTT
create_thing Creates a thing record in the registry
create_thing_group Create a thing group
create_thing_type Creates a new thing type
create_topic_rule Creates a rule
create_topic_rule_destination Creates a topic rule destination
delete_account_audit_configuration Restores the default settings for Device Defender audits for this account
delete_audit_suppression Deletes a Device Defender audit suppression
delete_authorizer Deletes an authorizer
delete_billing_group Deletes the billing group
delete_ca_certificate Deletes a registered CA certificate
delete_certificate Deletes the specified certificate
delete_custom_metric Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of
delete_dimension Removes the specified dimension from your AWS account
delete_domain_configuration Deletes the specified domain configuration
delete_dynamic_thing_group Deletes a dynamic thing group
delete_job Deletes a job and its related job executions
delete_job_execution Deletes a job execution
delete_mitigation_action Deletes a defined mitigation action from your AWS account
delete_ota_update Delete an OTA update
delete_policy Deletes the specified policy
delete_policy_version Deletes the specified version of the specified policy
delete_provisioning_template Deletes a fleet provisioning template
delete_provisioning_template_version Deletes a fleet provisioning template version
delete_registration_code Deletes a CA certificate registration code
delete_role_alias Deletes a role alias
delete_scheduled_audit Deletes a scheduled audit
delete_security_profile Deletes a Device Defender security profile
delete_stream Deletes a stream
delete_thing Deletes the specified thing
delete_thing_group Deletes a thing group
delete_thing_type Deletes the specified thing type
delete_topic_rule Deletes the rule
delete_topic_rule_destination Deletes a topic rule destination
delete_v2_logging_level Deletes a logging level
deprecate_thing_type Deprecates a thing type
describe_account_audit_configuration Gets information about the Device Defender audit settings for this account
describe_audit_finding Gets information about a single audit finding
describe_audit_mitigation_actions_task Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings
describe_audit_suppression Gets information about a Device Defender audit suppression
describe_audit_task Gets information about a Device Defender audit
describe_authorizer Describes an authorizer
describe_billing_group Returns information about a billing group
describe_ca_certificate Describes a registered CA certificate
describe_certificate Gets information about the specified certificate
describe_custom_metric Gets information about a Device Defender detect custom metric
describe_default_authorizer Describes the default authorizer
describe_detect_mitigation_actions_task Gets information about a Device Defender ML Detect mitigation action
describe_dimension Provides details about a dimension that is defined in your AWS account
describe_domain_configuration Gets summary information about a domain configuration
describe_endpoint Returns a unique endpoint specific to the AWS account making the call
describe_event_configurations Describes event configurations
describe_index Describes a search index
describe_job Describes a job
describe_job_execution Describes a job execution
describe_mitigation_action Gets information about a mitigation action
describe_provisioning_template Returns information about a fleet provisioning template
describe_provisioning_template_version Returns information about a fleet provisioning template version
describe_role_alias Describes a role alias
describe_scheduled_audit Gets information about a scheduled audit
describe_security_profile Gets information about a Device Defender security profile
describe_stream Gets information about a stream
describe_thing Gets information about the specified thing
describe_thing_group Describe a thing group
describe_thing_registration_task Describes a bulk thing provisioning task
describe_thing_type Gets information about the specified thing type
detach_policy Detaches a policy from the specified target
detach_principal_policy Removes the specified policy from the specified certificate
detach_security_profile Disassociates a Device Defender security profile from a thing group or from this account
detach_thing_principal Detaches the specified principal from the specified thing
disable_topic_rule Disables the rule
enable_topic_rule Enables the rule
get_behavior_model_training_summaries Returns a Device Defender's ML Detect Security Profile training model's status
get_cardinality Returns the approximate count of unique values that match the query
get_effective_policies Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway
get_indexing_configuration Gets the indexing configuration
get_job_document Gets a job document
get_logging_options Gets the logging options
get_ota_update Gets an OTA update
get_percentiles Groups the aggregated values that match the query into percentile groupings
get_policy Gets information about the specified policy with the policy document of the default version
get_policy_version Gets information about the specified policy version
get_registration_code Gets a registration code used to register a CA certificate with AWS IoT
get_statistics Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field
get_topic_rule Gets information about the rule
get_topic_rule_destination Gets information about a topic rule destination
get_v2_logging_options Gets the fine grained logging options
list_active_violations Lists the active violations for a given Device Defender security profile
list_attached_policies Lists the policies attached to the specified thing group
list_audit_findings Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period
list_audit_mitigation_actions_executions Gets the status of audit mitigation action tasks that were executed
list_audit_mitigation_actions_tasks Gets a list of audit mitigation action tasks that match the specified filters
list_audit_suppressions Lists your Device Defender audit listings
list_audit_tasks Lists the Device Defender audits that have been performed during a given time period
list_authorizers Lists the authorizers registered in your account
list_billing_groups Lists the billing groups you have created
list_ca_certificates Lists the CA certificates registered for your AWS account
list_certificates Lists the certificates registered in your AWS account
list_certificates_by_ca List the device certificates signed by the specified CA certificate
list_custom_metrics Lists your Device Defender detect custom metrics
list_detect_mitigation_actions_executions Lists mitigation actions executions for a Device Defender ML Detect Security Profile
list_detect_mitigation_actions_tasks List of Device Defender ML Detect mitigation actions tasks
list_dimensions List the set of dimensions that are defined for your AWS account
list_domain_configurations Gets a list of domain configurations for the user
list_indices Lists the search indices
list_job_executions_for_job Lists the job executions for a job
list_job_executions_for_thing Lists the job executions for the specified thing
list_jobs Lists jobs
list_mitigation_actions Gets a list of all mitigation actions that match the specified filter criteria
list_ota_updates Lists OTA updates
list_outgoing_certificates Lists certificates that are being transferred but not yet accepted
list_policies Lists your policies
list_policy_principals Lists the principals associated with the specified policy
list_policy_versions Lists the versions of the specified policy and identifies the default version
list_principal_policies Lists the policies attached to the specified principal
list_principal_things Lists the things associated with the specified principal
list_provisioning_templates Lists the fleet provisioning templates in your AWS account
list_provisioning_template_versions A list of fleet provisioning template versions
list_role_aliases Lists the role aliases registered in your account
list_scheduled_audits Lists all of your scheduled audits
list_security_profiles Lists the Device Defender security profiles you've created
list_security_profiles_for_target Lists the Device Defender security profiles attached to a target (thing group)
list_streams Lists all of the streams in your AWS account
list_tags_for_resource Lists the tags (metadata) you have assigned to the resource
list_targets_for_policy List targets for the specified policy
list_targets_for_security_profile Lists the targets (thing groups) associated with a given Device Defender security profile
list_thing_groups List the thing groups in your account
list_thing_groups_for_thing List the thing groups to which the specified thing belongs
list_thing_principals Lists the principals associated with the specified thing
list_thing_registration_task_reports Information about the thing registration tasks
list_thing_registration_tasks List bulk thing provisioning tasks
list_things Lists your things
list_things_in_billing_group Lists the things you have added to the given billing group
list_things_in_thing_group Lists the things in the specified group
list_thing_types Lists the existing thing types
list_topic_rule_destinations Lists all the topic rule destinations in your AWS account
list_topic_rules Lists the rules for the specific topic
list_v2_logging_levels Lists logging levels
list_violation_events Lists the Device Defender security profile violations discovered during the given time period
register_ca_certificate Registers a CA certificate with AWS IoT
register_certificate Registers a device certificate with AWS IoT
register_certificate_without_ca Register a certificate that does not have a certificate authority (CA)
register_thing Provisions a thing in the device registry
reject_certificate_transfer Rejects a pending certificate transfer
remove_thing_from_billing_group Removes the given thing from the billing group
remove_thing_from_thing_group Remove the specified thing from the specified group
replace_topic_rule Replaces the rule
search_index The query search index
set_default_authorizer Sets the default authorizer
set_default_policy_version Sets the specified version of the specified policy as the policy's default (operative) version
set_logging_options Sets the logging options
set_v2_logging_level Sets the logging level
set_v2_logging_options Sets the logging options for the V2 logging service
start_audit_mitigation_actions_task Starts a task that applies a set of mitigation actions to the specified target
start_detect_mitigation_actions_task Starts a Device Defender ML Detect mitigation actions task
start_on_demand_audit_task Starts an on-demand Device Defender audit
start_thing_registration_task Creates a bulk thing provisioning task
stop_thing_registration_task Cancels a bulk thing provisioning task
tag_resource Adds to or modifies the tags of the given resource
test_authorization Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource
test_invoke_authorizer Tests a custom authorization behavior by invoking a specified custom authorizer
transfer_certificate Transfers the specified certificate to the specified AWS account
untag_resource Removes the given tags (metadata) from the resource
update_account_audit_configuration Configures or reconfigures the Device Defender audit settings for this account
update_audit_suppression Updates a Device Defender audit suppression
update_authorizer Updates an authorizer
update_billing_group Updates information about the billing group
update_ca_certificate Updates a registered CA certificate
update_certificate Updates the status of the specified certificate
update_custom_metric Updates a Device Defender detect custom metric
update_dimension Updates the definition for a dimension
update_domain_configuration Updates values stored in the domain configuration
update_dynamic_thing_group Updates a dynamic thing group
update_event_configurations Updates the event configurations
update_indexing_configuration Updates the search configuration
update_job Updates supported fields of the specified job
update_mitigation_action Updates the definition for the specified mitigation action
update_provisioning_template Updates a fleet provisioning template
update_role_alias Updates a role alias
update_scheduled_audit Updates a scheduled audit, including which checks are performed and how often the audit takes place
update_security_profile Updates a Device Defender security profile
update_stream Updates an existing stream
update_thing Updates the data for a thing
update_thing_group Update a thing group
update_thing_groups_for_thing Updates the groups to which the thing belongs
update_topic_rule_destination Updates a topic rule destination
validate_security_profile_behaviors Validates a Device Defender security profile behaviors specification

Examples

## Not run: 
svc <- iot()
svc$accept_certificate_transfer(
  Foo = 123
)

## End(Not run)

AWS IoT 1-Click Devices Service

Description

Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web services protocols.

Usage

iot1clickdevicesservice(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- iot1clickdevicesservice(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

claim_devices_by_claim_code Adds device(s) to your account (i
describe_device Given a device ID, returns a DescribeDeviceResponse object describing the details of the device
finalize_device_claim Given a device ID, finalizes the claim request for the associated device
get_device_methods Given a device ID, returns the invokable methods associated with the device
initiate_device_claim Given a device ID, initiates a claim request for the associated device
invoke_device_method Given a device ID, issues a request to invoke a named device method (with possible parameters)
list_device_events Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device
list_devices Lists the 1-Click compatible devices associated with your AWS account
list_tags_for_resource Lists the tags associated with the specified resource ARN
tag_resource Adds or updates the tags associated with the resource ARN
unclaim_device Disassociates a device from your AWS account using its device ID
untag_resource Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN
update_device_state Using a Boolean value (true or false), this operation enables or disables the device given a device ID

Examples

## Not run: 
svc <- iot1clickdevicesservice()
svc$claim_devices_by_claim_code(
  Foo = 123
)

## End(Not run)

AWS IoT 1-Click Projects Service

Description

The AWS IoT 1-Click Projects API Reference

Usage

iot1clickprojects(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- iot1clickprojects(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_device_with_placement Associates a physical device with a placement
create_placement Creates an empty placement
create_project Creates an empty project with a placement template
delete_placement Deletes a placement
delete_project Deletes a project
describe_placement Describes a placement in a project
describe_project Returns an object describing a project
disassociate_device_from_placement Removes a physical device from a placement
get_devices_in_placement Returns an object enumerating the devices in a placement
list_placements Lists the placement(s) of a project
list_projects Lists the AWS IoT 1-Click project(s) associated with your AWS account and region
list_tags_for_resource Lists the tags (metadata key/value pairs) which you have assigned to the resource
tag_resource Creates or modifies tags for a resource
untag_resource Removes one or more tags (metadata key/value pairs) from a resource
update_placement Updates a placement with the given attributes
update_project Updates a project associated with your AWS account and region

Examples

## Not run: 
svc <- iot1clickprojects()
svc$associate_device_with_placement(
  Foo = 123
)

## End(Not run)

AWS IoT Analytics

Description

AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.

Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources.

AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.

Usage

iotanalytics(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- iotanalytics(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

batch_put_message Sends messages to a channel
cancel_pipeline_reprocessing Cancels the reprocessing of data through the pipeline
create_channel Creates a channel
create_dataset Creates a dataset
create_dataset_content Creates the content of a data set by applying a queryAction (a SQL query) or a containerAction (executing a containerized application)
create_datastore Creates a data store, which is a repository for messages
create_pipeline Creates a pipeline
delete_channel Deletes the specified channel
delete_dataset Deletes the specified dataset
delete_dataset_content Deletes the content of the specified dataset
delete_datastore Deletes the specified data store
delete_pipeline Deletes the specified pipeline
describe_channel Retrieves information about a channel
describe_dataset Retrieves information about a dataset
describe_datastore Retrieves information about a data store
describe_logging_options Retrieves the current settings of the AWS IoT Analytics logging options
describe_pipeline Retrieves information about a pipeline
get_dataset_content Retrieves the contents of a data set as presigned URIs
list_channels Retrieves a list of channels
list_dataset_contents Lists information about data set contents that have been created
list_datasets Retrieves information about data sets
list_datastores Retrieves a list of data stores
list_pipelines Retrieves a list of pipelines
list_tags_for_resource Lists the tags (metadata) that you have assigned to the resource
put_logging_options Sets or updates the AWS IoT Analytics logging options
run_pipeline_activity Simulates the results of running a pipeline activity on a message payload
sample_channel_data Retrieves a sample of messages from the specified channel ingested during the specified timeframe
start_pipeline_reprocessing Starts the reprocessing of raw message data through the pipeline
tag_resource Adds to or modifies the tags of the given resource
untag_resource Removes the given tags (metadata) from the resource
update_channel Updates the settings of a channel
update_dataset Updates the settings of a data set
update_datastore Updates the settings of a data store
update_pipeline Updates the settings of a pipeline

Examples

## Not run: 
svc <- iotanalytics()
svc$batch_put_message(
  Foo = 123
)

## End(Not run)

AWS IoT Data Plane

Description

AWS IoT

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a persistent representation of your things and their state in the AWS cloud.

Find the endpoint address for actions in the AWS IoT data plane by running this CLI command:

⁠aws iot describe-endpoint --endpoint-type iot:Data-ATS⁠

The service name used by AWS Signature Version 4 to sign requests is: iotdevicegateway.

Usage

iotdataplane(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- iotdataplane(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

delete_thing_shadow Deletes the shadow for the specified thing
get_thing_shadow Gets the shadow for the specified thing
list_named_shadows_for_thing Lists the shadows for the specified thing
publish Publishes state information
update_thing_shadow Updates the shadow for the specified thing

Examples

## Not run: 
svc <- iotdataplane()
svc$delete_thing_shadow(
  Foo = 123
)

## End(Not run)

AWS IoT Jobs Data Plane

Description

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.

To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.

AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job

Usage

iotjobsdataplane(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- iotjobsdataplane(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

describe_job_execution Gets details of a job execution
get_pending_job_executions Gets the list of all jobs for a thing that are not in a terminal status
start_next_pending_job_execution Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing
update_job_execution Updates the status of a job execution

Examples

## Not run: 
svc <- iotjobsdataplane()
svc$describe_job_execution(
  Foo = 123
)

## End(Not run)

AWS Signer

Description

AWS Signer is a fully managed code signing service to help you ensure the trust and integrity of your code.

AWS Signer supports the following applications:

With code signing for AWS Lambda, you can sign AWS Lambda deployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch, and AWS CloudTrail. In order to sign code, you create a signing profile and then use Signer to sign Lambda zip files in S3.

With code signing for IoT, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code signing certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.

For more information about AWS Signer, see the AWS Signer Developer Guide.

Usage

signer(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- signer(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

add_profile_permission Adds cross-account permissions to a signing profile
cancel_signing_profile Changes the state of an ACTIVE signing profile to CANCELED
describe_signing_job Returns information about a specific code signing job
get_signing_platform Returns information on a specific signing platform
get_signing_profile Returns information on a specific signing profile
list_profile_permissions Lists the cross-account permissions associated with a signing profile
list_signing_jobs Lists all your signing jobs
list_signing_platforms Lists all signing platforms available in code signing that match the request parameters
list_signing_profiles Lists all available signing profiles in your AWS account
list_tags_for_resource Returns a list of the tags associated with a signing profile resource
put_signing_profile Creates a signing profile
remove_profile_permission Removes cross-account permissions from a signing profile
revoke_signature Changes the state of a signing job to REVOKED
revoke_signing_profile Changes the state of a signing profile to REVOKED
start_signing_job Initiates a signing job to be performed on the code provided
tag_resource Adds one or more tags to a signing profile
untag_resource Removes one or more tags from a signing profile

Examples

## Not run: 
svc <- signer()
svc$add_profile_permission(
  Foo = 123
)

## End(Not run)