CodeDeploy / Paginator / ListDeploymentGroups

ListDeploymentGroups#

class CodeDeploy.Paginator.ListDeploymentGroups#
paginator = client.get_paginator('list_deployment_groups')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • applicationName (string) –

    [REQUIRED]

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

  • 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

{
    '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) –

      A token to resume pagination.