« blib/lib/Paws/S3Control/CreateBucketResult.pm
↑ Summary
blib/lib/Paws/S3Control/CreateJobResult.pm »
| 1 | |||
| 2 | package Paws::S3Control::CreateJob; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', header_name => 'x-amz-account-id', traits => ['ParamInHeader'], required => 1); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ConfirmationRequired => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str'); | ||
| 8 | has Manifest => (is => 'ro', isa => 'Paws::S3Control::JobManifest', required => 1); | ||
| 9 | has Operation => (is => 'ro', isa => 'Paws::S3Control::JobOperation', required => 1); | ||
| 10 | has Priority => (is => 'ro', isa => 'Int', required => 1); | ||
| 11 | has Report => (is => 'ro', isa => 'Paws::S3Control::JobReport', required => 1); | ||
| 12 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::S3Control::S3Tag]'); | ||
| 14 | |||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateJob'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20180820/jobs'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3Control::CreateJobResult'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 23 | class_has _top_level_element => (isa => 'Str', is => 'ro', default => 'CreateJobRequest'); | ||
| 24 | class_has _top_level_namespace => (isa => 'Str', is => 'ro', default => 'http://awss3control.amazonaws.com/doc/2018-08-20/'); | ||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::S3Control::CreateJob - Arguments for method CreateJob on L<Paws::S3Control> | ||
| 32 | |||
| 33 | =head1 DESCRIPTION | ||
| 34 | |||
| 35 | This class represents the parameters used for calling the method CreateJob on the | ||
| 36 | L<AWS S3 Control|Paws::S3Control> service. Use the attributes of this class | ||
| 37 | as arguments to method CreateJob. | ||
| 38 | |||
| 39 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateJob. | ||
| 40 | |||
| 41 | =head1 SYNOPSIS | ||
| 42 | |||
| 43 | my $s3-control = Paws->service('S3Control'); | ||
| 44 | my $CreateJobResult = $s3 -control->CreateJob( | ||
| 45 | AccountId => 'MyAccountId', | ||
| 46 | ClientRequestToken => 'MyNonEmptyMaxLength64String', | ||
| 47 | Manifest => { | ||
| 48 | Location => { | ||
| 49 | ETag => 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 50 | ObjectArn => 'MyS3KeyArnString', # min: 1, max: 2000 | ||
| 51 | ObjectVersionId => | ||
| 52 | 'MyS3ObjectVersionId', # min: 1, max: 2000; OPTIONAL | ||
| 53 | }, | ||
| 54 | Spec => { | ||
| 55 | Format => 'S3BatchOperations_CSV_20180820' | ||
| 56 | , # values: S3BatchOperations_CSV_20180820, S3InventoryReport_CSV_20161130 | ||
| 57 | Fields => [ | ||
| 58 | 'Ignore', ... # values: Ignore, Bucket, Key, VersionId | ||
| 59 | ], # OPTIONAL | ||
| 60 | }, | ||
| 61 | |||
| 62 | }, | ||
| 63 | Operation => { | ||
| 64 | LambdaInvoke => { | ||
| 65 | FunctionArn => 'MyFunctionArnString', # min: 1, max: 1024; OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | S3DeleteObjectTagging => { | ||
| 68 | |||
| 69 | }, # OPTIONAL | ||
| 70 | S3InitiateRestoreObject => { | ||
| 71 | ExpirationInDays => 1, # OPTIONAL | ||
| 72 | GlacierJobTier => 'BULK', # values: BULK, STANDARD; OPTIONAL | ||
| 73 | }, # OPTIONAL | ||
| 74 | S3PutObjectAcl => { | ||
| 75 | AccessControlPolicy => { | ||
| 76 | AccessControlList => { | ||
| 77 | Owner => { | ||
| 78 | DisplayName => | ||
| 79 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 80 | ID => 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 81 | }, | ||
| 82 | Grants => [ | ||
| 83 | { | ||
| 84 | Grantee => { | ||
| 85 | DisplayName => | ||
| 86 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 87 | Identifier => | ||
| 88 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 89 | TypeIdentifier => | ||
| 90 | 'id', # values: id, emailAddress, uri; OPTIONAL | ||
| 91 | }, # OPTIONAL | ||
| 92 | Permission => 'FULL_CONTROL' | ||
| 93 | , # values: FULL_CONTROL, READ, WRITE, READ_ACP, WRITE_ACP; OPTIONAL | ||
| 94 | }, | ||
| 95 | ... | ||
| 96 | ], # OPTIONAL | ||
| 97 | }, # OPTIONAL | ||
| 98 | CannedAccessControlList => 'private' | ||
| 99 | , # values: private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control; OPTIONAL | ||
| 100 | }, # OPTIONAL | ||
| 101 | }, # OPTIONAL | ||
| 102 | S3PutObjectCopy => { | ||
| 103 | AccessControlGrants => [ | ||
| 104 | { | ||
| 105 | Grantee => { | ||
| 106 | DisplayName => | ||
| 107 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 108 | Identifier => | ||
| 109 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 110 | TypeIdentifier => | ||
| 111 | 'id', # values: id, emailAddress, uri; OPTIONAL | ||
| 112 | }, # OPTIONAL | ||
| 113 | Permission => 'FULL_CONTROL' | ||
| 114 | , # values: FULL_CONTROL, READ, WRITE, READ_ACP, WRITE_ACP; OPTIONAL | ||
| 115 | }, | ||
| 116 | ... | ||
| 117 | ], # OPTIONAL | ||
| 118 | BucketKeyEnabled => 1, # OPTIONAL | ||
| 119 | CannedAccessControlList => 'private' | ||
| 120 | , # values: private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control; OPTIONAL | ||
| 121 | MetadataDirective => 'COPY', # values: COPY, REPLACE; OPTIONAL | ||
| 122 | ModifiedSinceConstraint => '1970-01-01T01:00:00', # OPTIONAL | ||
| 123 | NewObjectMetadata => { | ||
| 124 | CacheControl => 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 125 | ContentDisposition => | ||
| 126 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 127 | ContentEncoding => | ||
| 128 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 129 | ContentLanguage => | ||
| 130 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 131 | ContentLength => 1, # OPTIONAL | ||
| 132 | ContentMD5 => 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 133 | ContentType => 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 134 | HttpExpiresDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 135 | RequesterCharged => 1, # OPTIONAL | ||
| 136 | SSEAlgorithm => 'AES256', # values: AES256, KMS; OPTIONAL | ||
| 137 | UserMetadata => { | ||
| 138 | 'MyNonEmptyMaxLength1024String' => 'MyMaxLength1024String' | ||
| 139 | , # key: min: 1, max: 1024, value: max: 1024 | ||
| 140 | }, # max: 8192; OPTIONAL | ||
| 141 | }, # OPTIONAL | ||
| 142 | NewObjectTagging => [ | ||
| 143 | { | ||
| 144 | Key => 'MyTagKeyString', # min: 1, max: 1024 | ||
| 145 | Value => 'MyTagValueString', # max: 1024 | ||
| 146 | |||
| 147 | }, | ||
| 148 | ... | ||
| 149 | ], # OPTIONAL | ||
| 150 | ObjectLockLegalHoldStatus => 'OFF', # values: OFF, ON; OPTIONAL | ||
| 151 | ObjectLockMode => | ||
| 152 | 'COMPLIANCE', # values: COMPLIANCE, GOVERNANCE; OPTIONAL | ||
| 153 | ObjectLockRetainUntilDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 154 | RedirectLocation => | ||
| 155 | 'MyNonEmptyMaxLength2048String', # min: 1, max: 2048; OPTIONAL | ||
| 156 | RequesterPays => 1, # OPTIONAL | ||
| 157 | SSEAwsKmsKeyId => 'MyKmsKeyArnString', # min: 1, max: 2000; OPTIONAL | ||
| 158 | StorageClass => 'STANDARD' | ||
| 159 | , # values: STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE; OPTIONAL | ||
| 160 | TargetKeyPrefix => | ||
| 161 | 'MyNonEmptyMaxLength1024String', # min: 1, max: 1024 | ||
| 162 | TargetResource => 'MyS3BucketArnString', # min: 1, max: 128; OPTIONAL | ||
| 163 | UnModifiedSinceConstraint => '1970-01-01T01:00:00', # OPTIONAL | ||
| 164 | }, # OPTIONAL | ||
| 165 | S3PutObjectLegalHold => { | ||
| 166 | LegalHold => { | ||
| 167 | Status => 'OFF', # values: OFF, ON; OPTIONAL | ||
| 168 | |||
| 169 | }, | ||
| 170 | |||
| 171 | }, # OPTIONAL | ||
| 172 | S3PutObjectRetention => { | ||
| 173 | Retention => { | ||
| 174 | Mode => 'COMPLIANCE', # values: COMPLIANCE, GOVERNANCE; OPTIONAL | ||
| 175 | RetainUntilDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 176 | }, | ||
| 177 | BypassGovernanceRetention => 1, # OPTIONAL | ||
| 178 | }, # OPTIONAL | ||
| 179 | S3PutObjectTagging => { | ||
| 180 | TagSet => [ | ||
| 181 | { | ||
| 182 | Key => 'MyTagKeyString', # min: 1, max: 1024 | ||
| 183 | Value => 'MyTagValueString', # max: 1024 | ||
| 184 | |||
| 185 | }, | ||
| 186 | ... | ||
| 187 | ], # OPTIONAL | ||
| 188 | }, # OPTIONAL | ||
| 189 | }, | ||
| 190 | Priority => 1, | ||
| 191 | Report => { | ||
| 192 | Enabled => 1, # OPTIONAL | ||
| 193 | Bucket => 'MyS3BucketArnString', # min: 1, max: 128; OPTIONAL | ||
| 194 | Format => 'Report_CSV_20180820', # values: Report_CSV_20180820; OPTIONAL | ||
| 195 | Prefix => 'MyReportPrefixString', # min: 1, max: 512; OPTIONAL | ||
| 196 | ReportScope => 'AllTasks', # values: AllTasks, FailedTasksOnly; OPTIONAL | ||
| 197 | }, | ||
| 198 | RoleArn => 'MyIAMRoleArn', | ||
| 199 | ConfirmationRequired => 1, # OPTIONAL | ||
| 200 | Description => 'MyNonEmptyMaxLength256String', # OPTIONAL | ||
| 201 | Tags => [ | ||
| 202 | { | ||
| 203 | Key => 'MyTagKeyString', # min: 1, max: 1024 | ||
| 204 | Value => 'MyTagValueString', # max: 1024 | ||
| 205 | |||
| 206 | }, | ||
| 207 | ... | ||
| 208 | ], # OPTIONAL | ||
| 209 | ); | ||
| 210 | |||
| 211 | # Results: | ||
| 212 | my $JobId = $CreateJobResult->JobId; | ||
| 213 | |||
| 214 | # Returns a L<Paws::S3Control::CreateJobResult> object. | ||
| 215 | |||
| 216 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 217 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-control/CreateJob> | ||
| 218 | |||
| 219 | =head1 ATTRIBUTES | ||
| 220 | |||
| 221 | |||
| 222 | =head2 B<REQUIRED> AccountId => Str | ||
| 223 | |||
| 224 | The AWS account ID that creates the job. | ||
| 225 | |||
| 226 | |||
| 227 | |||
| 228 | =head2 B<REQUIRED> ClientRequestToken => Str | ||
| 229 | |||
| 230 | An idempotency token to ensure that you don't accidentally submit the | ||
| 231 | same request twice. You can use any string up to the maximum length. | ||
| 232 | |||
| 233 | |||
| 234 | |||
| 235 | =head2 ConfirmationRequired => Bool | ||
| 236 | |||
| 237 | Indicates whether confirmation is required before Amazon S3 runs the | ||
| 238 | job. Confirmation is only required for jobs created through the Amazon | ||
| 239 | S3 console. | ||
| 240 | |||
| 241 | |||
| 242 | |||
| 243 | =head2 Description => Str | ||
| 244 | |||
| 245 | A description for this job. You can use any string within the permitted | ||
| 246 | length. Descriptions don't need to be unique and can be used for | ||
| 247 | multiple jobs. | ||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | =head2 B<REQUIRED> Manifest => L<Paws::S3Control::JobManifest> | ||
| 252 | |||
| 253 | Configuration parameters for the manifest. | ||
| 254 | |||
| 255 | |||
| 256 | |||
| 257 | =head2 B<REQUIRED> Operation => L<Paws::S3Control::JobOperation> | ||
| 258 | |||
| 259 | The action that you want this job to perform on every object listed in | ||
| 260 | the manifest. For more information about the available actions, see | ||
| 261 | Operations | ||
| 262 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html) | ||
| 263 | in the I<Amazon S3 User Guide>. | ||
| 264 | |||
| 265 | |||
| 266 | |||
| 267 | =head2 B<REQUIRED> Priority => Int | ||
| 268 | |||
| 269 | The numerical priority for this job. Higher numbers indicate higher | ||
| 270 | priority. | ||
| 271 | |||
| 272 | |||
| 273 | |||
| 274 | =head2 B<REQUIRED> Report => L<Paws::S3Control::JobReport> | ||
| 275 | |||
| 276 | Configuration parameters for the optional job-completion report. | ||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | =head2 B<REQUIRED> RoleArn => Str | ||
| 281 | |||
| 282 | The Amazon Resource Name (ARN) for the AWS Identity and Access | ||
| 283 | Management (IAM) role that Batch Operations will use to run this job's | ||
| 284 | action on every object in the manifest. | ||
| 285 | |||
| 286 | |||
| 287 | |||
| 288 | =head2 Tags => ArrayRef[L<Paws::S3Control::S3Tag>] | ||
| 289 | |||
| 290 | A set of tags to associate with the S3 Batch Operations job. This is an | ||
| 291 | optional parameter. | ||
| 292 | |||
| 293 | |||
| 294 | |||
| 295 | |||
| 296 | =head1 SEE ALSO | ||
| 297 | |||
| 298 | This class forms part of L<Paws>, documenting arguments for method CreateJob in L<Paws::S3Control> | ||
| 299 | |||
| 300 | =head1 BUGS and CONTRIBUTIONS | ||
| 301 | |||
| 302 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 303 | |||
| 304 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 305 | |||
| 306 | =cut | ||
| 307 |