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

get-detector-model-analysis-results

Description

Retrieves one or more analysis results of the detector model.

Note

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

See also: AWS API Documentation

Synopsis

  get-detector-model-analysis-results
--analysis-id <value>
[--next-token <value>]
[--max-results <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

--analysis-id (string)

The ID of the analysis result that you want to retrieve.

--next-token (string)

The token that you can use to return the next set of results.

--max-results (integer)

The maximum number of results to be returned per request.

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

analysisResults -> (list)

Contains information about one or more analysis results.

(structure)

Contains the result of the analysis.

type -> (string)

The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:

  • supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.
  • service-limits - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.
  • structure - The detector model must follow a structure that AWS IoT Events supports.
  • expression-syntax - Your expression must follow the required syntax.
  • data-type - Data types referenced in the detector model must be compatible.
  • referenced-data - You must define the data referenced in your detector model before you can use the data.
  • referenced-resource - Resources that the detector model uses must be available.

For more information, see Running detector model analyses in the AWS IoT Events Developer Guide .

level -> (string)

The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:

  • INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.
  • WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.
  • ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.

message -> (string)

Contains additional information about the analysis result.

locations -> (list)

Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

(structure)

Contains information that you can use to locate the field in your detector model that the analysis result references.

path -> (string)

A JsonPath expression that identifies the error field in your detector model.

nextToken -> (string)

The token that you can use to return the next set of results, or null if there are no more results.