Skip to content

ListDeploymentsInput

Source code in docs_src/capo_codedeploy/types/list_deployments_input.py
class ListDeploymentsInput(TypedDict, closed=True):
    application_name: NotRequired[
        "capo_codedeploy.types.application_name.ApplicationName"
    ]
    """<p>The name of an CodeDeploy application associated with the user or Amazon Web Services account.</p> <note> <p>If <code>applicationName</code> is specified, then <code>deploymentGroupName</code> must be specified. If it is not specified, then <code>deploymentGroupName</code> must not be specified. </p> </note>"""
    deployment_group_name: NotRequired[
        "capo_codedeploy.types.deployment_group_name.DeploymentGroupName"
    ]
    """<p>The name of a deployment group for the specified application.</p> <note> <p>If <code>deploymentGroupName</code> is specified, then <code>applicationName</code> must be specified. If it is not specified, then <code>applicationName</code> must not be specified. </p> </note>"""
    external_id: NotRequired["capo_codedeploy.types.external_id.ExternalId"]
    """<p>The unique ID of an external resource for returning deployments linked to the external resource.</p>"""
    include_only_statuses: NotRequired[
        "capo_codedeploy.types.deployment_status_list.DeploymentStatusList"
    ]
    """<p>A subset of deployments to list by status:</p> <ul> <li> <p> <code>Created</code>: Include created deployments in the resulting list.</p> </li> <li> <p> <code>Queued</code>: Include queued deployments in the resulting list.</p> </li> <li> <p> <code>In Progress</code>: Include in-progress deployments in the resulting list.</p> </li> <li> <p> <code>Succeeded</code>: Include successful deployments in the resulting list.</p> </li> <li> <p> <code>Failed</code>: Include failed deployments in the resulting list.</p> </li> <li> <p> <code>Stopped</code>: Include stopped deployments in the resulting list.</p> </li> </ul>"""
    create_time_range: NotRequired["capo_codedeploy.types.time_range.TimeRange"]
    """<p>A time range (start and end) for returning a subset of the list of deployments.</p>"""
    next_token: NotRequired["capo_codedeploy.types.next_token.NextToken"]
    """<p>An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.</p>"""

application_name instance-attribute

application_name: NotRequired[ApplicationName]

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

create_time_range instance-attribute

create_time_range: NotRequired[TimeRange]

A time range (start and end) for returning a subset of the list of deployments.

deployment_group_name instance-attribute

deployment_group_name: NotRequired[DeploymentGroupName]

The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

external_id instance-attribute

external_id: NotRequired[ExternalId]

The unique ID of an external resource for returning deployments linked to the external resource.

include_only_statuses instance-attribute

include_only_statuses: NotRequired[DeploymentStatusList]

A subset of deployments to list by status:

  • Created: Include created deployments in the resulting list.

  • Queued: Include queued deployments in the resulting list.

  • In Progress: Include in-progress deployments in the resulting list.

  • Succeeded: Include successful deployments in the resulting list.

  • Failed: Include failed deployments in the resulting list.

  • Stopped: Include stopped deployments in the resulting list.

next_token instance-attribute

next_token: NotRequired[NextToken]

An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.