libZSservicesZSamazonka-greengrassZSamazonka-greengrass
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data StartBulkDeployment Source #

See: newStartBulkDeployment smart constructor.

Constructors

StartBulkDeployment' 

Fields

  • amznClientToken :: Maybe Text

    A client token used to correlate requests and responses.

  • tags :: Maybe (HashMap Text Text)

    Tag(s) to add to the new resource.

  • executionRoleArn :: Text

    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 :: Text

    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.

Instances

Instances details
Eq StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Read StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Show StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Generic StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Associated Types

type Rep StartBulkDeployment :: Type -> Type #

NFData StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Methods

rnf :: StartBulkDeployment -> () #

Hashable StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

ToJSON StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

AWSRequest StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Associated Types

type AWSResponse StartBulkDeployment #

ToHeaders StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

ToPath StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

ToQuery StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

type Rep StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

type Rep StartBulkDeployment = D1 ('MetaData "StartBulkDeployment" "Amazonka.Greengrass.StartBulkDeployment" "libZSservicesZSamazonka-greengrassZSamazonka-greengrass" 'False) (C1 ('MetaCons "StartBulkDeployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "amznClientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "inputFileUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartBulkDeployment Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

newStartBulkDeployment Source #

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_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

Instances details
Eq StartBulkDeploymentResponse Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Read StartBulkDeploymentResponse Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Show StartBulkDeploymentResponse Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Generic StartBulkDeploymentResponse Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

Associated Types

type Rep StartBulkDeploymentResponse :: Type -> Type #

NFData StartBulkDeploymentResponse Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

type Rep StartBulkDeploymentResponse Source # 
Instance details

Defined in Amazonka.Greengrass.StartBulkDeployment

type Rep StartBulkDeploymentResponse = D1 ('MetaData "StartBulkDeploymentResponse" "Amazonka.Greengrass.StartBulkDeployment" "libZSservicesZSamazonka-greengrassZSamazonka-greengrass" 'False) (C1 ('MetaCons "StartBulkDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bulkDeploymentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "bulkDeploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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