Client

panorama

R Documentation

AWS Panorama

Description

Overview

This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide.

Usage

panorama(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

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 <- panorama(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_application_instance	Creates an application instance and deploys it to a device
create_job_for_devices	Creates a job to run on a device
create_node_from_template_job	Creates a camera stream node
create_package	Creates a package and storage location in an Amazon S3 access point
create_package_import_job	Imports a node package
delete_device	Deletes a device
delete_package	Deletes a package
deregister_package_version	Deregisters a package version
describe_application_instance	Returns information about an application instance on a device
describe_application_instance_details	Returns information about an application instance's configuration manifest
describe_device	Returns information about a device
describe_device_job	Returns information about a device job
describe_node	Returns information about a node
describe_node_from_template_job	Returns information about a job to create a camera stream node
describe_package	Returns information about a package
describe_package_import_job	Returns information about a package import job
describe_package_version	Returns information about a package version
list_application_instance_dependencies	Returns a list of application instance dependencies
list_application_instance_node_instances	Returns a list of application node instances
list_application_instances	Returns a list of application instances
list_devices	Returns a list of devices
list_devices_jobs	Returns a list of jobs
list_node_from_template_jobs	Returns a list of camera stream node jobs
list_nodes	Returns a list of nodes
list_package_import_jobs	Returns a list of package import jobs
list_packages	Returns a list of packages
list_tags_for_resource	Returns a list of tags for a resource
provision_device	Creates a device and returns a configuration archive
register_package_version	Registers a package version
remove_application_instance	Removes an application instance
signal_application_instance_node_instances	Signal camera nodes to stop or resume
tag_resource	Tags a resource
untag_resource	Removes tags from a resource
update_device_metadata	Updates a device's metadata

Examples

## Not run: 
svc <- panorama()
svc$create_application_instance(
  Foo = 123
)

## End(Not run)