LaunchWizard / Client / get_workload

get_workload#

LaunchWizard.Client.get_workload(**kwargs)#

Returns information about a workload.

See also: AWS API Documentation

Request Syntax

response = client.get_workload(
    workloadName='string'
)
Parameters:

workloadName (string) –

[REQUIRED]

The name of the workload.

Return type:

dict

Returns:

Response Syntax

{
    'workload': {
        'description': 'string',
        'displayName': 'string',
        'documentationUrl': 'string',
        'iconUrl': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
        'statusMessage': 'string',
        'workloadName': 'string'
    }
}

Response Structure

  • (dict) –

    • workload (dict) –

      Information about the workload.

      • description (string) –

        The description of a workload.

      • displayName (string) –

        The display name of a workload.

      • documentationUrl (string) –

        The URL of a workload document.

      • iconUrl (string) –

        The URL of a workload icon.

      • status (string) –

        The status of a workload.

      • statusMessage (string) –

        The message about a workload’s status.

      • workloadName (string) –

        The name of the workload.

Exceptions

  • LaunchWizard.Client.exceptions.InternalServerException

  • LaunchWizard.Client.exceptions.ValidationException

  • LaunchWizard.Client.exceptions.ResourceNotFoundException