/greengrass/bulk/deployments - AWS Greengrass

/greengrass/bulk/deployments

POST

POST /greengrass/bulk/deployments

Operation ID: StartBulkDeployment

Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment is triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an X-Amzn-Client-Token token in every StartBulkDeployment request. These requests are idempotent with respect to the token and the request parameters.

Produces: application/json

Body Parameters

StartBulkDeploymentRequestBody

where used: body; required: true

{ "InputFileUri": "string", "ExecutionRoleArn": "string", "tags": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" } }
StartBulkDeploymentRequest

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

required: ["InputFileUri", "ExecutionRoleArn"]

InputFileUri

The URI of the input file in the S3 bucket. The execution role must have getObject permissions on this bucket to access the input file. The input file is a JSON-serialized, line-delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only NewDeployment deployment types.

{"GroupId":"groupId1", "GroupVersionId":"groupVersionId1", "DeploymentType":"NewDeployment"} {"GroupId":"groupId2", "GroupVersionId":"groupVersionId2", "DeploymentType":"NewDeployment"} {"GroupId":"groupId3", "GroupVersionId":"groupVersionId3", "DeploymentType":"NewDeployment"} ...

For more information, including the input file format, see Create Bulk Deployments For Groups.

type: string

ExecutionRoleArn

The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the greengrass:CreateDeployment action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket that contains the input file.

type: string

tags

The resource tags.

type: object

additionalProperties: The key-value pair for the resource tag. Type: string

Header Parameters

X-Amzn-Client-Token

A client token used to correlate requests and responses.

where used: header; required: false

type: string

CLI

aws greengrass start-bulk-deployment \ [--input-file-uri <value>] \ [--execution-role-arn <value>] \ [--tags <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "InputFileUri": "string", "ExecutionRoleArn": "string", "tags": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "AmznClientToken": "string" }

Responses

200

Success.

StartBulkDeploymentResponse

{ "BulkDeploymentId": "string", "BulkDeploymentArn": "string" }
StartBulkDeploymentResponse

type: object

BulkDeploymentId

The ID of the bulk deployment.

type: string

BulkDeploymentArn

The ARN of the bulk deployment.

type: string

400

Invalid request.

GeneralError

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

General error information.

type: object

required: ["Message"]

Message

A message that contains 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

GET

GET /greengrass/bulk/deployments

Operation ID: ListBulkDeployments

Returns a list of bulk deployments.

Produces: application/json

Query 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 more results.

where used: query; required: false

type: string

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" }

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 more 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 that contains 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