start-associations-once¶

Description¶

Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.

Synopsis¶

  start-associations-once
--association-ids <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--association-ids (list)

The association IDs that you want to run immediately and only one time.

(string)

Syntax:

"string" "string" ...

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To execute an association immediately and only one time

This example executes the specified association immediately and only once. There is no output if the command succeeds.

Command:

aws ssm start-associations-once --association-id "8dfe3659-4309-493a-8755-0123456789ab"

Output¶

None

Table of Contents

Feedback

User Guide