AWS Greengrass
API Reference

ListBulkDeployments

Returns a list of bulk deployments.

URI: GET /greengrass/bulk/deployments

Produces: application/json

CLI:

aws greengrass list-bulk-deployments \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "MaxResults": "integer", "NextToken": "string" }

Parameters:

MaxResults

The maximum number of results to be returned per request.

where used: query; required: false

type: integer

NextToken

The token for the next set of results, or null if there are no additional results.

where used: query; required: false

type: string

Responses:

200

Success. The response body contains the list of bulk deployments.

ListBulkDeploymentsResponse

{ "BulkDeployments": [ { "BulkDeploymentId": "string", "BulkDeploymentArn": "string", "CreatedAt": "string" } ], "NextToken": "string" }
ListBulkDeploymentsResponse

type: object

BulkDeployments

type: array

items: BulkDeployment

BulkDeployment

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

type: object

BulkDeploymentId

The ID of the bulk deployment.

type: string

BulkDeploymentArn

The ARN of the bulk deployment.

type: string

CreatedAt

The time, in ISO format, when the deployment was created.

type: string

NextToken

The token for the next set of results, or null if there are no additional results.

in: query

type: string

400

invalid request

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string