Greengrass / Paginator / ListBulkDeploymentDetailedReports


class Greengrass.Paginator.ListBulkDeploymentDetailedReports#
paginator = client.get_paginator('list_bulk_deployment_detailed_reports')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • BulkDeploymentId (string) – [REQUIRED] The ID of the bulk deployment.

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



Response Syntax

    'Deployments': [
            'CreatedAt': 'string',
            'DeploymentArn': 'string',
            'DeploymentId': 'string',
            'DeploymentStatus': 'string',
            'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
            'ErrorDetails': [
                    'DetailedErrorCode': 'string',
                    'DetailedErrorMessage': 'string'
            'ErrorMessage': 'string',
            'GroupArn': 'string'


Response Structure

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

    • Deployments (list) – A list of the individual group deployments in the bulk deployment operation.

      • (dict) – Information about an individual group deployment in a bulk deployment operation.

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

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

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

        • DeploymentStatus (string) – The current status of the group deployment: ‘’InProgress’’, ‘’Building’’, ‘’Success’’, or ‘’Failure’’.

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

        • ErrorDetails (list) – Details about the error.

          • (dict) – Details about the error.

            • DetailedErrorCode (string) – A detailed error code.

            • DetailedErrorMessage (string) – A detailed error message.

        • ErrorMessage (string) – The error message for a failed deployment

        • GroupArn (string) – The ARN of the Greengrass group.