aws-sdk-core 2.0.0.rc14 → 2.0.0.rc15

Sign up to get free protection for your applications and to get access to all the features.
Files changed (173) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +32 -3
  3. data/apis/AutoScaling.api.json +1943 -0
  4. data/apis/{autoscaling-2011-01-01.paginators.json → AutoScaling.paginators.json} +0 -0
  5. data/apis/CloudFormation.api.json +785 -0
  6. data/apis/{cloudformation-2010-05-15.paginators.json → CloudFormation.paginators.json} +0 -0
  7. data/apis/CloudFront.api.json +2581 -0
  8. data/apis/{cloudfront-2014-05-31.paginators.json → CloudFront.paginators.json} +0 -0
  9. data/apis/{cloudfront-2014-01-31.waiters.json → CloudFront.waiters.json} +0 -0
  10. data/apis/CloudSearch.api.json +1955 -0
  11. data/apis/{cloudsearch-2013-01-01.paginators.json → CloudSearch.paginators.json} +0 -0
  12. data/apis/CloudSearchDomain.api.json +349 -0
  13. data/apis/CloudTrail.api.json +559 -0
  14. data/apis/{cloudtrail-2013-11-01.paginators.json → CloudTrail.paginators.json} +0 -0
  15. data/apis/CloudWatch.api.json +917 -0
  16. data/apis/{monitoring-2010-08-01.paginators.json → CloudWatch.paginators.json} +0 -0
  17. data/apis/CloudWatchLogs.api.json +816 -0
  18. data/apis/{logs-2014-03-28.paginators.json → CloudWatchLogs.paginators.json} +0 -0
  19. data/apis/CognitoIdentity.api.json +631 -0
  20. data/apis/CognitoSync.api.json +721 -0
  21. data/apis/DataPipeline.api.json +940 -0
  22. data/apis/{datapipeline-2012-10-29.paginators.json → DataPipeline.paginators.json} +0 -0
  23. data/apis/DirectConnect.api.json +833 -0
  24. data/apis/{directconnect-2012-10-25.paginators.json → DirectConnect.paginators.json} +0 -0
  25. data/apis/DynamoDB.api.json +1210 -0
  26. data/apis/{dynamodb-2011-12-05.paginators.json → DynamoDB.paginators.json} +0 -0
  27. data/apis/{dynamodb-2012-08-10.waiters.json → DynamoDB.waiters.json} +0 -0
  28. data/apis/EC2.api.json +9914 -0
  29. data/apis/{ec2-2014-06-15.paginators.json → EC2.paginators.json} +0 -0
  30. data/apis/{ec2-2014-06-15.resources.json → EC2.resources.json} +0 -0
  31. data/apis/{ec2-2014-06-15.waiters.json → EC2.waiters.json} +0 -0
  32. data/apis/EMR.api.json +1339 -0
  33. data/apis/{elasticmapreduce-2009-03-31.paginators.json → EMR.paginators.json} +0 -0
  34. data/apis/ElastiCache.api.json +3410 -0
  35. data/apis/{elasticache-2014-03-24.paginators.json → ElastiCache.paginators.json} +0 -0
  36. data/apis/ElasticBeanstalk.api.json +1540 -0
  37. data/apis/{elasticbeanstalk-2010-12-01.paginators.json → ElasticBeanstalk.paginators.json} +0 -0
  38. data/apis/ElasticLoadBalancing.api.json +2131 -0
  39. data/apis/{elasticloadbalancing-2012-06-01.paginators.json → ElasticLoadBalancing.paginators.json} +0 -0
  40. data/apis/ElasticTranscoder.api.json +1647 -0
  41. data/apis/{elastictranscoder-2012-09-25.paginators.json → ElasticTranscoder.paginators.json} +0 -0
  42. data/apis/Glacier.api.json +1456 -0
  43. data/apis/{glacier-2012-06-01.paginators.json → Glacier.paginators.json} +0 -0
  44. data/apis/{glacier-2012-06-01.resources.json → Glacier.resources.json} +0 -0
  45. data/apis/{glacier-2012-06-01.waiters.json → Glacier.waiters.json} +0 -0
  46. data/apis/IAM.api.json +4033 -0
  47. data/apis/{iam-2010-05-08.paginators.json → IAM.paginators.json} +0 -0
  48. data/apis/{iam-2010-05-08.resources.json → IAM.resources.json} +0 -0
  49. data/apis/ImportExport.api.json +515 -0
  50. data/apis/{importexport-2010-06-01.paginators.json → ImportExport.paginators.json} +0 -0
  51. data/apis/Kinesis.api.json +548 -0
  52. data/apis/{kinesis-2013-12-02.paginators.json → Kinesis.paginators.json} +0 -0
  53. data/apis/OpsWorks.api.json +2524 -0
  54. data/apis/{opsworks-2013-02-18.paginators.json → OpsWorks.paginators.json} +0 -0
  55. data/apis/RDS.api.json +4473 -0
  56. data/apis/{rds-2013-02-12.paginators.json → RDS.paginators.json} +0 -0
  57. data/apis/{rds-2013-09-09.waiters.json → RDS.waiters.json} +0 -0
  58. data/apis/Redshift.api.json +4482 -0
  59. data/apis/{redshift-2012-12-01.paginators.json → Redshift.paginators.json} +0 -0
  60. data/apis/{redshift-2012-12-01.waiters.json → Redshift.waiters.json} +0 -0
  61. data/apis/Route53.api.json +1935 -0
  62. data/apis/{route53-2013-04-01.paginators.json → Route53.paginators.json} +0 -0
  63. data/apis/Route53Domains.api.json +1129 -0
  64. data/apis/{s3-2006-03-01.api.json → S3.api.json} +336 -942
  65. data/apis/{s3-2006-03-01.paginators.json → S3.paginators.json} +1 -1
  66. data/apis/{s3-2006-03-01.resources.json → S3.resources.json} +0 -0
  67. data/apis/{s3-2006-03-01.waiters.json → S3.waiters.json} +0 -0
  68. data/apis/SES.api.json +644 -0
  69. data/apis/{email-2010-12-01.paginators.json → SES.paginators.json} +0 -0
  70. data/apis/{email-2010-12-01.waiters.json → SES.waiters.json} +0 -0
  71. data/apis/SNS.api.json +1760 -0
  72. data/apis/{sns-2010-03-31.paginators.json → SNS.paginators.json} +0 -0
  73. data/apis/{sns-2010-03-31.resources.json → SNS.resources.json} +0 -0
  74. data/apis/SQS.api.json +1113 -0
  75. data/apis/{sqs-2012-11-05.paginators.json → SQS.paginators.json} +0 -0
  76. data/apis/{sqs-2012-11-05.resources.json → SQS.resources.json} +0 -0
  77. data/apis/STS.api.json +594 -0
  78. data/apis/SWF.api.json +2656 -0
  79. data/apis/{swf-2012-01-25.paginators.json → SWF.paginators.json} +0 -0
  80. data/apis/SimpleDB.api.json +954 -0
  81. data/apis/{sdb-2009-04-15.paginators.json → SimpleDB.paginators.json} +0 -0
  82. data/apis/StorageGateway.api.json +2311 -0
  83. data/apis/{storagegateway-2013-06-30.paginators.json → StorageGateway.paginators.json} +0 -0
  84. data/apis/Support.api.json +869 -0
  85. data/apis/{support-2013-04-15.paginators.json → Support.paginators.json} +0 -0
  86. data/lib/aws.rb +96 -53
  87. data/lib/aws/api/documenter.rb +238 -0
  88. data/lib/aws/api/{documentor.rb → operation_documenter.rb} +9 -5
  89. data/lib/aws/api/{doc_example.rb → operation_example.rb} +8 -7
  90. data/lib/aws/api/service_customizations.rb +3 -1
  91. data/lib/aws/client.rb +38 -0
  92. data/lib/aws/credential_provider_chain.rb +1 -0
  93. data/lib/aws/dynamodb/attribute_value.rb +87 -0
  94. data/lib/aws/empty_structure.rb +4 -3
  95. data/lib/aws/endpoint_provider.rb +1 -0
  96. data/lib/aws/errors.rb +2 -0
  97. data/lib/aws/instance_profile_credentials.rb +1 -1
  98. data/lib/aws/plugins/csd_conditional_signing.rb +32 -0
  99. data/lib/aws/plugins/dynamodb_simple_attributes.rb +179 -0
  100. data/lib/aws/plugins/global_configuration.rb +13 -3
  101. data/lib/aws/plugins/protocols/json_rpc.rb +9 -7
  102. data/lib/aws/plugins/regional_endpoint.rb +1 -1
  103. data/lib/aws/plugins/request_signer.rb +13 -6
  104. data/lib/aws/plugins/response_paging.rb +1 -2
  105. data/lib/aws/plugins/s3_url_encoded_keys.rb +92 -0
  106. data/lib/aws/plugins/user_agent.rb +1 -2
  107. data/lib/aws/signers/v4.rb +1 -1
  108. data/lib/aws/structure.rb +49 -2
  109. data/lib/aws/version.rb +1 -1
  110. data/lib/aws/xml/builder.rb +1 -0
  111. data/lib/seahorse.rb +2 -1
  112. data/lib/seahorse/client/handler_list.rb +10 -3
  113. data/lib/seahorse/client/http/request.rb +0 -8
  114. data/lib/seahorse/client/xml/builder.rb +0 -1
  115. data/lib/seahorse/model/shape_map.rb +1 -0
  116. data/lib/seahorse/model/shapes.rb +5 -0
  117. metadata +93 -107
  118. data/apis/autoscaling-2011-01-01.api.json +0 -3063
  119. data/apis/cloudformation-2010-05-15.api.json +0 -1306
  120. data/apis/cloudfront-2014-01-31.api.json +0 -3478
  121. data/apis/cloudfront-2014-01-31.paginators.json +0 -32
  122. data/apis/cloudfront-2014-05-31.api.json +0 -3540
  123. data/apis/cloudfront-2014-05-31.waiters.json +0 -29
  124. data/apis/cloudsearch-2011-02-01.api.json +0 -2093
  125. data/apis/cloudsearch-2011-02-01.paginators.json +0 -13
  126. data/apis/cloudsearch-2013-01-01.api.json +0 -2655
  127. data/apis/cloudsearchdomain-2013-01-01.api.json +0 -508
  128. data/apis/cloudtrail-2013-11-01.api.json +0 -773
  129. data/apis/cognito-identity-2014-06-30.api.json +0 -884
  130. data/apis/cognito-sync-2014-06-30.api.json +0 -1029
  131. data/apis/datapipeline-2012-10-29.api.json +0 -1432
  132. data/apis/directconnect-2012-10-25.api.json +0 -1174
  133. data/apis/dynamodb-2011-12-05.api.json +0 -1208
  134. data/apis/dynamodb-2011-12-05.waiters.json +0 -27
  135. data/apis/dynamodb-2012-08-10.api.json +0 -1857
  136. data/apis/dynamodb-2012-08-10.paginators.json +0 -26
  137. data/apis/ec2-2014-06-15.api.json +0 -11670
  138. data/apis/elasticache-2014-03-24.api.json +0 -4789
  139. data/apis/elasticache-2014-07-15.api.json +0 -4826
  140. data/apis/elasticache-2014-07-15.paginators.json +0 -76
  141. data/apis/elasticbeanstalk-2010-12-01.api.json +0 -2442
  142. data/apis/elasticloadbalancing-2012-06-01.api.json +0 -2605
  143. data/apis/elasticmapreduce-2009-03-31.api.json +0 -2282
  144. data/apis/elastictranscoder-2012-09-25.api.json +0 -2478
  145. data/apis/email-2010-12-01.api.json +0 -954
  146. data/apis/glacier-2012-06-01.api.json +0 -2012
  147. data/apis/iam-2010-05-08.api.json +0 -5322
  148. data/apis/importexport-2010-06-01.api.json +0 -687
  149. data/apis/kinesis-2013-12-02.api.json +0 -769
  150. data/apis/logs-2014-03-28.api.json +0 -942
  151. data/apis/manifest.json +0 -259
  152. data/apis/monitoring-2010-08-01.api.json +0 -1338
  153. data/apis/opsworks-2013-02-18.api.json +0 -4348
  154. data/apis/rds-2013-01-10.api.json +0 -6074
  155. data/apis/rds-2013-01-10.paginators.json +0 -97
  156. data/apis/rds-2013-02-12.api.json +0 -6392
  157. data/apis/rds-2013-09-09.api.json +0 -6564
  158. data/apis/rds-2013-09-09.paginators.json +0 -110
  159. data/apis/redshift-2012-12-01.api.json +0 -6318
  160. data/apis/route53-2013-04-01.api.json +0 -2493
  161. data/apis/route53domains-2014-05-15.api.json +0 -1622
  162. data/apis/sdb-2009-04-15.api.json +0 -1178
  163. data/apis/sns-2010-03-31.api.json +0 -2275
  164. data/apis/sqs-2012-11-05.api.json +0 -1438
  165. data/apis/storagegateway-2013-06-30.api.json +0 -3153
  166. data/apis/sts-2011-06-15.api.json +0 -786
  167. data/apis/support-2013-04-15.api.json +0 -1379
  168. data/apis/swf-2012-01-25.api.json +0 -4463
  169. data/lib/aws/api/manifest.rb +0 -29
  170. data/lib/aws/api/manifest_builder.rb +0 -57
  171. data/lib/aws/api/minifier.rb +0 -42
  172. data/lib/aws/response_handler.rb +0 -38
  173. data/lib/aws/service_builder.rb +0 -56
@@ -1,2012 +0,0 @@
1
- {
2
- "metadata":{
3
- "apiVersion":"2012-06-01",
4
- "checksumFormat":"sha256",
5
- "endpointPrefix":"glacier",
6
- "serviceFullName":"Amazon Glacier",
7
- "signatureVersion":"v4",
8
- "protocol":"rest-json"
9
- },
10
- "documentation":"<p>Amazon Glacier is a storage solution for \"cold data.\"</p> <p>Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.</p> <p>Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, go to <a href=\"http://aws.amazon.com/s3/\">Amazon Simple Storage Service (Amazon S3)</a>.</p> <p>You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier. </p> <p>If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the <i>Amazon Glacier Developer Guide</i>:</p> <ul> <li><p><a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html\">What is Amazon Glacier</a> - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.</p></li> <li><p><a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html\">Getting Started with Amazon Glacier</a> - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.</p></li> </ul>",
11
- "operations":{
12
- "AbortMultipartUpload":{
13
- "name":"AbortMultipartUpload",
14
- "http":{
15
- "method":"DELETE",
16
- "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}",
17
- "responseCode":204
18
- },
19
- "input":{
20
- "shape":"AbortMultipartUploadInput",
21
- "documentation":"<p>Provides options to abort a multipart upload identified by the upload ID. </p> <p>For information about the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html\">Abort Multipart Upload</a>. For conceptual information, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a>.</p>"
22
- },
23
- "errors":[
24
- {
25
- "shape":"ResourceNotFoundException",
26
- "error":{"httpStatusCode":404},
27
- "exception":true,
28
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
29
- },
30
- {
31
- "shape":"InvalidParameterValueException",
32
- "error":{"httpStatusCode":400},
33
- "exception":true,
34
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
35
- },
36
- {
37
- "shape":"MissingParameterValueException",
38
- "error":{"httpStatusCode":400},
39
- "exception":true,
40
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
41
- },
42
- {
43
- "shape":"ServiceUnavailableException",
44
- "error":{"httpStatusCode":500},
45
- "exception":true,
46
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
47
- }
48
- ],
49
- "documentation":"<p>This operation aborts a multipart upload identified by the upload ID.</p> <p>After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see <a>UploadMultipartPart</a> and <a>CompleteMultipartUpload</a>.</p> <p>This operation is idempotent.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html\">Abort Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
50
- },
51
- "CompleteMultipartUpload":{
52
- "name":"CompleteMultipartUpload",
53
- "http":{
54
- "method":"POST",
55
- "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}",
56
- "responseCode":201
57
- },
58
- "input":{
59
- "shape":"CompleteMultipartUploadInput",
60
- "documentation":"<p>Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.</p>"
61
- },
62
- "output":{
63
- "shape":"ArchiveCreationOutput",
64
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p> <p>For information about the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html\">Upload Archive</a>. For conceptual information, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a>.</p>"
65
- },
66
- "errors":[
67
- {
68
- "shape":"ResourceNotFoundException",
69
- "error":{"httpStatusCode":404},
70
- "exception":true,
71
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
72
- },
73
- {
74
- "shape":"InvalidParameterValueException",
75
- "error":{"httpStatusCode":400},
76
- "exception":true,
77
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
78
- },
79
- {
80
- "shape":"MissingParameterValueException",
81
- "error":{"httpStatusCode":400},
82
- "exception":true,
83
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
84
- },
85
- {
86
- "shape":"ServiceUnavailableException",
87
- "error":{"httpStatusCode":500},
88
- "exception":true,
89
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
90
- }
91
- ],
92
- "documentation":"<p>You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see <a>InitiateJob</a>.</p> <p>In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html\">Computing Checksums</a>. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The <a>ListParts</a> operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.</p> <p>Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails. </p> <p>Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html\">Complete Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
93
- },
94
- "CreateVault":{
95
- "name":"CreateVault",
96
- "http":{
97
- "method":"PUT",
98
- "requestUri":"/{accountId}/vaults/{vaultName}",
99
- "responseCode":201
100
- },
101
- "input":{
102
- "shape":"CreateVaultInput",
103
- "documentation":"<p>Provides options to create a vault.</p>"
104
- },
105
- "output":{
106
- "shape":"CreateVaultOutput",
107
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
108
- },
109
- "errors":[
110
- {
111
- "shape":"InvalidParameterValueException",
112
- "error":{"httpStatusCode":400},
113
- "exception":true,
114
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
115
- },
116
- {
117
- "shape":"MissingParameterValueException",
118
- "error":{"httpStatusCode":400},
119
- "exception":true,
120
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
121
- },
122
- {
123
- "shape":"ServiceUnavailableException",
124
- "error":{"httpStatusCode":500},
125
- "exception":true,
126
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
127
- },
128
- {
129
- "shape":"LimitExceededException",
130
- "error":{"httpStatusCode":400},
131
- "exception":true,
132
- "documentation":"<p>Returned if the request results in a vault or account limit being exceeded.</p>"
133
- }
134
- ],
135
- "documentation":"<p>This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.</p> <p>You must use the following guidelines when naming a vault. </p> <p> <ul> <li> <p> Names can be between 1 and 255 characters long. </p> </li> <li> <p>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).</p> </li> </ul> </p> <p>This operation is idempotent.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html\">Creating a Vault in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html\">Create Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
136
- },
137
- "DeleteArchive":{
138
- "name":"DeleteArchive",
139
- "http":{
140
- "method":"DELETE",
141
- "requestUri":"/{accountId}/vaults/{vaultName}/archives/{archiveId}",
142
- "responseCode":204
143
- },
144
- "input":{
145
- "shape":"DeleteArchiveInput",
146
- "documentation":"<p>Provides options for deleting an archive from an Amazon Glacier vault.</p>"
147
- },
148
- "errors":[
149
- {
150
- "shape":"ResourceNotFoundException",
151
- "error":{"httpStatusCode":404},
152
- "exception":true,
153
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
154
- },
155
- {
156
- "shape":"InvalidParameterValueException",
157
- "error":{"httpStatusCode":400},
158
- "exception":true,
159
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
160
- },
161
- {
162
- "shape":"MissingParameterValueException",
163
- "error":{"httpStatusCode":400},
164
- "exception":true,
165
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
166
- },
167
- {
168
- "shape":"ServiceUnavailableException",
169
- "error":{"httpStatusCode":500},
170
- "exception":true,
171
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
172
- }
173
- ],
174
- "documentation":"<p>This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:</p> <ul> <li>If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail. </li> <li>If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output. </li> </ul> <p>This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html\">Deleting an Archive in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html\">Delete Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
175
- },
176
- "DeleteVault":{
177
- "name":"DeleteVault",
178
- "http":{
179
- "method":"DELETE",
180
- "requestUri":"/{accountId}/vaults/{vaultName}",
181
- "responseCode":204
182
- },
183
- "input":{
184
- "shape":"DeleteVaultInput",
185
- "documentation":"<p>Provides options for deleting a vault from Amazon Glacier.</p>"
186
- },
187
- "errors":[
188
- {
189
- "shape":"ResourceNotFoundException",
190
- "error":{"httpStatusCode":404},
191
- "exception":true,
192
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
193
- },
194
- {
195
- "shape":"InvalidParameterValueException",
196
- "error":{"httpStatusCode":400},
197
- "exception":true,
198
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
199
- },
200
- {
201
- "shape":"MissingParameterValueException",
202
- "error":{"httpStatusCode":400},
203
- "exception":true,
204
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
205
- },
206
- {
207
- "shape":"ServiceUnavailableException",
208
- "error":{"httpStatusCode":500},
209
- "exception":true,
210
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
211
- }
212
- ],
213
- "documentation":"<p>This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use <a>DescribeVault</a> to return the number of archives in a vault, and you can use <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html\">Initiate a Job (POST jobs)</a> to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html\">Delete Archive (DELETE archive)</a>.</p> <p>This operation is idempotent.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html\">Deleting a Vault in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html\">Delete Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
214
- },
215
- "DeleteVaultNotifications":{
216
- "name":"DeleteVaultNotifications",
217
- "http":{
218
- "method":"DELETE",
219
- "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration",
220
- "responseCode":204
221
- },
222
- "input":{
223
- "shape":"DeleteVaultNotificationsInput",
224
- "documentation":"<p>Provides options for deleting a vault notification configuration from an Amazon Glacier vault.</p>"
225
- },
226
- "errors":[
227
- {
228
- "shape":"ResourceNotFoundException",
229
- "error":{"httpStatusCode":404},
230
- "exception":true,
231
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
232
- },
233
- {
234
- "shape":"InvalidParameterValueException",
235
- "error":{"httpStatusCode":400},
236
- "exception":true,
237
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
238
- },
239
- {
240
- "shape":"MissingParameterValueException",
241
- "error":{"httpStatusCode":400},
242
- "exception":true,
243
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
244
- },
245
- {
246
- "shape":"ServiceUnavailableException",
247
- "error":{"httpStatusCode":500},
248
- "exception":true,
249
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
250
- }
251
- ],
252
- "documentation":"<p>This operation deletes the notification configuration set for a vault. The operation is eventually consistent;that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html\">Delete Vault Notification Configuration </a> in the Amazon Glacier Developer Guide. </p>"
253
- },
254
- "DescribeJob":{
255
- "name":"DescribeJob",
256
- "http":{
257
- "method":"GET",
258
- "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}"
259
- },
260
- "input":{
261
- "shape":"DescribeJobInput",
262
- "documentation":"<p>Provides options for retrieving a job description.</p>"
263
- },
264
- "output":{
265
- "shape":"GlacierJobDescription",
266
- "documentation":"<p>Describes an Amazon Glacier job.</p>"
267
- },
268
- "errors":[
269
- {
270
- "shape":"ResourceNotFoundException",
271
- "error":{"httpStatusCode":404},
272
- "exception":true,
273
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
274
- },
275
- {
276
- "shape":"InvalidParameterValueException",
277
- "error":{"httpStatusCode":400},
278
- "exception":true,
279
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
280
- },
281
- {
282
- "shape":"MissingParameterValueException",
283
- "error":{"httpStatusCode":400},
284
- "exception":true,
285
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
286
- },
287
- {
288
- "shape":"ServiceUnavailableException",
289
- "error":{"httpStatusCode":500},
290
- "exception":true,
291
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
292
- }
293
- ],
294
- "documentation":"<p>This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see <a>InitiateJob</a>. </p> <p>A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For information about the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html\">Working with Archives in Amazon Glacier</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
295
- },
296
- "DescribeVault":{
297
- "name":"DescribeVault",
298
- "http":{
299
- "method":"GET",
300
- "requestUri":"/{accountId}/vaults/{vaultName}"
301
- },
302
- "input":{
303
- "shape":"DescribeVaultInput",
304
- "documentation":"<p>Provides options for retrieving metadata for a specific vault in Amazon Glacier.</p>"
305
- },
306
- "output":{
307
- "shape":"DescribeVaultOutput",
308
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
309
- },
310
- "errors":[
311
- {
312
- "shape":"ResourceNotFoundException",
313
- "error":{"httpStatusCode":404},
314
- "exception":true,
315
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
316
- },
317
- {
318
- "shape":"InvalidParameterValueException",
319
- "error":{"httpStatusCode":400},
320
- "exception":true,
321
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
322
- },
323
- {
324
- "shape":"MissingParameterValueException",
325
- "error":{"httpStatusCode":400},
326
- "exception":true,
327
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
328
- },
329
- {
330
- "shape":"ServiceUnavailableException",
331
- "error":{"httpStatusCode":500},
332
- "exception":true,
333
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
334
- }
335
- ],
336
- "documentation":"<p>This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use <a>InitiateJob</a>. Amazon Glacier generates vault inventories approximately daily. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory in Amazon Glacier</a>. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html\">Describe Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
337
- },
338
- "GetJobOutput":{
339
- "name":"GetJobOutput",
340
- "http":{
341
- "method":"GET",
342
- "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}/output"
343
- },
344
- "input":{
345
- "shape":"GetJobOutputInput",
346
- "documentation":"<p>Provides options for downloading output of an Amazon Glacier job.</p>"
347
- },
348
- "output":{
349
- "shape":"GetJobOutputOutput",
350
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
351
- },
352
- "errors":[
353
- {
354
- "shape":"ResourceNotFoundException",
355
- "error":{"httpStatusCode":404},
356
- "exception":true,
357
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
358
- },
359
- {
360
- "shape":"InvalidParameterValueException",
361
- "error":{"httpStatusCode":400},
362
- "exception":true,
363
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
364
- },
365
- {
366
- "shape":"MissingParameterValueException",
367
- "error":{"httpStatusCode":400},
368
- "exception":true,
369
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
370
- },
371
- {
372
- "shape":"ServiceUnavailableException",
373
- "error":{"httpStatusCode":500},
374
- "exception":true,
375
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
376
- }
377
- ],
378
- "documentation":"<p>This operation downloads the output of the job you initiated using <a>InitiateJob</a>. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.</p> <p>A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.</p> <p>If the job output is large, then you can use the <code>Range</code> request header to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:</p> <ol> <li> <p>Download a 128 MB chunk of output by specifying the appropriate byte range using the <code>Range</code> header.</p> </li> <li> <p>Along with the data, the response includes a checksum of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.</p> </li> <li> <p>Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.</p> </li> <li> <p>After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the <a>DescribeJob</a> API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.</p> </li> </ol> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory</a>, <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html\">Downloading an Archive</a>, and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html\">Get Job Output </a> </p>"
379
- },
380
- "GetVaultNotifications":{
381
- "name":"GetVaultNotifications",
382
- "http":{
383
- "method":"GET",
384
- "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration"
385
- },
386
- "input":{
387
- "shape":"GetVaultNotificationsInput",
388
- "documentation":"<p>Provides options for retrieving the notification configuration set on an Amazon Glacier vault.</p>"
389
- },
390
- "output":{
391
- "shape":"GetVaultNotificationsOutput",
392
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
393
- },
394
- "errors":[
395
- {
396
- "shape":"ResourceNotFoundException",
397
- "error":{"httpStatusCode":404},
398
- "exception":true,
399
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
400
- },
401
- {
402
- "shape":"InvalidParameterValueException",
403
- "error":{"httpStatusCode":400},
404
- "exception":true,
405
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
406
- },
407
- {
408
- "shape":"MissingParameterValueException",
409
- "error":{"httpStatusCode":400},
410
- "exception":true,
411
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
412
- },
413
- {
414
- "shape":"ServiceUnavailableException",
415
- "error":{"httpStatusCode":500},
416
- "exception":true,
417
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
418
- }
419
- ],
420
- "documentation":"<p>This operation retrieves the <code class=\"code\">notification-configuration</code> subresource of the specified vault.</p> <p>For information about setting a notification configuration on a vault, see <a>SetVaultNotifications</a>. If a notification configuration for a vault is not set, the operation returns a <code class=\"code\">404 Not Found</code> error. For more information about vault notifications, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a>. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html\">Get Vault Notification Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
421
- },
422
- "InitiateJob":{
423
- "name":"InitiateJob",
424
- "http":{
425
- "method":"POST",
426
- "requestUri":"/{accountId}/vaults/{vaultName}/jobs",
427
- "responseCode":202
428
- },
429
- "input":{
430
- "shape":"InitiateJobInput",
431
- "documentation":"<p>Provides options for initiating an Amazon Glacier job.</p>"
432
- },
433
- "output":{
434
- "shape":"InitiateJobOutput",
435
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
436
- },
437
- "errors":[
438
- {
439
- "shape":"ResourceNotFoundException",
440
- "error":{"httpStatusCode":404},
441
- "exception":true,
442
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
443
- },
444
- {
445
- "shape":"InvalidParameterValueException",
446
- "error":{"httpStatusCode":400},
447
- "exception":true,
448
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
449
- },
450
- {
451
- "shape":"MissingParameterValueException",
452
- "error":{"httpStatusCode":400},
453
- "exception":true,
454
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
455
- },
456
- {
457
- "shape":"ServiceUnavailableException",
458
- "error":{"httpStatusCode":500},
459
- "exception":true,
460
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
461
- }
462
- ],
463
- "documentation":"<p>This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault). </p> <p>Retrieving data from Amazon Glacier is a two-step process: </p> <ol> <li><p>Initiate a retrieval job.</p></li> <li><p>After the job completes, download the bytes.</p></li> </ol> <p>The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see <a>GetJobOutput</a> operation. </p> <p>The job must complete before you can get its output. To determine when a job is complete, you have the following options:</p> <ul> <li> <p><b>Use Amazon SNS Notification</b> You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see <a>SetVaultNotifications</a>.</p> </li> <li> <p><b>Get job details</b> You can make a <a>DescribeJob</a> request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.</p> </li> </ul> <p>If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see <a>SetVaultNotifications</a>.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p><b>About the Vault Inventory</b></p> <p>Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory. </p> <p><b>Range Inventory Retrieval</b></p> <p>You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.</p> <p><i>Filtering by Archive Creation Date</i></p> <p>You can retrieve inventory items for archives created between <code>StartDate</code> and <code>EndDate</code> by specifying values for these parameters in the <b>InitiateJob</b> request. Archives created on or after the <code>StartDate</code> and before the <code>EndDate</code> will be returned. If you only provide the <code>StartDate</code> without the <code>EndDate</code>, you will retrieve the inventory for all archives created on or after the <code>StartDate</code>. If you only provide the <code>EndDate</code> without the <code>StartDate</code>, you will get back the inventory for all archives created before the <code>EndDate</code>.</p> <p><i>Limiting Inventory Items per Retrieval</i></p> <p>You can limit the number of inventory items returned by setting the <code>Limit</code> parameter in the <b>InitiateJob</b> request. The inventory job output will contain inventory items up to the specified <code>Limit</code>. If there are more inventory items available, the result is paginated. After a job is complete you can use the <a>DescribeJob</a> operation to get a marker that you use in a subsequent <b>InitiateJob</b> request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making <b>InitiateJob</b> requests with the marker from the previous <b>DescribeJob</b> output, until you get a marker from <b>DescribeJob</b> that returns null, indicating that there are no more inventory items available.</p> <p>You can use the <code>Limit</code> parameter together with the date range parameters.</p> <p><b>About Ranged Archive Retrieval</b></p> <p> You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html\">Initiate a Job</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory</a> </p>"
464
- },
465
- "InitiateMultipartUpload":{
466
- "name":"InitiateMultipartUpload",
467
- "http":{
468
- "method":"POST",
469
- "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads",
470
- "responseCode":201
471
- },
472
- "input":{
473
- "shape":"InitiateMultipartUploadInput",
474
- "documentation":"<p>Provides options for initiating a multipart upload to an Amazon Glacier vault.</p>"
475
- },
476
- "output":{
477
- "shape":"InitiateMultipartUploadOutput",
478
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
479
- },
480
- "errors":[
481
- {
482
- "shape":"ResourceNotFoundException",
483
- "error":{"httpStatusCode":404},
484
- "exception":true,
485
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
486
- },
487
- {
488
- "shape":"InvalidParameterValueException",
489
- "error":{"httpStatusCode":400},
490
- "exception":true,
491
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
492
- },
493
- {
494
- "shape":"MissingParameterValueException",
495
- "error":{"httpStatusCode":400},
496
- "exception":true,
497
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
498
- },
499
- {
500
- "shape":"ServiceUnavailableException",
501
- "error":{"httpStatusCode":500},
502
- "exception":true,
503
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
504
- }
505
- ],
506
- "documentation":"<p>This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see <a>UploadMultipartPart</a>).</p> <p>When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.</p> <p>Every part you upload to this resource (see <a>UploadMultipartPart</a>), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. </p> <p>After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html\">Initiate Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
507
- },
508
- "ListJobs":{
509
- "name":"ListJobs",
510
- "http":{
511
- "method":"GET",
512
- "requestUri":"/{accountId}/vaults/{vaultName}/jobs"
513
- },
514
- "input":{
515
- "shape":"ListJobsInput",
516
- "documentation":"<p>Provides options for retrieving a job list for an Amazon Glacier vault.</p>"
517
- },
518
- "output":{
519
- "shape":"ListJobsOutput",
520
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
521
- },
522
- "errors":[
523
- {
524
- "shape":"ResourceNotFoundException",
525
- "error":{"httpStatusCode":404},
526
- "exception":true,
527
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
528
- },
529
- {
530
- "shape":"InvalidParameterValueException",
531
- "error":{"httpStatusCode":400},
532
- "exception":true,
533
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
534
- },
535
- {
536
- "shape":"MissingParameterValueException",
537
- "error":{"httpStatusCode":400},
538
- "exception":true,
539
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
540
- },
541
- {
542
- "shape":"ServiceUnavailableException",
543
- "error":{"httpStatusCode":500},
544
- "exception":true,
545
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
546
- }
547
- ],
548
- "documentation":"<p>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. </p> <p>To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.</p> <p>This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of jobs that begins at a specific job, set the <code>marker</code> request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the <code>limit</code> parameter in the request.</p> <p>Additionally, you can filter the jobs list returned by specifying an optional <code>statuscode</code> (InProgress, Succeeded, or Failed) and <code>completed</code> (true, false) parameter. The <code>statuscode</code> allows you to specify that only jobs that match a specified status are returned. The <code>completed</code> parameter allows you to specify that only jobs in a specific completion state are returned.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html\">List Jobs </a> </p>"
549
- },
550
- "ListMultipartUploads":{
551
- "name":"ListMultipartUploads",
552
- "http":{
553
- "method":"GET",
554
- "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads"
555
- },
556
- "input":{
557
- "shape":"ListMultipartUploadsInput",
558
- "documentation":"<p>Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.</p>"
559
- },
560
- "output":{
561
- "shape":"ListMultipartUploadsOutput",
562
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
563
- },
564
- "errors":[
565
- {
566
- "shape":"ResourceNotFoundException",
567
- "error":{"httpStatusCode":404},
568
- "exception":true,
569
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
570
- },
571
- {
572
- "shape":"InvalidParameterValueException",
573
- "error":{"httpStatusCode":400},
574
- "exception":true,
575
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
576
- },
577
- {
578
- "shape":"MissingParameterValueException",
579
- "error":{"httpStatusCode":400},
580
- "exception":true,
581
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
582
- },
583
- {
584
- "shape":"ServiceUnavailableException",
585
- "error":{"httpStatusCode":500},
586
- "exception":true,
587
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
588
- }
589
- ],
590
- "documentation":"<p>This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a> request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. </p> <p>The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of multipart uploads that begins at a specific upload, set the <code>marker</code> request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the <code>limit</code> parameter in the request.</p> <p>Note the difference between this operation and listing parts (<a>ListParts</a>). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html\">List Multipart Uploads </a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
591
- },
592
- "ListParts":{
593
- "name":"ListParts",
594
- "http":{
595
- "method":"GET",
596
- "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}"
597
- },
598
- "input":{
599
- "shape":"ListPartsInput",
600
- "documentation":"<p>Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.</p>"
601
- },
602
- "output":{
603
- "shape":"ListPartsOutput",
604
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
605
- },
606
- "errors":[
607
- {
608
- "shape":"ResourceNotFoundException",
609
- "error":{"httpStatusCode":404},
610
- "exception":true,
611
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
612
- },
613
- {
614
- "shape":"InvalidParameterValueException",
615
- "error":{"httpStatusCode":400},
616
- "exception":true,
617
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
618
- },
619
- {
620
- "shape":"MissingParameterValueException",
621
- "error":{"httpStatusCode":400},
622
- "exception":true,
623
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
624
- },
625
- {
626
- "shape":"ServiceUnavailableException",
627
- "error":{"httpStatusCode":500},
628
- "exception":true,
629
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
630
- }
631
- ],
632
- "documentation":"<p>This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see <a>CompleteMultipartUpload</a>. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. </p> <p>The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a <code class=\"code\">marker</code> at which to continue the list; if there are no more items the <code class=\"code\">marker</code> is <code class=\"code\">null</code>. To return a list of parts that begins at a specific part, set the <code>marker</code> request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the <code>limit</code> parameter in the request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html\">List Parts</a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
633
- },
634
- "ListVaults":{
635
- "name":"ListVaults",
636
- "http":{
637
- "method":"GET",
638
- "requestUri":"/{accountId}/vaults"
639
- },
640
- "input":{
641
- "shape":"ListVaultsInput",
642
- "documentation":"<p>Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.</p>"
643
- },
644
- "output":{
645
- "shape":"ListVaultsOutput",
646
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
647
- },
648
- "errors":[
649
- {
650
- "shape":"ResourceNotFoundException",
651
- "error":{"httpStatusCode":404},
652
- "exception":true,
653
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
654
- },
655
- {
656
- "shape":"InvalidParameterValueException",
657
- "error":{"httpStatusCode":400},
658
- "exception":true,
659
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
660
- },
661
- {
662
- "shape":"MissingParameterValueException",
663
- "error":{"httpStatusCode":400},
664
- "exception":true,
665
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
666
- },
667
- {
668
- "shape":"ServiceUnavailableException",
669
- "error":{"httpStatusCode":500},
670
- "exception":true,
671
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
672
- }
673
- ],
674
- "documentation":"<p>This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. </p> <p>By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <code class=\"code\">marker</code> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <code class=\"code\">marker</code> field is <code class=\"code\">null</code>. To return a list of vaults that begins at a specific vault, set the <code class=\"code\">marker</code> request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the <code class=\"code\">limit</code> parameter in the request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html\">List Vaults </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
675
- },
676
- "SetVaultNotifications":{
677
- "name":"SetVaultNotifications",
678
- "http":{
679
- "method":"PUT",
680
- "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration",
681
- "responseCode":204
682
- },
683
- "input":{
684
- "shape":"SetVaultNotificationsInput",
685
- "documentation":"<p>Provides options to configure notifications that will be sent when specific events happen to a vault.</p>"
686
- },
687
- "errors":[
688
- {
689
- "shape":"ResourceNotFoundException",
690
- "error":{"httpStatusCode":404},
691
- "exception":true,
692
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
693
- },
694
- {
695
- "shape":"InvalidParameterValueException",
696
- "error":{"httpStatusCode":400},
697
- "exception":true,
698
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
699
- },
700
- {
701
- "shape":"MissingParameterValueException",
702
- "error":{"httpStatusCode":400},
703
- "exception":true,
704
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
705
- },
706
- {
707
- "shape":"ServiceUnavailableException",
708
- "error":{"httpStatusCode":500},
709
- "exception":true,
710
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
711
- }
712
- ],
713
- "documentation":"<p>This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. </p> <p>To configure vault notifications, send a PUT request to the <code class=\"code\">notification-configuration</code> subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.</p> <p>Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:</p> <ul> <li> <b>ArchiveRetrievalCompleted</b> This event occurs when a job that was initiated for an archive retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from <a>DescribeJob</a>. </li> <li> <b>InventoryRetrievalCompleted</b> This event occurs when a job that was initiated for an inventory retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from <a>DescribeJob</a>. </li> </ul> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html\">Set Vault Notification Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
714
- },
715
- "UploadArchive":{
716
- "name":"UploadArchive",
717
- "http":{
718
- "method":"POST",
719
- "requestUri":"/{accountId}/vaults/{vaultName}/archives",
720
- "responseCode":201
721
- },
722
- "input":{
723
- "shape":"UploadArchiveInput",
724
- "documentation":"<p>Provides options to add an archive to a vault.</p>"
725
- },
726
- "output":{
727
- "shape":"ArchiveCreationOutput",
728
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p> <p>For information about the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html\">Upload Archive</a>. For conceptual information, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a>.</p>"
729
- },
730
- "errors":[
731
- {
732
- "shape":"ResourceNotFoundException",
733
- "error":{"httpStatusCode":404},
734
- "exception":true,
735
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
736
- },
737
- {
738
- "shape":"InvalidParameterValueException",
739
- "error":{"httpStatusCode":400},
740
- "exception":true,
741
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
742
- },
743
- {
744
- "shape":"MissingParameterValueException",
745
- "error":{"httpStatusCode":400},
746
- "exception":true,
747
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
748
- },
749
- {
750
- "shape":"RequestTimeoutException",
751
- "error":{"httpStatusCode":408},
752
- "exception":true,
753
- "documentation":"<p>Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.</p>"
754
- },
755
- {
756
- "shape":"ServiceUnavailableException",
757
- "error":{"httpStatusCode":500},
758
- "exception":true,
759
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
760
- }
761
- ],
762
- "documentation":"<p>This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the <code class=\"code\">x-amz-archive-id</code> header of the response. </p> <p>You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see <a>InitiateJob</a>. </p> <p>You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html\">Computing Checksums</a>. </p> <p>You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see <a>InitiateJob</a>. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. </p> <p>Archives are immutable. After you upload an archive, you cannot edit the archive or its description. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html\">Uploading an Archive in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html\">Upload Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
763
- },
764
- "UploadMultipartPart":{
765
- "name":"UploadMultipartPart",
766
- "http":{
767
- "method":"PUT",
768
- "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}",
769
- "responseCode":204
770
- },
771
- "input":{
772
- "shape":"UploadMultipartPartInput",
773
- "documentation":"<p>Provides options to upload a part of an archive in a multipart upload operation.</p>"
774
- },
775
- "output":{
776
- "shape":"UploadMultipartPartOutput",
777
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
778
- },
779
- "errors":[
780
- {
781
- "shape":"ResourceNotFoundException",
782
- "error":{"httpStatusCode":404},
783
- "exception":true,
784
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
785
- },
786
- {
787
- "shape":"InvalidParameterValueException",
788
- "error":{"httpStatusCode":400},
789
- "exception":true,
790
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
791
- },
792
- {
793
- "shape":"MissingParameterValueException",
794
- "error":{"httpStatusCode":400},
795
- "exception":true,
796
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
797
- },
798
- {
799
- "shape":"RequestTimeoutException",
800
- "error":{"httpStatusCode":408},
801
- "exception":true,
802
- "documentation":"<p>Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.</p>"
803
- },
804
- {
805
- "shape":"ServiceUnavailableException",
806
- "error":{"httpStatusCode":500},
807
- "exception":true,
808
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
809
- }
810
- ],
811
- "documentation":"<p>This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.</p> <p>Amazon Glacier rejects your upload part request if any of the following conditions is true:</p> <ul> <li> <p><b>SHA256 tree hash does not match</b>To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html\">Computing Checksums</a>.</p> </li> <li> <p><b>Part size does not match</b>The size of each part except the last must match the size specified in the corresponding <a>InitiateMultipartUpload</a> request. The size of the last part must be the same size as, or smaller than, the specified size.</p> </li> <li> <b>Range does not align</b>The byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. </li> </ul> <p>This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html\">Upload Part </a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
812
- }
813
- },
814
- "shapes":{
815
- "AbortMultipartUploadInput":{
816
- "type":"structure",
817
- "members":{
818
- "accountId":{
819
- "shape":"string",
820
- "location":"uri",
821
- "locationName":"accountId",
822
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
823
- },
824
- "vaultName":{
825
- "shape":"string",
826
- "location":"uri",
827
- "locationName":"vaultName",
828
- "documentation":"<p>The name of the vault.</p>"
829
- },
830
- "uploadId":{
831
- "shape":"string",
832
- "location":"uri",
833
- "locationName":"uploadId",
834
- "documentation":"<p>The upload ID of the multipart upload to delete.</p>"
835
- }
836
- },
837
- "documentation":"<p>Provides options to abort a multipart upload identified by the upload ID. </p> <p>For information about the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html\">Abort Multipart Upload</a>. For conceptual information, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a>.</p>",
838
- "required":[
839
- "accountId",
840
- "vaultName",
841
- "uploadId"
842
- ]
843
- },
844
- "ActionCode":{
845
- "type":"string",
846
- "enum":[
847
- "ArchiveRetrieval",
848
- "InventoryRetrieval"
849
- ]
850
- },
851
- "ArchiveCreationOutput":{
852
- "type":"structure",
853
- "members":{
854
- "location":{
855
- "shape":"string",
856
- "location":"header",
857
- "locationName":"Location",
858
- "documentation":"<p>The relative URI path of the newly added archive resource.</p>"
859
- },
860
- "checksum":{
861
- "shape":"string",
862
- "location":"header",
863
- "locationName":"x-amz-sha256-tree-hash",
864
- "documentation":"<p>The checksum of the archive computed by Amazon Glacier.</p>"
865
- },
866
- "archiveId":{
867
- "shape":"string",
868
- "location":"header",
869
- "locationName":"x-amz-archive-id",
870
- "documentation":"<p>The ID of the archive. This value is also included as part of the location.</p>"
871
- }
872
- },
873
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p> <p>For information about the underlying REST API, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html\">Upload Archive</a>. For conceptual information, go to <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a>.</p>"
874
- },
875
- "CompleteMultipartUploadInput":{
876
- "type":"structure",
877
- "members":{
878
- "accountId":{
879
- "shape":"string",
880
- "location":"uri",
881
- "locationName":"accountId",
882
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
883
- },
884
- "vaultName":{
885
- "shape":"string",
886
- "location":"uri",
887
- "locationName":"vaultName",
888
- "documentation":"<p>The name of the vault.</p>"
889
- },
890
- "uploadId":{
891
- "shape":"string",
892
- "location":"uri",
893
- "locationName":"uploadId",
894
- "documentation":"<p>The upload ID of the multipart upload.</p>"
895
- },
896
- "archiveSize":{
897
- "shape":"string",
898
- "location":"header",
899
- "locationName":"x-amz-archive-size",
900
- "documentation":"<p>The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.</p>"
901
- },
902
- "checksum":{
903
- "shape":"string",
904
- "location":"header",
905
- "locationName":"x-amz-sha256-tree-hash",
906
- "documentation":"<p>The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.</p>"
907
- }
908
- },
909
- "documentation":"<p>Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.</p>",
910
- "required":[
911
- "accountId",
912
- "vaultName",
913
- "uploadId"
914
- ]
915
- },
916
- "CreateVaultInput":{
917
- "type":"structure",
918
- "members":{
919
- "accountId":{
920
- "shape":"string",
921
- "location":"uri",
922
- "locationName":"accountId",
923
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
924
- },
925
- "vaultName":{
926
- "shape":"string",
927
- "location":"uri",
928
- "locationName":"vaultName",
929
- "documentation":"<p>The name of the vault.</p>"
930
- }
931
- },
932
- "documentation":"<p>Provides options to create a vault.</p>",
933
- "required":[
934
- "accountId",
935
- "vaultName"
936
- ]
937
- },
938
- "CreateVaultOutput":{
939
- "type":"structure",
940
- "members":{
941
- "location":{
942
- "shape":"string",
943
- "location":"header",
944
- "locationName":"Location",
945
- "documentation":"<p>The URI of the vault that was created.</p>"
946
- }
947
- },
948
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
949
- },
950
- "DateTime":{"type":"string"},
951
- "DeleteArchiveInput":{
952
- "type":"structure",
953
- "members":{
954
- "accountId":{
955
- "shape":"string",
956
- "location":"uri",
957
- "locationName":"accountId",
958
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
959
- },
960
- "vaultName":{
961
- "shape":"string",
962
- "location":"uri",
963
- "locationName":"vaultName",
964
- "documentation":"<p>The name of the vault.</p>"
965
- },
966
- "archiveId":{
967
- "shape":"string",
968
- "location":"uri",
969
- "locationName":"archiveId",
970
- "documentation":"<p>The ID of the archive to delete.</p>"
971
- }
972
- },
973
- "documentation":"<p>Provides options for deleting an archive from an Amazon Glacier vault.</p>",
974
- "required":[
975
- "accountId",
976
- "vaultName",
977
- "archiveId"
978
- ]
979
- },
980
- "DeleteVaultInput":{
981
- "type":"structure",
982
- "members":{
983
- "accountId":{
984
- "shape":"string",
985
- "location":"uri",
986
- "locationName":"accountId",
987
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
988
- },
989
- "vaultName":{
990
- "shape":"string",
991
- "location":"uri",
992
- "locationName":"vaultName",
993
- "documentation":"<p>The name of the vault.</p>"
994
- }
995
- },
996
- "documentation":"<p>Provides options for deleting a vault from Amazon Glacier.</p>",
997
- "required":[
998
- "accountId",
999
- "vaultName"
1000
- ]
1001
- },
1002
- "DeleteVaultNotificationsInput":{
1003
- "type":"structure",
1004
- "members":{
1005
- "accountId":{
1006
- "shape":"string",
1007
- "location":"uri",
1008
- "locationName":"accountId",
1009
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1010
- },
1011
- "vaultName":{
1012
- "shape":"string",
1013
- "location":"uri",
1014
- "locationName":"vaultName",
1015
- "documentation":"<p>The name of the vault.</p>"
1016
- }
1017
- },
1018
- "documentation":"<p>Provides options for deleting a vault notification configuration from an Amazon Glacier vault.</p>",
1019
- "required":[
1020
- "accountId",
1021
- "vaultName"
1022
- ]
1023
- },
1024
- "DescribeJobInput":{
1025
- "type":"structure",
1026
- "members":{
1027
- "accountId":{
1028
- "shape":"string",
1029
- "location":"uri",
1030
- "locationName":"accountId",
1031
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1032
- },
1033
- "vaultName":{
1034
- "shape":"string",
1035
- "location":"uri",
1036
- "locationName":"vaultName",
1037
- "documentation":"<p>The name of the vault.</p>"
1038
- },
1039
- "jobId":{
1040
- "shape":"string",
1041
- "location":"uri",
1042
- "locationName":"jobId",
1043
- "documentation":"<p>The ID of the job to describe.</p>"
1044
- }
1045
- },
1046
- "documentation":"<p>Provides options for retrieving a job description.</p>",
1047
- "required":[
1048
- "accountId",
1049
- "vaultName",
1050
- "jobId"
1051
- ]
1052
- },
1053
- "DescribeVaultInput":{
1054
- "type":"structure",
1055
- "members":{
1056
- "accountId":{
1057
- "shape":"string",
1058
- "location":"uri",
1059
- "locationName":"accountId",
1060
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1061
- },
1062
- "vaultName":{
1063
- "shape":"string",
1064
- "location":"uri",
1065
- "locationName":"vaultName",
1066
- "documentation":"<p>The name of the vault.</p>"
1067
- }
1068
- },
1069
- "documentation":"<p>Provides options for retrieving metadata for a specific vault in Amazon Glacier.</p>",
1070
- "required":[
1071
- "accountId",
1072
- "vaultName"
1073
- ]
1074
- },
1075
- "DescribeVaultOutput":{
1076
- "type":"structure",
1077
- "members":{
1078
- "VaultARN":{
1079
- "shape":"string",
1080
- "documentation":"<p>The Amazon Resource Name (ARN) of the vault.</p>"
1081
- },
1082
- "VaultName":{
1083
- "shape":"string",
1084
- "documentation":"<p>The name of the vault.</p>"
1085
- },
1086
- "CreationDate":{
1087
- "shape":"string",
1088
- "documentation":"<p>The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".</p>"
1089
- },
1090
- "LastInventoryDate":{
1091
- "shape":"string",
1092
- "documentation":"<p>The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".</p>"
1093
- },
1094
- "NumberOfArchives":{
1095
- "shape":"long",
1096
- "documentation":"<p>The number of archives in the vault as of the last inventory date. This field will return <code>null</code> if an inventory has not yet run on the vault, for example, if you just created the vault.</p>"
1097
- },
1098
- "SizeInBytes":{
1099
- "shape":"long",
1100
- "documentation":"<p>Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.</p>"
1101
- }
1102
- },
1103
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
1104
- },
1105
- "GetJobOutputInput":{
1106
- "type":"structure",
1107
- "members":{
1108
- "accountId":{
1109
- "shape":"string",
1110
- "location":"uri",
1111
- "locationName":"accountId",
1112
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1113
- },
1114
- "vaultName":{
1115
- "shape":"string",
1116
- "location":"uri",
1117
- "locationName":"vaultName",
1118
- "documentation":"<p>The name of the vault.</p>"
1119
- },
1120
- "jobId":{
1121
- "shape":"string",
1122
- "location":"uri",
1123
- "locationName":"jobId",
1124
- "documentation":"<p>The job ID whose data is downloaded.</p>"
1125
- },
1126
- "range":{
1127
- "shape":"string",
1128
- "location":"header",
1129
- "locationName":"Range",
1130
- "documentation":"<p>The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify \"Range: bytes=0-1048575\". By default, this operation downloads the entire output. </p>"
1131
- }
1132
- },
1133
- "documentation":"<p>Provides options for downloading output of an Amazon Glacier job.</p>",
1134
- "required":[
1135
- "accountId",
1136
- "vaultName",
1137
- "jobId"
1138
- ]
1139
- },
1140
- "GetJobOutputOutput":{
1141
- "type":"structure",
1142
- "members":{
1143
- "body":{
1144
- "shape":"Stream",
1145
- "documentation":"<p>The job data, either archive data or inventory data.</p>"
1146
- },
1147
- "checksum":{
1148
- "shape":"string",
1149
- "location":"header",
1150
- "locationName":"x-amz-sha256-tree-hash",
1151
- "documentation":"<p> The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions: <ul> <li>You get the entire range of the archive.</li> <li>You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.</li> <li>You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.</li> </ul> </p>"
1152
- },
1153
- "status":{
1154
- "shape":"httpstatus",
1155
- "location":"statusCode",
1156
- "documentation":"<p>The HTTP response code for a job output request. The value depends on whether a range was specified in the request.</p>"
1157
- },
1158
- "contentRange":{
1159
- "shape":"string",
1160
- "location":"header",
1161
- "locationName":"Content-Range",
1162
- "documentation":"<p>The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.</p>"
1163
- },
1164
- "acceptRanges":{
1165
- "shape":"string",
1166
- "location":"header",
1167
- "locationName":"Accept-Ranges",
1168
- "documentation":"<p>Indicates the range units accepted. For more information, go to <a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html\">RFC2616</a>. </p>"
1169
- },
1170
- "contentType":{
1171
- "shape":"string",
1172
- "location":"header",
1173
- "locationName":"Content-Type",
1174
- "documentation":"<p>The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json. </p>"
1175
- },
1176
- "archiveDescription":{
1177
- "shape":"string",
1178
- "location":"header",
1179
- "locationName":"x-amz-archive-description",
1180
- "documentation":"<p>The description of an archive.</p>"
1181
- }
1182
- },
1183
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>",
1184
- "payload":"body"
1185
- },
1186
- "GetVaultNotificationsInput":{
1187
- "type":"structure",
1188
- "members":{
1189
- "accountId":{
1190
- "shape":"string",
1191
- "location":"uri",
1192
- "locationName":"accountId",
1193
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1194
- },
1195
- "vaultName":{
1196
- "shape":"string",
1197
- "location":"uri",
1198
- "locationName":"vaultName",
1199
- "documentation":"<p>The name of the vault.</p>"
1200
- }
1201
- },
1202
- "documentation":"<p>Provides options for retrieving the notification configuration set on an Amazon Glacier vault.</p>",
1203
- "required":[
1204
- "accountId",
1205
- "vaultName"
1206
- ]
1207
- },
1208
- "GetVaultNotificationsOutput":{
1209
- "type":"structure",
1210
- "members":{
1211
- "vaultNotificationConfig":{
1212
- "shape":"VaultNotificationConfig",
1213
- "documentation":"<p>Returns the notification configuration set on the vault.</p>"
1214
- }
1215
- },
1216
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>",
1217
- "payload":"vaultNotificationConfig"
1218
- },
1219
- "GlacierJobDescription":{
1220
- "type":"structure",
1221
- "members":{
1222
- "JobId":{
1223
- "shape":"string",
1224
- "documentation":"<p>An opaque string that identifies an Amazon Glacier job.</p>"
1225
- },
1226
- "JobDescription":{
1227
- "shape":"string",
1228
- "documentation":"<p>The job description you provided when you initiated the job.</p>"
1229
- },
1230
- "Action":{
1231
- "shape":"ActionCode",
1232
- "documentation":"<p>The job type. It is either ArchiveRetrieval or InventoryRetrieval.</p>"
1233
- },
1234
- "ArchiveId":{
1235
- "shape":"string",
1236
- "documentation":"<p>For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.</p>"
1237
- },
1238
- "VaultARN":{
1239
- "shape":"string",
1240
- "documentation":"<p>The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.</p>"
1241
- },
1242
- "CreationDate":{
1243
- "shape":"string",
1244
- "documentation":"<p>The UTC date when the job was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".</p>"
1245
- },
1246
- "Completed":{
1247
- "shape":"boolean",
1248
- "documentation":"<p>The job status. When a job is completed, you get the job's output.</p>"
1249
- },
1250
- "StatusCode":{
1251
- "shape":"StatusCode",
1252
- "documentation":"<p>The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.</p>"
1253
- },
1254
- "StatusMessage":{
1255
- "shape":"string",
1256
- "documentation":"<p>A friendly message that describes the job status.</p>"
1257
- },
1258
- "ArchiveSizeInBytes":{
1259
- "shape":"Size",
1260
- "documentation":"<p>For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.</p>"
1261
- },
1262
- "InventorySizeInBytes":{
1263
- "shape":"Size",
1264
- "documentation":"<p>For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.</p>"
1265
- },
1266
- "SNSTopic":{
1267
- "shape":"string",
1268
- "documentation":"<p>An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.</p>"
1269
- },
1270
- "CompletionDate":{
1271
- "shape":"string",
1272
- "documentation":"<p>The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.</p>"
1273
- },
1274
- "SHA256TreeHash":{
1275
- "shape":"string",
1276
- "documentation":"<p>For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.</p> <p> The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value. </p> <p> For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value. </p> <p> This field is null in the following situations: <ul> <li><p>Archive retrieval jobs that specify a range that is not tree-hash aligned.</p></li> </ul> <ul> <li><p>Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.</p></li> </ul> <ul> <li><p>Inventory jobs.</p></li> </ul> </p>"
1277
- },
1278
- "ArchiveSHA256TreeHash":{
1279
- "shape":"string",
1280
- "documentation":"<p>The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null. </p>"
1281
- },
1282
- "RetrievalByteRange":{
1283
- "shape":"string",
1284
- "documentation":"<p>The retrieved byte range for archive retrieval jobs in the form \"<i>StartByteValue</i>-<i>EndByteValue</i>\" If no range was specified in the archive retrieval, then the whole archive is retrieved and <i>StartByteValue</i> equals 0 and <i>EndByteValue</i> equals the size of the archive minus 1. For inventory retrieval jobs this field is null. </p>"
1285
- },
1286
- "InventoryRetrievalParameters":{
1287
- "shape":"InventoryRetrievalJobDescription",
1288
- "documentation":"<p>Parameters used for range inventory retrieval.</p>"
1289
- }
1290
- },
1291
- "documentation":"<p>Describes an Amazon Glacier job.</p>"
1292
- },
1293
- "InitiateJobInput":{
1294
- "type":"structure",
1295
- "members":{
1296
- "accountId":{
1297
- "shape":"string",
1298
- "location":"uri",
1299
- "locationName":"accountId",
1300
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1301
- },
1302
- "vaultName":{
1303
- "shape":"string",
1304
- "location":"uri",
1305
- "locationName":"vaultName",
1306
- "documentation":"<p>The name of the vault.</p>"
1307
- },
1308
- "jobParameters":{
1309
- "shape":"JobParameters",
1310
- "documentation":"<p>Provides options for specifying job information.</p>"
1311
- }
1312
- },
1313
- "documentation":"<p>Provides options for initiating an Amazon Glacier job.</p>",
1314
- "required":[
1315
- "accountId",
1316
- "vaultName"
1317
- ],
1318
- "payload":"jobParameters"
1319
- },
1320
- "InitiateJobOutput":{
1321
- "type":"structure",
1322
- "members":{
1323
- "location":{
1324
- "shape":"string",
1325
- "location":"header",
1326
- "locationName":"Location",
1327
- "documentation":"<p>The relative URI path of the job.</p>"
1328
- },
1329
- "jobId":{
1330
- "shape":"string",
1331
- "location":"header",
1332
- "locationName":"x-amz-job-id",
1333
- "documentation":"<p>The ID of the job.</p>"
1334
- }
1335
- },
1336
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
1337
- },
1338
- "InitiateMultipartUploadInput":{
1339
- "type":"structure",
1340
- "members":{
1341
- "accountId":{
1342
- "shape":"string",
1343
- "location":"uri",
1344
- "locationName":"accountId",
1345
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1346
- },
1347
- "vaultName":{
1348
- "shape":"string",
1349
- "location":"uri",
1350
- "locationName":"vaultName",
1351
- "documentation":"<p>The name of the vault.</p>"
1352
- },
1353
- "archiveDescription":{
1354
- "shape":"string",
1355
- "location":"header",
1356
- "locationName":"x-amz-archive-description",
1357
- "documentation":"<p>The archive description that you are uploading in parts.</p> <p>The part size must be a megabyte (1024 KB) multiplied by a power of 2—for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).</p>"
1358
- },
1359
- "partSize":{
1360
- "shape":"string",
1361
- "location":"header",
1362
- "locationName":"x-amz-part-size",
1363
- "documentation":"<p>The size of each part except the last, in bytes. The last part can be smaller than this part size.</p>"
1364
- }
1365
- },
1366
- "documentation":"<p>Provides options for initiating a multipart upload to an Amazon Glacier vault.</p>",
1367
- "required":[
1368
- "accountId",
1369
- "vaultName"
1370
- ]
1371
- },
1372
- "InitiateMultipartUploadOutput":{
1373
- "type":"structure",
1374
- "members":{
1375
- "location":{
1376
- "shape":"string",
1377
- "location":"header",
1378
- "locationName":"Location",
1379
- "documentation":"<p>The relative URI path of the multipart upload ID Amazon Glacier created. </p>"
1380
- },
1381
- "uploadId":{
1382
- "shape":"string",
1383
- "location":"header",
1384
- "locationName":"x-amz-multipart-upload-id",
1385
- "documentation":"<p>The ID of the multipart upload. This value is also included as part of the location. </p>"
1386
- }
1387
- },
1388
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
1389
- },
1390
- "InvalidParameterValueException":{
1391
- "type":"structure",
1392
- "members":{
1393
- "type":{
1394
- "shape":"string",
1395
- "documentation":"<p>Client</p>"
1396
- },
1397
- "code":{
1398
- "shape":"string",
1399
- "documentation":"<p>400 Bad Request</p>"
1400
- },
1401
- "message":{"shape":"string"}
1402
- },
1403
- "error":{"httpStatusCode":400},
1404
- "exception":true,
1405
- "documentation":"<p>Returned if a parameter of the request is incorrectly specified. </p>"
1406
- },
1407
- "InventoryRetrievalJobDescription":{
1408
- "type":"structure",
1409
- "members":{
1410
- "Format":{
1411
- "shape":"string",
1412
- "documentation":"<p>The output format for the vault inventory list, which is set by the <b>InitiateJob</b> request when initiating a job to retrieve a vault inventory. Valid values are \"CSV\" and \"JSON\".</p>"
1413
- },
1414
- "StartDate":{
1415
- "shape":"DateTime",
1416
- "documentation":"<p>The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.</p>"
1417
- },
1418
- "EndDate":{
1419
- "shape":"DateTime",
1420
- "documentation":"<p>The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.</p>"
1421
- },
1422
- "Limit":{
1423
- "shape":"string",
1424
- "documentation":"<p>Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a <b>InitiateJob</b> request. </p>"
1425
- },
1426
- "Marker":{
1427
- "shape":"string",
1428
- "documentation":"<p>An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new <b>InitiateJob</b> request to obtain additional inventory items. If there are no more inventory items, this value is <code>null</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html#api-initiate-job-post-vault-inventory-list-filtering\"> Range Inventory Retrieval</a>.</p>"
1429
- }
1430
- },
1431
- "documentation":"<p>Describes the options for a range inventory retrieval job.</p>"
1432
- },
1433
- "InventoryRetrievalJobInput":{
1434
- "type":"structure",
1435
- "members":{
1436
- "StartDate":{
1437
- "shape":"string",
1438
- "documentation":"<p>The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.</p>"
1439
- },
1440
- "EndDate":{
1441
- "shape":"string",
1442
- "documentation":"<p>The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.</p>"
1443
- },
1444
- "Limit":{
1445
- "shape":"string",
1446
- "documentation":"<p>Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.</p>"
1447
- },
1448
- "Marker":{
1449
- "shape":"string",
1450
- "documentation":"<p>An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new <b>InitiateJob</b> request to obtain additional inventory items. If there are no more inventory items, this value is <code>null</code>.</p>"
1451
- }
1452
- },
1453
- "documentation":"<p>Provides options for specifying a range inventory retrieval job.</p>"
1454
- },
1455
- "JobList":{
1456
- "type":"list",
1457
- "member":{"shape":"GlacierJobDescription"}
1458
- },
1459
- "JobParameters":{
1460
- "type":"structure",
1461
- "members":{
1462
- "Format":{
1463
- "shape":"string",
1464
- "documentation":"<p>When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are \"CSV\" and \"JSON\". </p>"
1465
- },
1466
- "Type":{
1467
- "shape":"string",
1468
- "documentation":"<p>The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are \"archive-retrieval\" and \"inventory-retrieval\".</p>"
1469
- },
1470
- "ArchiveId":{
1471
- "shape":"string",
1472
- "documentation":"<p>The ID of the archive that you want to retrieve. This field is required only if <code>Type</code> is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request. </p>"
1473
- },
1474
- "Description":{
1475
- "shape":"string",
1476
- "documentation":"<p>The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.</p>"
1477
- },
1478
- "SNSTopic":{
1479
- "shape":"string",
1480
- "documentation":"<p>The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.</p>"
1481
- },
1482
- "RetrievalByteRange":{
1483
- "shape":"string",
1484
- "documentation":"<p>The byte range to retrieve for an archive retrieval. in the form \"<i>StartByteValue</i>-<i>EndByteValue</i>\" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that <i>StartByteValue</i> must be divisible by 1 MB and <i>EndByteValue</i> plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response. </p> <p>An error occurs if you specify this field for an inventory retrieval job request. </p>"
1485
- },
1486
- "InventoryRetrievalParameters":{
1487
- "shape":"InventoryRetrievalJobInput",
1488
- "documentation":"<p>Input parameters used for range inventory retrieval.</p>"
1489
- }
1490
- },
1491
- "documentation":"<p>Provides options for defining a job.</p>"
1492
- },
1493
- "LimitExceededException":{
1494
- "type":"structure",
1495
- "members":{
1496
- "type":{
1497
- "shape":"string",
1498
- "documentation":"<p>Client</p>"
1499
- },
1500
- "code":{
1501
- "shape":"string",
1502
- "documentation":"<p>400 Bad Request</p>"
1503
- },
1504
- "message":{"shape":"string"}
1505
- },
1506
- "error":{"httpStatusCode":400},
1507
- "exception":true,
1508
- "documentation":"<p>Returned if the request results in a vault or account limit being exceeded.</p>"
1509
- },
1510
- "ListJobsInput":{
1511
- "type":"structure",
1512
- "members":{
1513
- "accountId":{
1514
- "shape":"string",
1515
- "location":"uri",
1516
- "locationName":"accountId",
1517
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1518
- },
1519
- "vaultName":{
1520
- "shape":"string",
1521
- "location":"uri",
1522
- "locationName":"vaultName",
1523
- "documentation":"<p>The name of the vault.</p>"
1524
- },
1525
- "limit":{
1526
- "shape":"string",
1527
- "location":"querystring",
1528
- "locationName":"limit",
1529
- "documentation":"<p>Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.</p>"
1530
- },
1531
- "marker":{
1532
- "shape":"string",
1533
- "location":"querystring",
1534
- "locationName":"marker",
1535
- "documentation":"<p>An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.</p>"
1536
- },
1537
- "statuscode":{
1538
- "shape":"string",
1539
- "location":"querystring",
1540
- "locationName":"statuscode",
1541
- "documentation":"<p>Specifies the type of job status to return. You can specify the following values: \"InProgress\", \"Succeeded\", or \"Failed\".</p>"
1542
- },
1543
- "completed":{
1544
- "shape":"string",
1545
- "location":"querystring",
1546
- "locationName":"completed",
1547
- "documentation":"<p>Specifies the state of the jobs to return. You can specify <code>true</code> or <code>false</code>.</p>"
1548
- }
1549
- },
1550
- "documentation":"<p>Provides options for retrieving a job list for an Amazon Glacier vault.</p>",
1551
- "required":[
1552
- "accountId",
1553
- "vaultName"
1554
- ]
1555
- },
1556
- "ListJobsOutput":{
1557
- "type":"structure",
1558
- "members":{
1559
- "JobList":{
1560
- "shape":"JobList",
1561
- "documentation":"<p>A list of job objects. Each job object contains metadata describing the job. </p>"
1562
- },
1563
- "Marker":{
1564
- "shape":"string",
1565
- "documentation":"<p>An opaque string that represents where to continue pagination of the results. You use this value in a new List Jobs request to obtain more jobs in the list. If there are no more jobs, this value is <code>null</code>. </p>"
1566
- }
1567
- },
1568
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
1569
- },
1570
- "ListMultipartUploadsInput":{
1571
- "type":"structure",
1572
- "members":{
1573
- "accountId":{
1574
- "shape":"string",
1575
- "location":"uri",
1576
- "locationName":"accountId",
1577
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1578
- },
1579
- "vaultName":{
1580
- "shape":"string",
1581
- "location":"uri",
1582
- "locationName":"vaultName",
1583
- "documentation":"<p>The name of the vault.</p>"
1584
- },
1585
- "marker":{
1586
- "shape":"string",
1587
- "location":"querystring",
1588
- "locationName":"marker",
1589
- "documentation":"<p>An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.</p>"
1590
- },
1591
- "limit":{
1592
- "shape":"string",
1593
- "location":"querystring",
1594
- "locationName":"limit",
1595
- "documentation":"<p>Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.</p>"
1596
- }
1597
- },
1598
- "documentation":"<p>Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.</p>",
1599
- "required":[
1600
- "accountId",
1601
- "vaultName"
1602
- ]
1603
- },
1604
- "ListMultipartUploadsOutput":{
1605
- "type":"structure",
1606
- "members":{
1607
- "UploadsList":{
1608
- "shape":"UploadsList",
1609
- "documentation":"<p>A list of in-progress multipart uploads.</p>"
1610
- },
1611
- "Marker":{
1612
- "shape":"string",
1613
- "documentation":"<p>An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is <code>null</code>.</p>"
1614
- }
1615
- },
1616
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
1617
- },
1618
- "ListPartsInput":{
1619
- "type":"structure",
1620
- "members":{
1621
- "accountId":{
1622
- "shape":"string",
1623
- "location":"uri",
1624
- "locationName":"accountId",
1625
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1626
- },
1627
- "vaultName":{
1628
- "shape":"string",
1629
- "location":"uri",
1630
- "locationName":"vaultName",
1631
- "documentation":"<p>The name of the vault.</p>"
1632
- },
1633
- "uploadId":{
1634
- "shape":"string",
1635
- "location":"uri",
1636
- "locationName":"uploadId",
1637
- "documentation":"<p>The upload ID of the multipart upload.</p>"
1638
- },
1639
- "marker":{
1640
- "shape":"string",
1641
- "location":"querystring",
1642
- "locationName":"marker",
1643
- "documentation":"<p>An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.</p>"
1644
- },
1645
- "limit":{
1646
- "shape":"string",
1647
- "location":"querystring",
1648
- "locationName":"limit",
1649
- "documentation":"<p>Specifies the maximum number of parts returned in the response body. If this value is not specified, the List Parts operation returns up to 1,000 uploads.</p>"
1650
- }
1651
- },
1652
- "documentation":"<p>Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.</p>",
1653
- "required":[
1654
- "accountId",
1655
- "vaultName",
1656
- "uploadId"
1657
- ]
1658
- },
1659
- "ListPartsOutput":{
1660
- "type":"structure",
1661
- "members":{
1662
- "MultipartUploadId":{
1663
- "shape":"string",
1664
- "documentation":"<p>The ID of the upload to which the parts are associated.</p>"
1665
- },
1666
- "VaultARN":{
1667
- "shape":"string",
1668
- "documentation":"<p>The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.</p>"
1669
- },
1670
- "ArchiveDescription":{
1671
- "shape":"string",
1672
- "documentation":"<p>The description of the archive that was specified in the Initiate Multipart Upload request.</p>"
1673
- },
1674
- "PartSizeInBytes":{
1675
- "shape":"long",
1676
- "documentation":"<p>The part size in bytes.</p>"
1677
- },
1678
- "CreationDate":{
1679
- "shape":"string",
1680
- "documentation":"<p>The UTC time at which the multipart upload was initiated.</p>"
1681
- },
1682
- "Parts":{
1683
- "shape":"PartList",
1684
- "documentation":"<p>A list of the part sizes of the multipart upload.</p>"
1685
- },
1686
- "Marker":{
1687
- "shape":"string",
1688
- "documentation":"<p>An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is <code>null</code>.</p>"
1689
- }
1690
- },
1691
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
1692
- },
1693
- "ListVaultsInput":{
1694
- "type":"structure",
1695
- "members":{
1696
- "accountId":{
1697
- "shape":"string",
1698
- "location":"uri",
1699
- "locationName":"accountId",
1700
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1701
- },
1702
- "marker":{
1703
- "shape":"string",
1704
- "location":"querystring",
1705
- "locationName":"marker",
1706
- "documentation":"<p>A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.</p>"
1707
- },
1708
- "limit":{
1709
- "shape":"string",
1710
- "location":"querystring",
1711
- "locationName":"limit",
1712
- "documentation":"<p>The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.</p>"
1713
- }
1714
- },
1715
- "documentation":"<p>Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.</p>",
1716
- "required":["accountId"]
1717
- },
1718
- "ListVaultsOutput":{
1719
- "type":"structure",
1720
- "members":{
1721
- "VaultList":{
1722
- "shape":"VaultList",
1723
- "documentation":"<p>List of vaults.</p>"
1724
- },
1725
- "Marker":{
1726
- "shape":"string",
1727
- "documentation":"<p>The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.</p>"
1728
- }
1729
- },
1730
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
1731
- },
1732
- "MissingParameterValueException":{
1733
- "type":"structure",
1734
- "members":{
1735
- "type":{
1736
- "shape":"string",
1737
- "documentation":"<p>Client.</p>"
1738
- },
1739
- "code":{
1740
- "shape":"string",
1741
- "documentation":"<p>400 Bad Request</p>"
1742
- },
1743
- "message":{"shape":"string"}
1744
- },
1745
- "error":{"httpStatusCode":400},
1746
- "exception":true,
1747
- "documentation":"<p>Returned if a required header or parameter is missing from the request.</p>"
1748
- },
1749
- "NotificationEventList":{
1750
- "type":"list",
1751
- "member":{"shape":"string"}
1752
- },
1753
- "PartList":{
1754
- "type":"list",
1755
- "member":{"shape":"PartListElement"}
1756
- },
1757
- "PartListElement":{
1758
- "type":"structure",
1759
- "members":{
1760
- "RangeInBytes":{
1761
- "shape":"string",
1762
- "documentation":"<p>The byte range of a part, inclusive of the upper value of the range.</p>"
1763
- },
1764
- "SHA256TreeHash":{
1765
- "shape":"string",
1766
- "documentation":"<p>The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never <code>null</code>.</p>"
1767
- }
1768
- },
1769
- "documentation":"<p>A list of the part sizes of the multipart upload.</p>"
1770
- },
1771
- "RequestTimeoutException":{
1772
- "type":"structure",
1773
- "members":{
1774
- "type":{
1775
- "shape":"string",
1776
- "documentation":"<p>Client</p>"
1777
- },
1778
- "code":{
1779
- "shape":"string",
1780
- "documentation":"<p>408 Request Timeout</p>"
1781
- },
1782
- "message":{"shape":"string"}
1783
- },
1784
- "error":{"httpStatusCode":408},
1785
- "exception":true,
1786
- "documentation":"<p>Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.</p>"
1787
- },
1788
- "ResourceNotFoundException":{
1789
- "type":"structure",
1790
- "members":{
1791
- "type":{
1792
- "shape":"string",
1793
- "documentation":"<p>Client</p>"
1794
- },
1795
- "code":{
1796
- "shape":"string",
1797
- "documentation":"<p>404 Not Found</p>"
1798
- },
1799
- "message":{"shape":"string"}
1800
- },
1801
- "error":{"httpStatusCode":404},
1802
- "exception":true,
1803
- "documentation":"<p>Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.</p>"
1804
- },
1805
- "ServiceUnavailableException":{
1806
- "type":"structure",
1807
- "members":{
1808
- "type":{
1809
- "shape":"string",
1810
- "documentation":"<p>Server</p>"
1811
- },
1812
- "code":{
1813
- "shape":"string",
1814
- "documentation":"<p>500 Internal Server Error</p>"
1815
- },
1816
- "message":{"shape":"string"}
1817
- },
1818
- "error":{"httpStatusCode":500},
1819
- "exception":true,
1820
- "documentation":"<p>Returned if the service cannot complete the request.</p>"
1821
- },
1822
- "SetVaultNotificationsInput":{
1823
- "type":"structure",
1824
- "members":{
1825
- "accountId":{
1826
- "shape":"string",
1827
- "location":"uri",
1828
- "locationName":"accountId",
1829
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1830
- },
1831
- "vaultName":{
1832
- "shape":"string",
1833
- "location":"uri",
1834
- "locationName":"vaultName",
1835
- "documentation":"<p>The name of the vault.</p>"
1836
- },
1837
- "vaultNotificationConfig":{
1838
- "shape":"VaultNotificationConfig",
1839
- "documentation":"<p>Provides options for specifying notification configuration.</p>"
1840
- }
1841
- },
1842
- "documentation":"<p>Provides options to configure notifications that will be sent when specific events happen to a vault.</p>",
1843
- "required":[
1844
- "accountId",
1845
- "vaultName"
1846
- ],
1847
- "payload":"vaultNotificationConfig"
1848
- },
1849
- "Size":{"type":"long"},
1850
- "StatusCode":{
1851
- "type":"string",
1852
- "enum":[
1853
- "InProgress",
1854
- "Succeeded",
1855
- "Failed"
1856
- ]
1857
- },
1858
- "Stream":{
1859
- "type":"blob",
1860
- "streaming":true
1861
- },
1862
- "UploadArchiveInput":{
1863
- "type":"structure",
1864
- "members":{
1865
- "vaultName":{
1866
- "shape":"string",
1867
- "location":"uri",
1868
- "locationName":"vaultName",
1869
- "documentation":"<p>The name of the vault.</p>"
1870
- },
1871
- "accountId":{
1872
- "shape":"string",
1873
- "location":"uri",
1874
- "locationName":"accountId",
1875
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1876
- },
1877
- "archiveDescription":{
1878
- "shape":"string",
1879
- "location":"header",
1880
- "locationName":"x-amz-archive-description",
1881
- "documentation":"<p>The optional description of the archive you are uploading. </p>"
1882
- },
1883
- "checksum":{
1884
- "shape":"string",
1885
- "location":"header",
1886
- "locationName":"x-amz-sha256-tree-hash",
1887
- "documentation":"<p>The SHA256 checksum (a linear hash) of the payload.</p>"
1888
- },
1889
- "body":{
1890
- "shape":"Stream",
1891
- "documentation":"<p>The data to upload.</p>"
1892
- }
1893
- },
1894
- "documentation":"<p>Provides options to add an archive to a vault.</p>",
1895
- "required":[
1896
- "vaultName",
1897
- "accountId"
1898
- ],
1899
- "payload":"body"
1900
- },
1901
- "UploadListElement":{
1902
- "type":"structure",
1903
- "members":{
1904
- "MultipartUploadId":{
1905
- "shape":"string",
1906
- "documentation":"<p>The ID of a multipart upload.</p>"
1907
- },
1908
- "VaultARN":{
1909
- "shape":"string",
1910
- "documentation":"<p>The Amazon Resource Name (ARN) of the vault that contains the archive.</p>"
1911
- },
1912
- "ArchiveDescription":{
1913
- "shape":"string",
1914
- "documentation":"<p>The description of the archive that was specified in the Initiate Multipart Upload request.</p>"
1915
- },
1916
- "PartSizeInBytes":{
1917
- "shape":"long",
1918
- "documentation":"<p>The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.</p>"
1919
- },
1920
- "CreationDate":{
1921
- "shape":"string",
1922
- "documentation":"<p>The UTC time at which the multipart upload was initiated.</p>"
1923
- }
1924
- },
1925
- "documentation":"<p>A list of in-progress multipart uploads for a vault.</p>"
1926
- },
1927
- "UploadMultipartPartInput":{
1928
- "type":"structure",
1929
- "members":{
1930
- "accountId":{
1931
- "shape":"string",
1932
- "location":"uri",
1933
- "locationName":"accountId",
1934
- "documentation":"<p>The <code>AccountId</code> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </p>"
1935
- },
1936
- "vaultName":{
1937
- "shape":"string",
1938
- "location":"uri",
1939
- "locationName":"vaultName",
1940
- "documentation":"<p>The name of the vault.</p>"
1941
- },
1942
- "uploadId":{
1943
- "shape":"string",
1944
- "location":"uri",
1945
- "locationName":"uploadId",
1946
- "documentation":"<p>The upload ID of the multipart upload.</p>"
1947
- },
1948
- "checksum":{
1949
- "shape":"string",
1950
- "location":"header",
1951
- "locationName":"x-amz-sha256-tree-hash",
1952
- "documentation":"<p>The SHA256 tree hash of the data being uploaded. </p>"
1953
- },
1954
- "range":{
1955
- "shape":"string",
1956
- "location":"header",
1957
- "locationName":"Content-Range",
1958
- "documentation":"<p>Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.</p>"
1959
- },
1960
- "body":{
1961
- "shape":"Stream",
1962
- "documentation":"<p>The data to upload.</p>"
1963
- }
1964
- },
1965
- "documentation":"<p>Provides options to upload a part of an archive in a multipart upload operation.</p>",
1966
- "required":[
1967
- "accountId",
1968
- "vaultName",
1969
- "uploadId"
1970
- ],
1971
- "payload":"body"
1972
- },
1973
- "UploadMultipartPartOutput":{
1974
- "type":"structure",
1975
- "members":{
1976
- "checksum":{
1977
- "shape":"string",
1978
- "location":"header",
1979
- "locationName":"x-amz-sha256-tree-hash",
1980
- "documentation":"<p>The SHA256 tree hash that Amazon Glacier computed for the uploaded part.</p>"
1981
- }
1982
- },
1983
- "documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
1984
- },
1985
- "UploadsList":{
1986
- "type":"list",
1987
- "member":{"shape":"UploadListElement"}
1988
- },
1989
- "VaultList":{
1990
- "type":"list",
1991
- "member":{"shape":"DescribeVaultOutput"}
1992
- },
1993
- "VaultNotificationConfig":{
1994
- "type":"structure",
1995
- "members":{
1996
- "SNSTopic":{
1997
- "shape":"string",
1998
- "documentation":"<p>The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).</p>"
1999
- },
2000
- "Events":{
2001
- "shape":"NotificationEventList",
2002
- "documentation":"<p>A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.</p>"
2003
- }
2004
- },
2005
- "documentation":"<p>Represents a vault's notification configuration.</p>"
2006
- },
2007
- "boolean":{"type":"boolean"},
2008
- "httpstatus":{"type":"integer"},
2009
- "long":{"type":"long"},
2010
- "string":{"type":"string"}
2011
- }
2012
- }