[ aws . iot-managed-integrations ]

get-managed-thing

Description

Get the attributes and capabilities associated with a managed thing.

See also: AWS API Documentation

Synopsis

  get-managed-thing
--identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--identifier (string)

The id of the managed thing.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Id -> (string)

The id of the managed thing.

Arn -> (string)

The Amazon Resource Name (ARN) of the managed thing.

Owner -> (string)

Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

CredentialLockerId -> (string)

The identifier of the credential locker for the managed thing.

AdvertisedProductId -> (string)

The id of the advertised product.

Role -> (string)

The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.

ProvisioningStatus -> (string)

The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.

Name -> (string)

The name of the managed thing representing the physical device.

Model -> (string)

The model of the device.

Brand -> (string)

The brand of the device.

SerialNumber -> (string)

The serial number of the device.

UniversalProductCode -> (string)

The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada.

InternationalArticleNumber -> (string)

The unique 13 digit number that identifies the managed thing.

ConnectorPolicyId -> (string)

The id of the connector policy.

Note

This parameter is used for cloud-to-cloud devices only.

ConnectorDeviceId -> (string)

The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).

Note

This parameter is used for cloud-to-cloud devices only.

DeviceSpecificKey -> (string)

A Zwave device-specific key used during device activation.

Note

This parameter is used for Zwave devices only.

MacAddress -> (string)

The media access control (MAC) address for the device represented by the managed thing.

Note

This parameter is used for Zigbee devices only.

ParentControllerId -> (string)

Id of the controller device used for the discovery job.

Classification -> (string)

The classification of the managed thing such as light bulb or thermostat.

CreatedAt -> (timestamp)

The timestamp value of when the device creation request occurred.

UpdatedAt -> (timestamp)

The timestamp value of when the managed thing was last updated at.

ActivatedAt -> (timestamp)

The timestampe value of when the device was activated.

HubNetworkMode -> (string)

The network mode for the hub-connected device.

MetaData -> (map)

The metadata for the managed thing.

key -> (string)

value -> (string)

Tags -> (map)

A set of key/value pairs that are used to manage the managed thing.

key -> (string)

value -> (string)