| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Greengrass.StartBulkDeployment
Description
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.
Synopsis
- data StartBulkDeployment = StartBulkDeployment' {
- amznClientToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- executionRoleArn :: Text
- inputFileUri :: Text
- newStartBulkDeployment :: Text -> Text -> StartBulkDeployment
- startBulkDeployment_amznClientToken :: Lens' StartBulkDeployment (Maybe Text)
- startBulkDeployment_tags :: Lens' StartBulkDeployment (Maybe (HashMap Text Text))
- startBulkDeployment_executionRoleArn :: Lens' StartBulkDeployment Text
- startBulkDeployment_inputFileUri :: Lens' StartBulkDeployment Text
- data StartBulkDeploymentResponse = StartBulkDeploymentResponse' {}
- newStartBulkDeploymentResponse :: Int -> StartBulkDeploymentResponse
- startBulkDeploymentResponse_bulkDeploymentArn :: Lens' StartBulkDeploymentResponse (Maybe Text)
- startBulkDeploymentResponse_bulkDeploymentId :: Lens' StartBulkDeploymentResponse (Maybe Text)
- startBulkDeploymentResponse_httpStatus :: Lens' StartBulkDeploymentResponse Int
Creating a Request
data StartBulkDeployment Source #
See: newStartBulkDeployment smart constructor.
Constructors
| StartBulkDeployment' | |
Fields
| |
Instances
newStartBulkDeployment Source #
Arguments
| :: Text | |
| -> Text | |
| -> StartBulkDeployment |
Create a value of StartBulkDeployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amznClientToken:StartBulkDeployment', startBulkDeployment_amznClientToken - A client token used to correlate requests and responses.
$sel:tags:StartBulkDeployment', startBulkDeployment_tags - Tag(s) to add to the new resource.
$sel:executionRoleArn:StartBulkDeployment', startBulkDeployment_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.
$sel:inputFileUri:StartBulkDeployment', startBulkDeployment_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.
Request Lenses
startBulkDeployment_amznClientToken :: Lens' StartBulkDeployment (Maybe Text) Source #
A client token used to correlate requests and responses.
startBulkDeployment_tags :: Lens' StartBulkDeployment (Maybe (HashMap Text Text)) Source #
Tag(s) to add to the new resource.
startBulkDeployment_executionRoleArn :: Lens' StartBulkDeployment Text Source #
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.
startBulkDeployment_inputFileUri :: Lens' StartBulkDeployment Text Source #
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.
Destructuring the Response
data StartBulkDeploymentResponse Source #
See: newStartBulkDeploymentResponse smart constructor.
Constructors
| StartBulkDeploymentResponse' | |
Fields
| |
Instances
newStartBulkDeploymentResponse Source #
Create a value of StartBulkDeploymentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bulkDeploymentArn:StartBulkDeploymentResponse', startBulkDeploymentResponse_bulkDeploymentArn - The ARN of the bulk deployment.
$sel:bulkDeploymentId:StartBulkDeploymentResponse', startBulkDeploymentResponse_bulkDeploymentId - The ID of the bulk deployment.
$sel:httpStatus:StartBulkDeploymentResponse', startBulkDeploymentResponse_httpStatus - The response's http status code.
Response Lenses
startBulkDeploymentResponse_bulkDeploymentArn :: Lens' StartBulkDeploymentResponse (Maybe Text) Source #
The ARN of the bulk deployment.
startBulkDeploymentResponse_bulkDeploymentId :: Lens' StartBulkDeploymentResponse (Maybe Text) Source #
The ID of the bulk deployment.
startBulkDeploymentResponse_httpStatus :: Lens' StartBulkDeploymentResponse Int Source #
The response's http status code.