ApplicationInsights / Client / describe_workload

describe_workload#

ApplicationInsights.Client.describe_workload(**kwargs)#

Describes a workload and its configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_workload(
    ResourceGroupName='string',
    ComponentName='string',
    WorkloadId='string',
    AccountId='string'
)
Parameters:

  • ResourceGroupName (string) –

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) –

    [REQUIRED]

    The name of the component.

  • WorkloadId (string) –

    [REQUIRED]

    The ID of the workload.

  • AccountId (string) – The AWS account ID for the workload owner.

Return type:

dict

Returns:

Response Syntax

{
    'WorkloadId': 'string',
    'WorkloadRemarks': 'string',
    'WorkloadConfiguration': {
        'WorkloadName': 'string',
        'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
        'Configuration': 'string'
    }
}

Response Structure

  • (dict) –

    • WorkloadId (string) –

      The ID of the workload.

    • WorkloadRemarks (string) –

      If logging is supported for the resource type, shows whether the component has configured logs to be monitored.

    • WorkloadConfiguration (dict) –

      The configuration settings of the workload. The value is the escaped JSON of the configuration.

      • WorkloadName (string) –

        The name of the workload.

      • Tier (string) –

        The configuration of the workload tier.

      • Configuration (string) –

        The configuration settings of the workload.

Exceptions

  • ApplicationInsights.Client.exceptions.ResourceNotFoundException

  • ApplicationInsights.Client.exceptions.ValidationException

  • ApplicationInsights.Client.exceptions.InternalServerException