Class: Aws::Panorama::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb

Overview

An API client for Panorama. To construct a client, you need to configure a :region and :credentials.

client = Aws::Panorama::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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Panorama::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Panorama::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



476
477
478
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 476

def initialize(*args)
  super
end

Instance Method Details

#create_application_instance(params = {}) ⇒ Types::CreateApplicationInstanceResponse

Creates an application instance and deploys it to a device.

Examples:

Request syntax with placeholder values


resp = client.create_application_instance({
  application_instance_id_to_replace: "ApplicationInstanceId",
  default_runtime_context_device: "DefaultRuntimeContextDevice", # required
  description: "Description",
  manifest_overrides_payload: {
    payload_data: "ManifestOverridesPayloadData",
  },
  manifest_payload: { # required
    payload_data: "ManifestPayloadData",
  },
  name: "ApplicationInstanceName",
  runtime_role_arn: "RuntimeRoleArn",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.application_instance_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_instance_id_to_replace (String) —

    The ID of an application instance to replace with the new instance.

  • :default_runtime_context_device (required, String) —

    A device's ID.

  • :description (String) —

    A description for the application instance.

  • :manifest_overrides_payload (Types::ManifestOverridesPayload) —

    Setting overrides for the application manifest.

  • :manifest_payload (required, Types::ManifestPayload) —

    The application's manifest document.

  • :name (String) —

    A name for the application instance.

  • :runtime_role_arn (String) —

    The ARN of a runtime role for the application instance.

  • :tags (Hash<String,String>) —

    Tags for the application instance.

Returns:

See Also:



539
540
541
542
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 539

def create_application_instance(params = {}, options = {})
  req = build_request(:create_application_instance, params)
  req.send_request(options)
end

#create_job_for_devices(params = {}) ⇒ Types::CreateJobForDevicesResponse

Creates a job to run on a device. A job can update a device's software or reboot it.

Examples:

Request syntax with placeholder values


resp = client.create_job_for_devices({
  device_ids: ["DeviceId"], # required
  device_job_config: {
    ota_job_config: {
      allow_major_version_update: false,
      image_version: "ImageVersion", # required
    },
  },
  job_type: "OTA", # required, accepts OTA, REBOOT
})

Response structure


resp.jobs #=> Array
resp.jobs[0].device_id #=> String
resp.jobs[0].job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_ids (required, Array<String>) —

    ID of target device.

  • :device_job_config (Types::DeviceJobConfig) —

    Configuration settings for a software update job.

  • :job_type (required, String) —

    The type of job to run.

Returns:

See Also:



583
584
585
586
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 583

def create_job_for_devices(params = {}, options = {})
  req = build_request(:create_job_for_devices, params)
  req.send_request(options)
end

#create_node_from_template_job(params = {}) ⇒ Types::CreateNodeFromTemplateJobResponse

Creates a camera stream node.

Examples:

Request syntax with placeholder values


resp = client.create_node_from_template_job({
  job_tags: [
    {
      resource_type: "PACKAGE", # required, accepts PACKAGE
      tags: { # required
        "TagKey" => "TagValue",
      },
    },
  ],
  node_description: "Description",
  node_name: "NodeName", # required
  output_package_name: "NodePackageName", # required
  output_package_version: "NodePackageVersion", # required
  template_parameters: { # required
    "TemplateKey" => "TemplateValue",
  },
  template_type: "RTSP_CAMERA_STREAM", # required, accepts RTSP_CAMERA_STREAM
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_tags (Array<Types::JobResourceTags>) —

    Tags for the job.

  • :node_description (String) —

    A description for the node.

  • :node_name (required, String) —

    A name for the node.

  • :output_package_name (required, String) —

    An output package name for the node.

  • :output_package_version (required, String) —

    An output package version for the node.

  • :template_parameters (required, Hash<String,String>) —

    Template parameters for the node.

  • :template_type (required, String) —

    The type of node.

Returns:

See Also:



644
645
646
647
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 644

def create_node_from_template_job(params = {}, options = {})
  req = build_request(:create_node_from_template_job, params)
  req.send_request(options)
end

#create_package(params = {}) ⇒ Types::CreatePackageResponse

Creates a package and storage location in an Amazon S3 access point.

Examples:

Request syntax with placeholder values


resp = client.create_package({
  package_name: "NodePackageName", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.package_id #=> String
resp.storage_location.binary_prefix_location #=> String
resp.storage_location.bucket #=> String
resp.storage_location.generated_prefix_location #=> String
resp.storage_location.manifest_prefix_location #=> String
resp.storage_location.repo_prefix_location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_name (required, String) —

    A name for the package.

  • :tags (Hash<String,String>) —

    Tags for the package.

Returns:

See Also:



686
687
688
689
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 686

def create_package(params = {}, options = {})
  req = build_request(:create_package, params)
  req.send_request(options)
end

#create_package_import_job(params = {}) ⇒ Types::CreatePackageImportJobResponse

Imports a node package.

Examples:

Request syntax with placeholder values


resp = client.create_package_import_job({
  client_token: "ClientToken", # required
  input_config: { # required
    package_version_input_config: {
      s3_location: { # required
        bucket_name: "BucketName", # required
        object_key: "ObjectKey", # required
        region: "Region",
      },
    },
  },
  job_tags: [
    {
      resource_type: "PACKAGE", # required, accepts PACKAGE
      tags: { # required
        "TagKey" => "TagValue",
      },
    },
  ],
  job_type: "NODE_PACKAGE_VERSION", # required, accepts NODE_PACKAGE_VERSION, MARKETPLACE_NODE_PACKAGE_VERSION
  output_config: { # required
    package_version_output_config: {
      mark_latest: false,
      package_name: "NodePackageName", # required
      package_version: "NodePackageVersion", # required
    },
  },
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



751
752
753
754
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 751

def create_package_import_job(params = {}, options = {})
  req = build_request(:create_package_import_job, params)
  req.send_request(options)
end

#delete_device(params = {}) ⇒ Types::DeleteDeviceResponse

Deletes a device.

Examples:

Request syntax with placeholder values


resp = client.delete_device({
  device_id: "DeviceId", # required
})

Response structure


resp.device_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String) —

    The device's ID.

Returns:

See Also:



779
780
781
782
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 779

def delete_device(params = {}, options = {})
  req = build_request(:delete_device, params)
  req.send_request(options)
end

#delete_package(params = {}) ⇒ Struct

Deletes a package.

To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.

Examples:

Request syntax with placeholder values


resp = client.delete_package({
  force_delete: false,
  package_id: "NodePackageId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :force_delete (Boolean) —

    Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.

  • :package_id (required, String) —

    The package's ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



811
812
813
814
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 811

def delete_package(params = {}, options = {})
  req = build_request(:delete_package, params)
  req.send_request(options)
end

#deregister_package_version(params = {}) ⇒ Struct

Deregisters a package version.

Examples:

Request syntax with placeholder values


resp = client.deregister_package_version({
  owner_account: "PackageOwnerAccount",
  package_id: "NodePackageId", # required
  package_version: "NodePackageVersion", # required
  patch_version: "NodePackagePatchVersion", # required
  updated_latest_patch_version: "NodePackagePatchVersion",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :owner_account (String) —

    An owner account.

  • :package_id (required, String) —

    A package ID.

  • :package_version (required, String) —

    A package version.

  • :patch_version (required, String) —

    A patch version.

  • :updated_latest_patch_version (String) —

    If the version was marked latest, the new version to maker as latest.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



849
850
851
852
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 849

def deregister_package_version(params = {}, options = {})
  req = build_request(:deregister_package_version, params)
  req.send_request(options)
end

#describe_application_instance(params = {}) ⇒ Types::DescribeApplicationInstanceResponse

Returns information about an application instance on a device.

Examples:

Request syntax with placeholder values


resp = client.describe_application_instance({
  application_instance_id: "ApplicationInstanceId", # required
})

Response structure


resp.application_instance_id #=> String
resp.application_instance_id_to_replace #=> String
resp.arn #=> String
resp.created_time #=> Time
resp.default_runtime_context_device #=> String
resp.default_runtime_context_device_name #=> String
resp.description #=> String
resp.health_status #=> String, one of "RUNNING", "ERROR", "NOT_AVAILABLE"
resp.last_updated_time #=> Time
resp.name #=> String
resp.runtime_context_states #=> Array
resp.runtime_context_states[0].desired_state #=> String, one of "RUNNING", "STOPPED", "REMOVED"
resp.runtime_context_states[0].device_reported_status #=> String, one of "STOPPING", "STOPPED", "STOP_ERROR", "REMOVAL_FAILED", "REMOVAL_IN_PROGRESS", "STARTING", "RUNNING", "INSTALL_ERROR", "LAUNCHED", "LAUNCH_ERROR", "INSTALL_IN_PROGRESS"
resp.runtime_context_states[0].device_reported_time #=> Time
resp.runtime_context_states[0].runtime_context_name #=> String
resp.runtime_role_arn #=> String
resp.status #=> String, one of "DEPLOYMENT_PENDING", "DEPLOYMENT_REQUESTED", "DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_ERROR", "DEPLOYMENT_SUCCEEDED", "REMOVAL_PENDING", "REMOVAL_REQUESTED", "REMOVAL_IN_PROGRESS", "REMOVAL_FAILED", "REMOVAL_SUCCEEDED", "DEPLOYMENT_FAILED"
resp.status_description #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_instance_id (required, String) —

    The application instance's ID.

Returns:

See Also:



910
911
912
913
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 910

def describe_application_instance(params = {}, options = {})
  req = build_request(:describe_application_instance, params)
  req.send_request(options)
end

#describe_application_instance_details(params = {}) ⇒ Types::DescribeApplicationInstanceDetailsResponse

Returns information about an application instance's configuration manifest.

Examples:

Request syntax with placeholder values


resp = client.describe_application_instance_details({
  application_instance_id: "ApplicationInstanceId", # required
})

Response structure


resp.application_instance_id #=> String
resp.application_instance_id_to_replace #=> String
resp.created_time #=> Time
resp.default_runtime_context_device #=> String
resp.description #=> String
resp.manifest_overrides_payload.payload_data #=> String
resp.manifest_payload.payload_data #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_instance_id (required, String) —

    The application instance's ID.

Returns:

See Also:



953
954
955
956
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 953

def describe_application_instance_details(params = {}, options = {})
  req = build_request(:describe_application_instance_details, params)
  req.send_request(options)
end

#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse

Returns information about a device.

Examples:

Request syntax with placeholder values


resp = client.describe_device({
  device_id: "DeviceId", # required
})

Response structure


resp.alternate_softwares #=> Array
resp.alternate_softwares[0].version #=> String
resp.arn #=> String
resp.brand #=> String, one of "AWS_PANORAMA", "LENOVO"
resp.created_time #=> Time
resp.current_networking_status.ethernet_0_status.connection_status #=> String, one of "CONNECTED", "NOT_CONNECTED", "CONNECTING"
resp.current_networking_status.ethernet_0_status.hw_address #=> String
resp.current_networking_status.ethernet_0_status.ip_address #=> String
resp.current_networking_status.ethernet_1_status.connection_status #=> String, one of "CONNECTED", "NOT_CONNECTED", "CONNECTING"
resp.current_networking_status.ethernet_1_status.hw_address #=> String
resp.current_networking_status.ethernet_1_status.ip_address #=> String
resp.current_networking_status.last_updated_time #=> Time
resp.current_networking_status.ntp_status.connection_status #=> String, one of "CONNECTED", "NOT_CONNECTED", "CONNECTING"
resp.current_networking_status.ntp_status.ip_address #=> String
resp.current_networking_status.ntp_status.ntp_server_name #=> String
resp.current_software #=> String
resp.description #=> String
resp.device_aggregated_status #=> String, one of "ERROR", "AWAITING_PROVISIONING", "PENDING", "FAILED", "DELETING", "ONLINE", "OFFLINE", "LEASE_EXPIRED", "UPDATE_NEEDED", "REBOOTING"
resp.device_connection_status #=> String, one of "ONLINE", "OFFLINE", "AWAITING_CREDENTIALS", "NOT_AVAILABLE", "ERROR"
resp.device_id #=> String
resp.latest_alternate_software #=> String
resp.latest_device_job.image_version #=> String
resp.latest_device_job.job_type #=> String, one of "OTA", "REBOOT"
resp.latest_device_job.status #=> String, one of "PENDING", "IN_PROGRESS", "VERIFYING", "REBOOTING", "DOWNLOADING", "COMPLETED", "FAILED"
resp.latest_software #=> String
resp.lease_expiration_time #=> Time
resp.name #=> String
resp.networking_configuration.ethernet_0.connection_type #=> String, one of "STATIC_IP", "DHCP"
resp.networking_configuration.ethernet_0.static_ip_connection_info.default_gateway #=> String
resp.networking_configuration.ethernet_0.static_ip_connection_info.dns #=> Array
resp.networking_configuration.ethernet_0.static_ip_connection_info.dns[0] #=> String
resp.networking_configuration.ethernet_0.static_ip_connection_info.ip_address #=> String
resp.networking_configuration.ethernet_0.static_ip_connection_info.mask #=> String
resp.networking_configuration.ethernet_1.connection_type #=> String, one of "STATIC_IP", "DHCP"
resp.networking_configuration.ethernet_1.static_ip_connection_info.default_gateway #=> String
resp.networking_configuration.ethernet_1.static_ip_connection_info.dns #=> Array
resp.networking_configuration.ethernet_1.static_ip_connection_info.dns[0] #=> String
resp.networking_configuration.ethernet_1.static_ip_connection_info.ip_address #=> String
resp.networking_configuration.ethernet_1.static_ip_connection_info.mask #=> String
resp.networking_configuration.ntp.ntp_servers #=> Array
resp.networking_configuration.ntp.ntp_servers[0] #=> String
resp.provisioning_status #=> String, one of "AWAITING_PROVISIONING", "PENDING", "SUCCEEDED", "FAILED", "ERROR", "DELETING"
resp.serial_number #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.type #=> String, one of "PANORAMA_APPLIANCE_DEVELOPER_KIT", "PANORAMA_APPLIANCE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String) —

    The device's ID.

Returns:

See Also:



1045
1046
1047
1048
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1045

def describe_device(params = {}, options = {})
  req = build_request(:describe_device, params)
  req.send_request(options)
end

#describe_device_job(params = {}) ⇒ Types::DescribeDeviceJobResponse

Returns information about a device job.

Examples:

Request syntax with placeholder values


resp = client.describe_device_job({
  job_id: "JobId", # required
})

Response structure


resp.created_time #=> Time
resp.device_arn #=> String
resp.device_id #=> String
resp.device_name #=> String
resp.device_type #=> String, one of "PANORAMA_APPLIANCE_DEVELOPER_KIT", "PANORAMA_APPLIANCE"
resp.image_version #=> String
resp.job_id #=> String
resp.job_type #=> String, one of "OTA", "REBOOT"
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "VERIFYING", "REBOOTING", "DOWNLOADING", "COMPLETED", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job's ID.

Returns:

See Also:



1089
1090
1091
1092
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1089

def describe_device_job(params = {}, options = {})
  req = build_request(:describe_device_job, params)
  req.send_request(options)
end

#describe_node(params = {}) ⇒ Types::DescribeNodeResponse

Returns information about a node.

Examples:

Request syntax with placeholder values


resp = client.describe_node({
  node_id: "NodeId", # required
  owner_account: "PackageOwnerAccount",
})

Response structure


resp.asset_name #=> String
resp.category #=> String, one of "BUSINESS_LOGIC", "ML_MODEL", "MEDIA_SOURCE", "MEDIA_SINK"
resp.created_time #=> Time
resp.description #=> String
resp.last_updated_time #=> Time
resp.name #=> String
resp.node_id #=> String
resp.node_interface.inputs #=> Array
resp.node_interface.inputs[0].default_value #=> String
resp.node_interface.inputs[0].description #=> String
resp.node_interface.inputs[0].max_connections #=> Integer
resp.node_interface.inputs[0].name #=> String
resp.node_interface.inputs[0].type #=> String, one of "BOOLEAN", "STRING", "INT32", "FLOAT32", "MEDIA"
resp.node_interface.outputs #=> Array
resp.node_interface.outputs[0].description #=> String
resp.node_interface.outputs[0].name #=> String
resp.node_interface.outputs[0].type #=> String, one of "BOOLEAN", "STRING", "INT32", "FLOAT32", "MEDIA"
resp. #=> String
resp.package_arn #=> String
resp.package_id #=> String
resp.package_name #=> String
resp.package_version #=> String
resp.patch_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :node_id (required, String) —

    The node's ID.

  • :owner_account (String) —

    The account ID of the node's owner.

Returns:

See Also:



1156
1157
1158
1159
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1156

def describe_node(params = {}, options = {})
  req = build_request(:describe_node, params)
  req.send_request(options)
end

#describe_node_from_template_job(params = {}) ⇒ Types::DescribeNodeFromTemplateJobResponse

Returns information about a job to create a camera stream node.

Examples:

Request syntax with placeholder values


resp = client.describe_node_from_template_job({
  job_id: "JobId", # required
})

Response structure


resp.created_time #=> Time
resp.job_id #=> String
resp.job_tags #=> Array
resp.job_tags[0].resource_type #=> String, one of "PACKAGE"
resp.job_tags[0].tags #=> Hash
resp.job_tags[0].tags["TagKey"] #=> String
resp.last_updated_time #=> Time
resp.node_description #=> String
resp.node_name #=> String
resp.output_package_name #=> String
resp.output_package_version #=> String
resp.status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
resp.status_message #=> String
resp.template_parameters #=> Hash
resp.template_parameters["TemplateKey"] #=> String
resp.template_type #=> String, one of "RTSP_CAMERA_STREAM"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job's ID.

Returns:

See Also:



1210
1211
1212
1213
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1210

def describe_node_from_template_job(params = {}, options = {})
  req = build_request(:describe_node_from_template_job, params)
  req.send_request(options)
end

#describe_package(params = {}) ⇒ Types::DescribePackageResponse

Returns information about a package.

Examples:

Request syntax with placeholder values


resp = client.describe_package({
  package_id: "NodePackageId", # required
})

Response structure


resp.arn #=> String
resp.created_time #=> Time
resp.package_id #=> String
resp.package_name #=> String
resp.read_access_principal_arns #=> Array
resp.read_access_principal_arns[0] #=> String
resp.storage_location.binary_prefix_location #=> String
resp.storage_location.bucket #=> String
resp.storage_location.generated_prefix_location #=> String
resp.storage_location.manifest_prefix_location #=> String
resp.storage_location.repo_prefix_location #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.write_access_principal_arns #=> Array
resp.write_access_principal_arns[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_id (required, String) —

    The package's ID.

Returns:

See Also:



1259
1260
1261
1262
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1259

def describe_package(params = {}, options = {})
  req = build_request(:describe_package, params)
  req.send_request(options)
end

#describe_package_import_job(params = {}) ⇒ Types::DescribePackageImportJobResponse

Returns information about a package import job.

Examples:

Request syntax with placeholder values


resp = client.describe_package_import_job({
  job_id: "JobId", # required
})

Response structure


resp.client_token #=> String
resp.created_time #=> Time
resp.input_config.package_version_input_config.s3_location.bucket_name #=> String
resp.input_config.package_version_input_config.s3_location.object_key #=> String
resp.input_config.package_version_input_config.s3_location.region #=> String
resp.job_id #=> String
resp.job_tags #=> Array
resp.job_tags[0].resource_type #=> String, one of "PACKAGE"
resp.job_tags[0].tags #=> Hash
resp.job_tags[0].tags["TagKey"] #=> String
resp.job_type #=> String, one of "NODE_PACKAGE_VERSION", "MARKETPLACE_NODE_PACKAGE_VERSION"
resp.last_updated_time #=> Time
resp.output.output_s3_location.bucket_name #=> String
resp.output.output_s3_location.object_key #=> String
resp.output.package_id #=> String
resp.output.package_version #=> String
resp.output.patch_version #=> String
resp.output_config.package_version_output_config.mark_latest #=> Boolean
resp.output_config.package_version_output_config.package_name #=> String
resp.output_config.package_version_output_config.package_version #=> String
resp.status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
resp.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job's ID.

Returns:

See Also:



1318
1319
1320
1321
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1318

def describe_package_import_job(params = {}, options = {})
  req = build_request(:describe_package_import_job, params)
  req.send_request(options)
end

#describe_package_version(params = {}) ⇒ Types::DescribePackageVersionResponse

Returns information about a package version.

Examples:

Request syntax with placeholder values


resp = client.describe_package_version({
  owner_account: "PackageOwnerAccount",
  package_id: "NodePackageId", # required
  package_version: "NodePackageVersion", # required
  patch_version: "NodePackagePatchVersion",
})

Response structure


resp.is_latest_patch #=> Boolean
resp. #=> String
resp.package_arn #=> String
resp.package_id #=> String
resp.package_name #=> String
resp.package_version #=> String
resp.patch_version #=> String
resp.registered_time #=> Time
resp.status #=> String, one of "REGISTER_PENDING", "REGISTER_COMPLETED", "FAILED", "DELETING"
resp.status_description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :owner_account (String) —

    The version's owner account.

  • :package_id (required, String) —

    The version's ID.

  • :package_version (required, String) —

    The version's version.

  • :patch_version (String) —

    The version's patch version.

Returns:

See Also:



1376
1377
1378
1379
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1376

def describe_package_version(params = {}, options = {})
  req = build_request(:describe_package_version, params)
  req.send_request(options)
end

#list_application_instance_dependencies(params = {}) ⇒ Types::ListApplicationInstanceDependenciesResponse

Returns a list of application instance dependencies.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_application_instance_dependencies({
  application_instance_id: "ApplicationInstanceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.package_objects #=> Array
resp.package_objects[0].name #=> String
resp.package_objects[0].package_version #=> String
resp.package_objects[0].patch_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_instance_id (required, String) —

    The application instance's ID.

  • :max_results (Integer) —

    The maximum number of application instance dependencies to return in one page of results.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

See Also:



1421
1422
1423
1424
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1421

def list_application_instance_dependencies(params = {}, options = {})
  req = build_request(:list_application_instance_dependencies, params)
  req.send_request(options)
end

#list_application_instance_node_instances(params = {}) ⇒ Types::ListApplicationInstanceNodeInstancesResponse

Returns a list of application node instances.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_application_instance_node_instances({
  application_instance_id: "ApplicationInstanceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.node_instances #=> Array
resp.node_instances[0].current_status #=> String, one of "RUNNING", "ERROR", "NOT_AVAILABLE", "PAUSED"
resp.node_instances[0].node_id #=> String
resp.node_instances[0].node_instance_id #=> String
resp.node_instances[0].node_name #=> String
resp.node_instances[0].package_name #=> String
resp.node_instances[0].package_patch_version #=> String
resp.node_instances[0].package_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_instance_id (required, String) —

    The node instances' application instance ID.

  • :max_results (Integer) —

    The maximum number of node instances to return in one page of results.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

See Also:



1469
1470
1471
1472
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1469

def list_application_instance_node_instances(params = {}, options = {})
  req = build_request(:list_application_instance_node_instances, params)
  req.send_request(options)
end

#list_application_instances(params = {}) ⇒ Types::ListApplicationInstancesResponse

Returns a list of application instances.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_application_instances({
  device_id: "DeviceId",
  max_results: 1,
  next_token: "NextToken",
  status_filter: "DEPLOYMENT_SUCCEEDED", # accepts DEPLOYMENT_SUCCEEDED, DEPLOYMENT_ERROR, REMOVAL_SUCCEEDED, REMOVAL_FAILED, PROCESSING_DEPLOYMENT, PROCESSING_REMOVAL, DEPLOYMENT_FAILED
})

Response structure


resp.application_instances #=> Array
resp.application_instances[0].application_instance_id #=> String
resp.application_instances[0].arn #=> String
resp.application_instances[0].created_time #=> Time
resp.application_instances[0].default_runtime_context_device #=> String
resp.application_instances[0].default_runtime_context_device_name #=> String
resp.application_instances[0].description #=> String
resp.application_instances[0].health_status #=> String, one of "RUNNING", "ERROR", "NOT_AVAILABLE"
resp.application_instances[0].name #=> String
resp.application_instances[0].runtime_context_states #=> Array
resp.application_instances[0].runtime_context_states[0].desired_state #=> String, one of "RUNNING", "STOPPED", "REMOVED"
resp.application_instances[0].runtime_context_states[0].device_reported_status #=> String, one of "STOPPING", "STOPPED", "STOP_ERROR", "REMOVAL_FAILED", "REMOVAL_IN_PROGRESS", "STARTING", "RUNNING", "INSTALL_ERROR", "LAUNCHED", "LAUNCH_ERROR", "INSTALL_IN_PROGRESS"
resp.application_instances[0].runtime_context_states[0].device_reported_time #=> Time
resp.application_instances[0].runtime_context_states[0].runtime_context_name #=> String
resp.application_instances[0].status #=> String, one of "DEPLOYMENT_PENDING", "DEPLOYMENT_REQUESTED", "DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_ERROR", "DEPLOYMENT_SUCCEEDED", "REMOVAL_PENDING", "REMOVAL_REQUESTED", "REMOVAL_IN_PROGRESS", "REMOVAL_FAILED", "REMOVAL_SUCCEEDED", "DEPLOYMENT_FAILED"
resp.application_instances[0].status_description #=> String
resp.application_instances[0].tags #=> Hash
resp.application_instances[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (String) —

    The application instances' device ID.

  • :max_results (Integer) —

    The maximum number of application instances to return in one page of results.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :status_filter (String) —

    Only include instances with a specific status.

Returns:

See Also:



1532
1533
1534
1535
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1532

def list_application_instances(params = {}, options = {})
  req = build_request(:list_application_instances, params)
  req.send_request(options)
end

#list_devices(params = {}) ⇒ Types::ListDevicesResponse

Returns a list of devices.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_devices({
  device_aggregated_status_filter: "ERROR", # accepts ERROR, AWAITING_PROVISIONING, PENDING, FAILED, DELETING, ONLINE, OFFLINE, LEASE_EXPIRED, UPDATE_NEEDED, REBOOTING
  max_results: 1,
  name_filter: "NameFilter",
  next_token: "NextToken",
  sort_by: "DEVICE_ID", # accepts DEVICE_ID, CREATED_TIME, NAME, DEVICE_AGGREGATED_STATUS
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.devices #=> Array
resp.devices[0].brand #=> String, one of "AWS_PANORAMA", "LENOVO"
resp.devices[0].created_time #=> Time
resp.devices[0].current_software #=> String
resp.devices[0].description #=> String
resp.devices[0].device_aggregated_status #=> String, one of "ERROR", "AWAITING_PROVISIONING", "PENDING", "FAILED", "DELETING", "ONLINE", "OFFLINE", "LEASE_EXPIRED", "UPDATE_NEEDED", "REBOOTING"
resp.devices[0].device_id #=> String
resp.devices[0].last_updated_time #=> Time
resp.devices[0].latest_device_job.image_version #=> String
resp.devices[0].latest_device_job.job_type #=> String, one of "OTA", "REBOOT"
resp.devices[0].latest_device_job.status #=> String, one of "PENDING", "IN_PROGRESS", "VERIFYING", "REBOOTING", "DOWNLOADING", "COMPLETED", "FAILED"
resp.devices[0].lease_expiration_time #=> Time
resp.devices[0].name #=> String
resp.devices[0].provisioning_status #=> String, one of "AWAITING_PROVISIONING", "PENDING", "SUCCEEDED", "FAILED", "ERROR", "DELETING"
resp.devices[0].tags #=> Hash
resp.devices[0].tags["TagKey"] #=> String
resp.devices[0].type #=> String, one of "PANORAMA_APPLIANCE_DEVELOPER_KIT", "PANORAMA_APPLIANCE"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_aggregated_status_filter (String) —

    Filter based on a device's status.

  • :max_results (Integer) —

    The maximum number of devices to return in one page of results.

  • :name_filter (String) —

    Filter based on device's name. Prefixes supported.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :sort_by (String) —

    The target column to be sorted on. Default column sort is CREATED_TIME.

  • :sort_order (String) —

    The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Returns:

See Also:



1603
1604
1605
1606
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1603

def list_devices(params = {}, options = {})
  req = build_request(:list_devices, params)
  req.send_request(options)
end

#list_devices_jobs(params = {}) ⇒ Types::ListDevicesJobsResponse

Returns a list of jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_devices_jobs({
  device_id: "DeviceId",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.device_jobs #=> Array
resp.device_jobs[0].created_time #=> Time
resp.device_jobs[0].device_id #=> String
resp.device_jobs[0].device_name #=> String
resp.device_jobs[0].job_id #=> String
resp.device_jobs[0].job_type #=> String, one of "OTA", "REBOOT"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (String) —

    Filter results by the job's target device ID.

  • :max_results (Integer) —

    The maximum number of device jobs to return in one page of results.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

See Also:



1649
1650
1651
1652
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1649

def list_devices_jobs(params = {}, options = {})
  req = build_request(:list_devices_jobs, params)
  req.send_request(options)
end

#list_node_from_template_jobs(params = {}) ⇒ Types::ListNodeFromTemplateJobsResponse

Returns a list of camera stream node jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_node_from_template_jobs({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.node_from_template_jobs #=> Array
resp.node_from_template_jobs[0].created_time #=> Time
resp.node_from_template_jobs[0].job_id #=> String
resp.node_from_template_jobs[0].node_name #=> String
resp.node_from_template_jobs[0].status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
resp.node_from_template_jobs[0].status_message #=> String
resp.node_from_template_jobs[0].template_type #=> String, one of "RTSP_CAMERA_STREAM"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of node from template jobs to return in one page of results.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

See Also:



1693
1694
1695
1696
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1693

def list_node_from_template_jobs(params = {}, options = {})
  req = build_request(:list_node_from_template_jobs, params)
  req.send_request(options)
end

#list_nodes(params = {}) ⇒ Types::ListNodesResponse

Returns a list of nodes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_nodes({
  category: "BUSINESS_LOGIC", # accepts BUSINESS_LOGIC, ML_MODEL, MEDIA_SOURCE, MEDIA_SINK
  max_results: 1,
  next_token: "Token",
  owner_account: "PackageOwnerAccount",
  package_name: "NodePackageName",
  package_version: "NodePackageVersion",
  patch_version: "NodePackagePatchVersion",
})

Response structure


resp.next_token #=> String
resp.nodes #=> Array
resp.nodes[0].category #=> String, one of "BUSINESS_LOGIC", "ML_MODEL", "MEDIA_SOURCE", "MEDIA_SINK"
resp.nodes[0].created_time #=> Time
resp.nodes[0].description #=> String
resp.nodes[0].name #=> String
resp.nodes[0].node_id #=> String
resp.nodes[0]. #=> String
resp.nodes[0].package_arn #=> String
resp.nodes[0].package_id #=> String
resp.nodes[0].package_name #=> String
resp.nodes[0].package_version #=> String
resp.nodes[0].patch_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :category (String) —

    Search for nodes by category.

  • :max_results (Integer) —

    The maximum number of nodes to return in one page of results.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

  • :owner_account (String) —

    Search for nodes by the account ID of the nodes' owner.

  • :package_name (String) —

    Search for nodes by name.

  • :package_version (String) —

    Search for nodes by version.

  • :patch_version (String) —

    Search for nodes by patch version.

Returns:

See Also:



1761
1762
1763
1764
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1761

def list_nodes(params = {}, options = {})
  req = build_request(:list_nodes, params)
  req.send_request(options)
end

#list_package_import_jobs(params = {}) ⇒ Types::ListPackageImportJobsResponse

Returns a list of package import jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_package_import_jobs({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.package_import_jobs #=> Array
resp.package_import_jobs[0].created_time #=> Time
resp.package_import_jobs[0].job_id #=> String
resp.package_import_jobs[0].job_type #=> String, one of "NODE_PACKAGE_VERSION", "MARKETPLACE_NODE_PACKAGE_VERSION"
resp.package_import_jobs[0].last_updated_time #=> Time
resp.package_import_jobs[0].status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
resp.package_import_jobs[0].status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of package import jobs to return in one page of results.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

See Also:



1805
1806
1807
1808
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1805

def list_package_import_jobs(params = {}, options = {})
  req = build_request(:list_package_import_jobs, params)
  req.send_request(options)
end

#list_packages(params = {}) ⇒ Types::ListPackagesResponse

Returns a list of packages.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_packages({
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.next_token #=> String
resp.packages #=> Array
resp.packages[0].arn #=> String
resp.packages[0].created_time #=> Time
resp.packages[0].package_id #=> String
resp.packages[0].package_name #=> String
resp.packages[0].tags #=> Hash
resp.packages[0].tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of packages to return in one page of results.

  • :next_token (String) —

    Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

See Also:



1848
1849
1850
1851
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1848

def list_packages(params = {}, options = {})
  req = build_request(:list_packages, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's ARN.

Returns:

See Also:



1877
1878
1879
1880
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1877

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#provision_device(params = {}) ⇒ Types::ProvisionDeviceResponse

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

Examples:

Request syntax with placeholder values


resp = client.provision_device({
  description: "Description",
  name: "DeviceName", # required
  networking_configuration: {
    ethernet_0: {
      connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
      static_ip_connection_info: {
        default_gateway: "DefaultGateway", # required
        dns: ["Dns"], # required
        ip_address: "IpAddress", # required
        mask: "Mask", # required
      },
    },
    ethernet_1: {
      connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
      static_ip_connection_info: {
        default_gateway: "DefaultGateway", # required
        dns: ["Dns"], # required
        ip_address: "IpAddress", # required
        mask: "Mask", # required
      },
    },
    ntp: {
      ntp_servers: ["IpAddressOrServerName"], # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.certificates #=> String
resp.device_id #=> String
resp.iot_thing_name #=> String
resp.status #=> String, one of "AWAITING_PROVISIONING", "PENDING", "SUCCEEDED", "FAILED", "ERROR", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the device.

  • :name (required, String) —

    A name for the device.

  • :networking_configuration (Types::NetworkPayload) —

    A networking configuration for the device.

  • :tags (Hash<String,String>) —

    Tags for the device.

Returns:

See Also:



1954
1955
1956
1957
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1954

def provision_device(params = {}, options = {})
  req = build_request(:provision_device, params)
  req.send_request(options)
end

#register_package_version(params = {}) ⇒ Struct

Registers a package version.

Examples:

Request syntax with placeholder values


resp = client.register_package_version({
  mark_latest: false,
  owner_account: "PackageOwnerAccount",
  package_id: "NodePackageId", # required
  package_version: "NodePackageVersion", # required
  patch_version: "NodePackagePatchVersion", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mark_latest (Boolean) —

    Whether to mark the new version as the latest version.

  • :owner_account (String) —

    An owner account.

  • :package_id (required, String) —

    A package ID.

  • :package_version (required, String) —

    A package version.

  • :patch_version (required, String) —

    A patch version.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1992
1993
1994
1995
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1992

def register_package_version(params = {}, options = {})
  req = build_request(:register_package_version, params)
  req.send_request(options)
end

#remove_application_instance(params = {}) ⇒ Struct

Removes an application instance.

Examples:

Request syntax with placeholder values


resp = client.remove_application_instance({
  application_instance_id: "ApplicationInstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_instance_id (required, String) —

    An application instance ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2014
2015
2016
2017
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2014

def remove_application_instance(params = {}, options = {})
  req = build_request(:remove_application_instance, params)
  req.send_request(options)
end

#signal_application_instance_node_instances(params = {}) ⇒ Types::SignalApplicationInstanceNodeInstancesResponse

Signal camera nodes to stop or resume.

Examples:

Request syntax with placeholder values


resp = client.signal_application_instance_node_instances({
  application_instance_id: "ApplicationInstanceId", # required
  node_signals: [ # required
    {
      node_instance_id: "NodeInstanceId", # required
      signal: "PAUSE", # required, accepts PAUSE, RESUME
    },
  ],
})

Response structure


resp.application_instance_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_instance_id (required, String) —

    An application instance ID.

  • :node_signals (required, Array<Types::NodeSignal>) —

    A list of signals.

Returns:

See Also:



2051
2052
2053
2054
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2051

def signal_application_instance_node_instances(params = {}, options = {})
  req = build_request(:signal_application_instance_node_instances, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Tags a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's ARN.

  • :tags (required, Hash<String,String>) —

    Tags for the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2079
2080
2081
2082
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2079

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's ARN.

  • :tag_keys (required, Array<String>) —

    Tag keys to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2105
2106
2107
2108
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2105

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_device_metadata(params = {}) ⇒ Types::UpdateDeviceMetadataResponse

Updates a device's metadata.

Examples:

Request syntax with placeholder values


resp = client.update_device_metadata({
  description: "Description",
  device_id: "DeviceId", # required
})

Response structure


resp.device_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description for the device.

  • :device_id (required, String) —

    The device's ID.

Returns:

See Also:



2137
2138
2139
2140
 
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2137

def update_device_metadata(params = {}, options = {})
  req = build_request(:update_device_metadata, params)
  req.send_request(options)
end