Greengrass / Client / start_bulk_deployment

start_bulk_deployment#

Greengrass.Client.start_bulk_deployment(**kwargs)#

Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be 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.

See also: AWS API Documentation

Request Syntax

response = client.start_bulk_deployment(
    AmznClientToken='string',
    ExecutionRoleArn='string',
    InputFileUri='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • AmznClientToken (string) – A client token used to correlate requests and responses.

  • ExecutionRoleArn (string) – [REQUIRED] 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.

  • InputFileUri (string) – [REQUIRED] 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.

  • tags (dict) –

    Tag(s) to add to the new resource.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'BulkDeploymentArn': 'string',
    'BulkDeploymentId': 'string'
}

Response Structure

  • (dict) – success

    • BulkDeploymentArn (string) – The ARN of the bulk deployment.

    • BulkDeploymentId (string) – The ID of the bulk deployment.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException