portal-active¶

Description¶

Wait until JMESPath query portalStatus.state returns ACTIVE when polling with describe-portal. It will poll every 3 seconds until a successful state has been reached. This will exit with a return code of 255 after 20 failed checks.

Synopsis¶

  portal-active
--portal-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--portal-id (string)

The ID of the portal.

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

See ‘aws help’ for descriptions of global parameters.

Examples¶

To wait for a portal to be active

The following wait portal-active example pauses and resumes only after it can confirm that the specified portal is active.

aws iotsitewise wait portal-active \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE

This command produces no output.

For more information, see Administering your portals in the AWS IoT SiteWise User Guide.

Output¶

None

Table of Contents

Feedback

User Guide