LaunchWizard / Client / list_workloads

list_workloads¶

LaunchWizard.Client.list_workloads(**kwargs)¶

Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

Request Syntax

response = client.list_workloads(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
nextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'workloads': [
        {
            'displayName': 'string',
            'workloadName': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token to include in another request to get the next page of items. This value is null when there are no more items to return.
- workloads (list) –
  
  Information about the workloads.
  - (dict) –
    
    Describes workload data.
    - displayName (string) –
      
      The display name of the workload data.
    - workloadName (string) –
      
      The name of the workload.

Exceptions

LaunchWizard.Client.exceptions.InternalServerException
LaunchWizard.Client.exceptions.ValidationException