CodeDeploy / Client / list_deployment_groups

list_deployment_groups

CodeDeploy.Client.list_deployment_groups(**kwargs)

Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_deployment_groups(
    applicationName='string',
    nextToken='string'
)

Parameters:

• applicationName (string) –

  [REQUIRED]

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

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

Return type:

dict

Returns:

Response Syntax

{
    'applicationName': 'string',
    'deploymentGroups': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of a ListDeploymentGroups operation.

  • applicationName (string) –

    The application name.

  • deploymentGroups (list) –

    A list of deployment group names.

    • (string) –

  • nextToken (string) –

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

Exceptions

• CodeDeploy.Client.exceptions.ApplicationNameRequiredException

• CodeDeploy.Client.exceptions.InvalidApplicationNameException

• CodeDeploy.Client.exceptions.ApplicationDoesNotExistException

• CodeDeploy.Client.exceptions.InvalidNextTokenException