[ aws . iotfleethub ]

describe-application

Description

Gets information about a Fleet Hub for AWS IoT Device Management web application.

Note

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-application
--application-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The unique Id of the web application.

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

Output

applicationId -> (string)

The unique Id of the web application.

applicationArn -> (string)

The ARN of the web application.

applicationName -> (string)

The name of the web application.

applicationDescription -> (string)

An optional description of the web application.

applicationUrl -> (string)

The URL of the web application.

applicationState -> (string)

The current state of the web application.

applicationCreationDate -> (long)

The date (in Unix epoch time) when the application was created.

applicationLastUpdateDate -> (long)

The date (in Unix epoch time) when the application was last updated.

roleArn -> (string)

The ARN of the role that the web application assumes when it interacts with AWS IoT Core.

ssoClientId -> (string)

The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

errorMessage -> (string)

A message indicating why the DescribeApplication API failed.

tags -> (map)

A set of key/value pairs that you can use to manage the web application resource.

key -> (string)

value -> (string)