Greengrass / Paginator / ListDeployments

ListDeployments

class Greengrass.Paginator.ListDeployments

paginator = client.get_paginator('list_deployments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Greengrass.Client.list_deployments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GroupId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GroupId (string) – [REQUIRED] The ID of the Greengrass group.

• 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.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Deployments': [
        {
            'CreatedAt': 'string',
            'DeploymentArn': 'string',
            'DeploymentId': 'string',
            'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
            'GroupArn': 'string'
        },
    ],

}

Response Structure

• (dict) – Success. The response body contains the list of deployments for the given group.

  • Deployments (list) – A list of deployments for the requested groups.

    • (dict) – Information about a deployment.

      • CreatedAt (string) – The time, in milliseconds since the epoch, when the deployment was created.

      • DeploymentArn (string) – The ARN of the deployment.

      • DeploymentId (string) – The ID of the deployment.

      • DeploymentType (string) – The type of the deployment.

      • GroupArn (string) – The ARN of the group for this deployment.