AWS Documentation » AWS IoT Greengrass » API Reference » Greengrass API » Definitions » StartBulkDeploymentRequest

StartBulkDeploymentRequest

{
  "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 contained 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 containing the input file.

type: string

tags

The resource tags.

type: object

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