IoTFleetHub / Client / describe_application

describe_application#

IoTFleetHub.Client.describe_application(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_application(
    applicationId='string'
)
Parameters:

applicationId (string) –

[REQUIRED]

The unique Id of the web application.

Return type:

dict

Returns:

Response Syntax

{
    'applicationId': 'string',
    'applicationArn': 'string',
    'applicationName': 'string',
    'applicationDescription': 'string',
    'applicationUrl': 'string',
    'applicationState': 'CREATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'DELETE_FAILED',
    'applicationCreationDate': 123,
    'applicationLastUpdateDate': 123,
    'roleArn': 'string',
    'ssoClientId': 'string',
    'errorMessage': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • 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 (integer) –

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

    • applicationLastUpdateDate (integer) –

      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 Amazon Web Services 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 that explains any failures included in the applicationState response field. This message explains failures in the CreateApplication and DeleteApplication actions.

    • tags (dict) –

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

      • (string) –

        • (string) –

Exceptions