Greengrass / Paginator / ListBulkDeployments

ListBulkDeployments#

class Greengrass.Paginator.ListBulkDeployments#
paginator = client.get_paginator('list_bulk_deployments')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

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

{
    'BulkDeployments': [
        {
            'BulkDeploymentArn': 'string',
            'BulkDeploymentId': 'string',
            'CreatedAt': 'string'
        },
    ],

}

Response Structure

  • (dict) – Success. The response body contains the list of bulk deployments.

    • BulkDeployments (list) – A list of bulk deployments.

      • (dict) – Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.

        • BulkDeploymentArn (string) – The ARN of the bulk deployment.

        • BulkDeploymentId (string) – The ID of the bulk deployment.

        • CreatedAt (string) – The time, in ISO format, when the deployment was created.