AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot-managed-integrations ]

send-connector-event

Description

Relays third-party device events for a connector such as a new device or a device state change event.

See also: AWS API Documentation

send-connector-event uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  send-connector-event
--connector-id <value>
[--user-id <value>]
--operation <value>
[--operation-version <value>]
[--status-code <value>]
[--message <value>]
[--device-discovery-id <value>]
[--connector-device-id <value>]
[--trace-id <value>]
[--devices <value>]
[--matter-endpoint <value>]
[--cli-input-json <value>]
[--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>]

Options

--connector-id (string)

The id of the connector between the third-party cloud provider and IoT managed integrations.

--user-id (string)

The id of the third-party cloud provider.

--operation (string)

The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.

Note

The field op can have a value of “I” or “U”. The field “cn” will contain the capability types.

Possible values:

  • DEVICE_COMMAND_RESPONSE
  • DEVICE_DISCOVERY
  • DEVICE_EVENT
  • DEVICE_COMMAND_REQUEST

--operation-version (string)

The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification .

--status-code (integer)

The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.

--message (string)

The device state change event payload.

This parameter will include the following three fields:

  • uri : schema auc://<PARTNER-DEVICE-ID>/ResourcePath (The Resourcepath corresponds to an OCF resource.)
  • op : For device state changes, this field must populate as n+d .
  • cn : The content depends on the OCF resource referenced in ResourcePath .

--device-discovery-id (string)

The id for the device discovery job.

--connector-device-id (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.

--trace-id (string)

The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.

--devices (list)

The list of devices.

(structure)

Describe the device using the relevant metadata and supported clusters for device discovery.

ConnectorDeviceId -> (string)

The device id as defined by the connector.

Note

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

ConnectorDeviceName -> (string)

The name of the device as defined by the connector.

CapabilityReport -> (structure)

The capability report for the device.

version -> (string)

The version of the capability report.

nodeId -> (string)

The numeric identifier of the node.

endpoints -> (list)

The endpoints used in the capability report.

(structure)

Matter endpoint used in capability report.

id -> (string)

The id of the Amazon Web Services Matter capability report endpoint.

deviceTypes -> (list)

The type of device.

(string)

clusters -> (list)

Matter clusters used in capability report.

(structure)

Capability used in Matter capability report.

id -> (string)

The id of the Amazon Web Services Matter capability report cluster.

revision -> (integer)

The id of the revision for the Amazon Web Services Matter capability report.

publicId -> (string)

The id of the schema version.

name -> (string)

The capability name used in the Amazon Web Services Matter capability report.

specVersion -> (string)

The spec version used in the Amazon Web Services Matter capability report.

attributes -> (list)

The attributes of the Amazon Web Services Matter capability report.

(structure)

Matter attribute used in capability report.

id -> (string)

The id of the Matter attribute.

name -> (string)

Name for the Amazon Web Services Matter capability report attribute.

value -> (document)

Value for the Amazon Web Services Matter capability report attribute.

commands -> (list)

The commands used with the Amazon Web Services Matter capability report.

(string)

events -> (list)

The events used with the Amazon Web Services Matter capability report.

(string)

featureMap -> (long)

32 bit-map used to indicate which features a cluster supports.

generatedCommands -> (list)

Matter clusters used in capability report.

(string)

fabricIndex -> (integer)

The fabric index for the Amazon Web Services Matter capability report.

parts -> (list)

Heirachy of child endpoints contained in the given endpoint.

(string)

semanticTags -> (list)

Semantic information related to endpoint.

(string)

clientClusters -> (list)

Semantic information related to endpoint.

(string)

CapabilitySchemas -> (list)

Report of all capabilities supported by the device.

(structure)

Structure representing a capability schema item that defines the functionality and features supported by a managed thing.

Format -> (string)

The format of the capability schema, which defines how the schema is structured and interpreted.

CapabilityId -> (string)

The unique identifier of the capability defined in the schema.

ExtrinsicId -> (string)

The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem.

ExtrinsicVersion -> (integer)

The version of the external capability definition, used to track compatibility with external systems.

Schema -> (document)

The actual schema definition that describes the capability’s properties, actions, and events.

DeviceMetadata -> (document)

The metadata attributes for a device.

JSON Syntax:

[
  {
    "ConnectorDeviceId": "string",
    "ConnectorDeviceName": "string",
    "CapabilityReport": {
      "version": "string",
      "nodeId": "string",
      "endpoints": [
        {
          "id": "string",
          "deviceTypes": ["string", ...],
          "clusters": [
            {
              "id": "string",
              "revision": integer,
              "publicId": "string",
              "name": "string",
              "specVersion": "string",
              "attributes": [
                {
                  "id": "string",
                  "name": "string",
                  "value": {...}
                }
                ...
              ],
              "commands": ["string", ...],
              "events": ["string", ...],
              "featureMap": long,
              "generatedCommands": ["string", ...],
              "fabricIndex": integer
            }
            ...
          ],
          "parts": ["string", ...],
          "semanticTags": ["string", ...],
          "clientClusters": ["string", ...]
        }
        ...
      ]
    },
    "CapabilitySchemas": [
      {
        "Format": "AWS"|"ZCL"|"CONNECTOR",
        "CapabilityId": "string",
        "ExtrinsicId": "string",
        "ExtrinsicVersion": integer,
        "Schema": {...}
      }
      ...
    ],
    "DeviceMetadata": {...}
  }
  ...
]

--matter-endpoint (structure)

The device endpoint.

id -> (string)

The Matter endpoint id.

clusters -> (list)

A list of Matter clusters for a managed thing.

(structure)

Describe a Matter cluster with an id, and the relevant attributes, commands, and events.

id -> (string)

The cluster id.

attributes -> (document)

The Matter attributes.

commands -> (map)

Describe the Matter commands with the Matter command identifier mapped to the command fields.

key -> (string)

value -> (document)

events -> (map)

Describe the Matter events with the Matter event identifier mapped to the event fields.

key -> (string)

value -> (document)

Shorthand Syntax:

id=string,clusters=[{id=string},{id=string}]

JSON Syntax:

{
  "id": "string",
  "clusters": [
    {
      "id": "string",
      "attributes": {...},
      "commands": {"string": {...}
        ...},
      "events": {"string": {...}
        ...}
    }
    ...
  ]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

Output

ConnectorId -> (string)

The id of the connector between the third-party cloud provider and IoT managed integrations.