[ aws . iot-managed-integrations ]

create-ota-task-configuration

Description

Create a configuraiton for the over-the-air (OTA) task.

See also: AWS API Documentation

Synopsis

  create-ota-task-configuration
[--description <value>]
[--name <value>]
[--push-config <value>]
[--client-token <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

--description (string)

A description of the over-the-air (OTA) task configuration.

--name (string)

The name of the over-the-air (OTA) task.

--push-config (structure)

Describes the type of configuration used for the over-the-air (OTA) task.

AbortConfig -> (structure)

Structure representing one abort config.

AbortConfigCriteriaList -> (list)

The list of criteria for the abort config.

(structure)

Structure representing one abort config criteria.

Action -> (string)

The action taken by the abort configuration.

FailureType -> (string)

Over-the-air (OTA) task abort criteria failure type.

MinNumberOfExecutedThings -> (integer)

The minimum number of things that must receive task execution notifications before the task can be aborted.

ThresholdPercentage -> (double)

The minimum percentage of over-the-air (OTA) task execution failures that must occur to initiate the last abort.

RolloutConfig -> (structure)

Structure representing one rollout config.

ExponentialRolloutRate -> (structure)

Structure representing exponential rate of rollout for an over-the-air (OTA) task.

BaseRatePerMinute -> (integer)

The base rate per minute for the rollout of an over-the-air (OTA) task.

IncrementFactor -> (double)

The incremental factor for increasing the rollout rate of an over-the-air (OTA) task.

RateIncreaseCriteria -> (structure)

The criteria for increasing the rollout rate of an over-the-air (OTA) task.

numberOfNotifiedThings -> (integer)

The threshold for number of notified things that will initiate the increase in rate of rollout.

numberOfSucceededThings -> (integer)

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

MaximumPerMinute -> (integer)

The maximum number of things that will be notified of a pending task, per minute.

TimeoutConfig -> (structure)

Structure representing one timeout config.

InProgressTimeoutInMinutes -> (long)

Specifies the amount of time the device has to finish execution of this task. The timeout interval can be anywhere between 1 minute and 7 days.

JSON Syntax:

{
  "AbortConfig": {
    "AbortConfigCriteriaList": [
      {
        "Action": "CANCEL",
        "FailureType": "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL",
        "MinNumberOfExecutedThings": integer,
        "ThresholdPercentage": double
      }
      ...
    ]
  },
  "RolloutConfig": {
    "ExponentialRolloutRate": {
      "BaseRatePerMinute": integer,
      "IncrementFactor": double,
      "RateIncreaseCriteria": {
        "numberOfNotifiedThings": integer,
        "numberOfSucceededThings": integer
      }
    },
    "MaximumPerMinute": integer
  },
  "TimeoutConfig": {
    "InProgressTimeoutInMinutes": long
  }
}

--client-token (string)

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

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

TaskConfigurationId -> (string)

The identifier of the over-the-air (OTA) task configuration.