IoTFleetHub / Client / describe_application

describe_application

IoTFleetHub.Client.describe_application(**kwargs)

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

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 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 (dict) –

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

    • (string) –

      • (string) –

Exceptions

• IoTFleetHub.Client.exceptions.InvalidRequestException

• IoTFleetHub.Client.exceptions.ResourceNotFoundException

• IoTFleetHub.Client.exceptions.InternalFailureException

• IoTFleetHub.Client.exceptions.ThrottlingException