LaunchWizard / Client / list_deployments

list_deployments#

LaunchWizard.Client.list_deployments(**kwargs)#

Lists the deployments that have been created.

See also: AWS API Documentation

Request Syntax

response = client.list_deployments(
    filters=[
        {
            'name': 'WORKLOAD_NAME'|'DEPLOYMENT_STATUS',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)
Parameters:

  • filters (list) –

    Filters to scope the results. The following filters are supported:

    • WORKLOAD_NAME - The name used in deployments.

    • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

    • (dict) –

      A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.

      • name (string) –

        The name of the filter. Filter names are case-sensitive.

      • values (list) –

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

        • (string) –

  • 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

{
    'deployments': [
        {
            'createdAt': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'patternName': 'string',
            'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING',
            'workloadName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • deployments (list) –

      Lists the deployments.

      • (dict) –

        A summary of the deployment data.

        • createdAt (datetime) –

          The time the deployment was created.

        • id (string) –

          The ID of the deployment.

        • name (string) –

          The name of the deployment

        • patternName (string) –

          The name of the workload deployment pattern.

        • status (string) –

          The status of the deployment.

        • workloadName (string) –

          The name of the workload.

    • 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.

Exceptions

  • LaunchWizard.Client.exceptions.InternalServerException

  • LaunchWizard.Client.exceptions.ValidationException