Greengrass / Client / list_bulk_deployments

list_bulk_deployments#

Greengrass.Client.list_bulk_deployments(**kwargs)#

Returns a list of bulk deployments.

See also: AWS API Documentation

Request Syntax

response = client.list_bulk_deployments(
    MaxResults='string',
    NextToken='string'
)
Parameters:

  • MaxResults (string) – The maximum number of results to be returned per request.

  • NextToken (string) – The token for the next set of results, or ‘’null’’ if there are no additional results.

Return type:

dict

Returns:

Response Syntax

{
    'BulkDeployments': [
        {
            'BulkDeploymentArn': 'string',
            'BulkDeploymentId': 'string',
            'CreatedAt': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) – The token for the next set of results, or ‘’null’’ if there are no additional results.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException