CodeDeploy / Client / list_deployment_targets

list_deployment_targets

CodeDeploy.Client.list_deployment_targets(**kwargs)

Returns an array of target IDs that are associated a deployment.

See also: AWS API Documentation

Request Syntax

response = client.list_deployment_targets(
    deploymentId='string',
    nextToken='string',
    targetFilters={
        'string': [
            'string',
        ]
    }
)

Parameters:

• deploymentId (string) –

  [REQUIRED]

  The unique ID of a deployment.

• nextToken (string) – A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.

• targetFilters (dict) –

  A key used to filter the returned targets. The two valid values are:

  • TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, Ready, Skipped, Succeeded, or Unknown.

  • ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or Green.

  • (string) –

    • (list) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'targetIds': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • targetIds (list) –

    The unique IDs of deployment targets.

    • (string) –

  • nextToken (string) –

    If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set of deployment targets in the list.

Exceptions

• CodeDeploy.Client.exceptions.DeploymentIdRequiredException

• CodeDeploy.Client.exceptions.DeploymentDoesNotExistException

• CodeDeploy.Client.exceptions.DeploymentNotStartedException

• CodeDeploy.Client.exceptions.InvalidNextTokenException

• CodeDeploy.Client.exceptions.InvalidDeploymentIdException

• CodeDeploy.Client.exceptions.InvalidInstanceStatusException

• CodeDeploy.Client.exceptions.InvalidInstanceTypeException

• CodeDeploy.Client.exceptions.InvalidDeploymentInstanceTypeException

• CodeDeploy.Client.exceptions.InvalidTargetFilterNameException