IoTSiteWise / Client / describe_application

describe_application¶

IoTSiteWise.Client.describe_application(**kwargs)¶

Retrieves Application details based on the ID

Request Syntax

response = client.describe_application(
    workspaceName='string',
    id='string'
)

Parameters:

workspaceName (string) –
[REQUIRED]

Name of the workspace to associate with the underlying Application
id (string) –
[REQUIRED]

ID of the Application

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'dnsSubdomain': 'string',
    'description': 'string',
    'id': 'string',
    'idcApplicationArn': 'string',
    'name': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING',
    'updatedAt': datetime(2015, 1, 1),
    'workspaceName': 'string'
}

Response Structure

(dict) –
- arn (string) –
  
  ARN of the application
- createdAt (datetime) –
  
  Timestamp when the application was created
- dnsSubdomain (string) –
  
  DNS subdomain for the application
- description (string) –
  
  Description of the application
- id (string) –
  
  Unique identifier of the application
- idcApplicationArn (string) –
  
  Identity Center Application ARN associated with this application
- name (string) –
  
  Name of the application
- status (string) –
  
  Current status of the application
- updatedAt (datetime) –
  
  Timestamp when the application was last updated
- workspaceName (string) –
  
  Name of the workspace this application belongs to

Exceptions

IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ThrottlingException
IoTSiteWise.Client.exceptions.ResourceNotFoundException