LaunchWizard / Client / list_workload_deployment_patterns

list_workload_deployment_patterns#

LaunchWizard.Client.list_workload_deployment_patterns(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_workload_deployment_patterns(
    maxResults=123,
    nextToken='string',
    workloadName='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.

  • workloadName (string) –

    [REQUIRED]

    The name of the workload.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'workloadDeploymentPatterns': [
        {
            'deploymentPatternName': 'string',
            'description': 'string',
            'displayName': 'string',
            'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
            'statusMessage': 'string',
            'workloadName': 'string',
            'workloadVersionName': '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.

    • workloadDeploymentPatterns (list) –

      Describes the workload deployment patterns.

      • (dict) –

        Describes a workload deployment pattern.

        • deploymentPatternName (string) –

          The name of a workload deployment pattern.

        • description (string) –

          The description of a workload deployment pattern.

        • displayName (string) –

          The display name of a workload deployment pattern.

        • status (string) –

          The status of a workload deployment pattern.

        • statusMessage (string) –

          A message about a workload deployment pattern’s status.

        • workloadName (string) –

          The name of the workload.

        • workloadVersionName (string) –

          The name of the workload deployment pattern version.

Exceptions

  • LaunchWizard.Client.exceptions.InternalServerException

  • LaunchWizard.Client.exceptions.ValidationException

  • LaunchWizard.Client.exceptions.ResourceNotFoundException