ApplicationInsights / Client / list_workloads

list_workloads#

ApplicationInsights.Client.list_workloads(**kwargs)#

Lists the workloads that are configured on a given component.

See also: AWS API Documentation

Request Syntax

response = client.list_workloads(
    ResourceGroupName='string',
    ComponentName='string',
    MaxResults=123,
    NextToken='string',
    AccountId='string'
)
Parameters:

  • ResourceGroupName (string) –

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) –

    [REQUIRED]

    The name of the component.

  • MaxResults (integer) – The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

  • NextToken (string) – The token to request the next page of results.

  • AccountId (string) – The Amazon Web Services account ID of the owner of the workload.

Return type:

dict

Returns:

Response Syntax

{
    'WorkloadList': [
        {
            'WorkloadId': 'string',
            'ComponentName': 'string',
            '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'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
            'WorkloadRemarks': 'string',
            'MissingWorkloadConfig': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • WorkloadList (list) –

      The list of workloads.

      • (dict) –

        Describes the workloads on a component.

        • WorkloadId (string) –

          The ID of the workload.

        • ComponentName (string) –

          The name of the component.

        • WorkloadName (string) –

          The name of the workload.

        • Tier (string) –

          The tier of the workload.

        • WorkloadRemarks (string) –

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

        • MissingWorkloadConfig (boolean) –

          Indicates whether all of the component configurations required to monitor a workload were provided.

    • NextToken (string) –

      The token to request the next page of results.

Exceptions

  • ApplicationInsights.Client.exceptions.ResourceNotFoundException

  • ApplicationInsights.Client.exceptions.ValidationException

  • ApplicationInsights.Client.exceptions.InternalServerException