CodeDeploy / Paginator / ListDeploymentInstances

ListDeploymentInstances

class CodeDeploy.Paginator.ListDeploymentInstances

paginator = client.get_paginator('list_deployment_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeDeploy.Client.list_deployment_instances().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    deploymentId='string',
    instanceStatusFilter=[
        'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
    ],
    instanceTypeFilter=[
        'Blue'|'Green',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• deploymentId (string) –

  [REQUIRED]

  The unique ID of a deployment.

• instanceStatusFilter (list) –

  A subset of instances to list by status:

  • Pending: Include those instances with pending deployments.

  • InProgress: Include those instances where deployments are still in progress.

  • Succeeded: Include those instances with successful deployments.

  • Failed: Include those instances with failed deployments.

  • Skipped: Include those instances with skipped deployments.

  • Unknown: Include those instances with deployments in an unknown state.

  • (string) –

• instanceTypeFilter (list) –

  The set of instances in a blue/green deployment, either those in the original environment (“BLUE”) or those in the replacement environment (“GREEN”), for which you want to view instance information.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'instancesList': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of a ListDeploymentInstances operation.

  • instancesList (list) –

    A list of instance IDs.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.