glacier_initiate_job: This operation initiates a job of the specified type, which...

Description Usage Arguments Value Request syntax Examples

View source: R/glacier_operations.R

Description

This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job.

Usage

1
glacier_initiate_job(accountId, vaultName, jobParameters)

Arguments

accountId

[required] The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

vaultName

[required] The name of the vault.

jobParameters

Provides options for specifying job information.

Value

A list with the following syntax:

1
2
3
4
5
list(
  location = "string",
  jobId = "string",
  jobOutputPath = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
svc$initiate_job(
  accountId = "string",
  vaultName = "string",
  jobParameters = list(
    Format = "string",
    Type = "string",
    ArchiveId = "string",
    Description = "string",
    SNSTopic = "string",
    RetrievalByteRange = "string",
    Tier = "string",
    InventoryRetrievalParameters = list(
      StartDate = "string",
      EndDate = "string",
      Limit = "string",
      Marker = "string"
    ),
    SelectParameters = list(
      InputSerialization = list(
        csv = list(
          FileHeaderInfo = "USE"|"IGNORE"|"NONE",
          Comments = "string",
          QuoteEscapeCharacter = "string",
          RecordDelimiter = "string",
          FieldDelimiter = "string",
          QuoteCharacter = "string"
        )
      ),
      ExpressionType = "SQL",
      Expression = "string",
      OutputSerialization = list(
        csv = list(
          QuoteFields = "ALWAYS"|"ASNEEDED",
          QuoteEscapeCharacter = "string",
          RecordDelimiter = "string",
          FieldDelimiter = "string",
          QuoteCharacter = "string"
        )
      )
    ),
    OutputLocation = list(
      S3 = list(
        BucketName = "string",
        Prefix = "string",
        Encryption = list(
          EncryptionType = "aws:kms"|"AES256",
          KMSKeyId = "string",
          KMSContext = "string"
        ),
        CannedACL = "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control",
        AccessControlList = list(
          list(
            Grantee = list(
              Type = "AmazonCustomerByEmail"|"CanonicalUser"|"Group",
              DisplayName = "string",
              URI = "string",
              ID = "string",
              EmailAddress = "string"
            ),
            Permission = "FULL_CONTROL"|"WRITE"|"WRITE_ACP"|"READ"|"READ_ACP"
          )
        ),
        Tagging = list(
          "string"
        ),
        UserMetadata = list(
          "string"
        ),
        StorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"
      )
    )
  )
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## Not run: 
# The example initiates an inventory-retrieval job for the vault named
# examplevault.
svc$initiate_job(
  accountId = "-",
  jobParameters = list(
    Description = "My inventory job",
    Format = "CSV",
    SNSTopic = "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example",
    Type = "inventory-retrieval"
  ),
  vaultName = "examplevault"
)

## End(Not run)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.