aws-sdk-core 2.0.0.rc3 → 2.0.0.rc4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/apis/AutoScaling-2011-01-01.json +83 -3
- data/apis/Glacier-2012-06-01.json +22 -0
- data/apis/Support-2013-04-15.json +0 -2
- data/apis/source/autoscaling-2011-01-01.json +203 -80
- data/apis/source/glacier-2012-06-01.json +58 -31
- data/apis/source/support-2013-04-15.json +190 -192
- data/lib/aws/error_handler.rb +3 -3
- data/lib/aws/errors.rb +5 -11
- data/lib/aws/plugins/glacier_checksums.rb +1 -1
- data/lib/aws/plugins/s3_complete_multipart_upload_fix.rb +1 -1
- data/lib/aws/signers/base.rb +1 -1
- data/lib/aws/signers/s3.rb +1 -1
- data/lib/aws/signers/v4.rb +2 -2
- data/lib/aws/tree_hash.rb +2 -2
- data/lib/aws/version.rb +1 -1
- data/spec/aws/service_spec.rb +16 -2
- metadata +2 -2
@@ -5,7 +5,7 @@
|
|
5
5
|
"checksum_format": "sha256",
|
6
6
|
"service_full_name": "Amazon Glacier",
|
7
7
|
"endpoint_prefix": "glacier",
|
8
|
-
"documentation": "\n <p>Amazon Glacier is a storage solution for \"cold data.\"</p>\n\n <p>Amazon Glacier is an extremely low-cost storage service that provides secure, durable
|
8
|
+
"documentation": "\n <p>Amazon Glacier is a storage solution for \"cold data.\"</p>\n\n <p>Amazon Glacier is an extremely low-cost storage service that provides secure, durable and\n\t\teasy-to-use storage for data backup and archival. With Amazon Glacier, customers can store\n\t\ttheir data cost effectively for months, years, or decades. Amazon Glacier also enables\n\t\tcustomers to offload the administrative burdens of operating and scaling storage to AWS, so\n\t\tthey don't have to worry about capacity planning, hardware provisioning, data replication,\n\t\thardware failure and recovery, or time-consuming hardware migrations.</p>\n\n <p>Amazon Glacier is a great storage choice when low storage cost is paramount, your data is\n\t\trarely retrieved, and retrieval latency of several hours is acceptable. If your application\n\t\trequires fast or frequent access to your data, consider using Amazon S3. For more\n\t\tinformation, go to <a href=\"http://aws.amazon.com/s3/\">Amazon Simple Storage Service (Amazon S3)</a>.</p>\n\n <p>You can store any kind of data in any format. There is no maximum limit on the total amount\n\t\tof data you can store in Amazon Glacier. </p>\n\n <p>If you are a first-time user of Amazon Glacier, we recommend that you begin \n by reading the following sections in the <i>Amazon Glacier Developer Guide</i>:</p>\n <ul>\n <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 \n describes the underlying data model, the operations it supports, \n and the AWS SDKs that you can use to interact with the service.</p></li>\n <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 \n Started section walks you through the process of creating a vault, \n uploading archives, creating jobs to download archives, \n retrieving the job output, and deleting archives.</p></li>\n </ul>\n ",
|
9
9
|
"operations": {
|
10
10
|
"AbortMultipartUpload": {
|
11
11
|
"name": "AbortMultipartUpload",
|
@@ -37,7 +37,7 @@
|
|
37
37
|
"location": "uri"
|
38
38
|
}
|
39
39
|
},
|
40
|
-
"documentation": "\n <p>Provides options to abort a multipart upload identified by the upload ID. </p>\n \n <p>For information about the underlying REST API, go to \n <a href=\"http://docs.
|
40
|
+
"documentation": "\n <p>Provides options to abort a multipart upload identified by the upload ID. </p>\n \n <p>For information about the underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html\">Abort Multipart Upload</a>. \n 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>\n "
|
41
41
|
},
|
42
42
|
"output": null,
|
43
43
|
"errors": [
|
@@ -130,7 +130,7 @@
|
|
130
130
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
131
131
|
}
|
132
132
|
],
|
133
|
-
"documentation": "\n\t <p>This operation aborts a multipart upload identified by the upload ID.</p>\n \n\n\t\t<p>After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the\n\t\t\tmultipart upload or complete the multipart upload. Aborting a completed upload fails.\n\t\t\tHowever, aborting an already-aborted upload will succeed, for a short time. For more\n\t\t\tinformation about uploading a part and completing a multipart upload, see <a>
|
133
|
+
"documentation": "\n\t <p>This operation aborts a multipart upload identified by the upload ID.</p>\n \n\n\t\t<p>After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the\n\t\t\tmultipart upload or complete the multipart upload. Aborting a completed upload fails.\n\t\t\tHowever, aborting an already-aborted upload will succeed, for a short time. For more\n\t\t\tinformation about uploading a part and completing a multipart upload, see <a>UploadMultipartPart</a> and <a>CompleteMultipartUpload</a>.</p>\n\n\t\t<p>This operation is idempotent.</p>\n\n\t\t<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>\n <p> For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> \n and \n <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>.\n </p>\n "
|
134
134
|
},
|
135
135
|
"CompleteMultipartUpload": {
|
136
136
|
"name": "CompleteMultipartUpload",
|
@@ -204,7 +204,7 @@
|
|
204
204
|
"location_name": "x-amz-archive-id"
|
205
205
|
}
|
206
206
|
},
|
207
|
-
"documentation": "\n <p>Contains the Amazon Glacier response to your request.</p>\n <p>For information about the underlying REST API, go to \n <a href=\"http://docs.
|
207
|
+
"documentation": "\n <p>Contains the Amazon Glacier response to your request.</p>\n <p>For information about the underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html\">Upload Archive</a>. \n 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>\n "
|
208
208
|
},
|
209
209
|
"errors": [
|
210
210
|
{
|
@@ -296,7 +296,7 @@
|
|
296
296
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
297
297
|
}
|
298
298
|
],
|
299
|
-
"documentation": "\n\t\t<p>You call this operation to inform Amazon Glacier that all the archive parts have been uploaded\n\t\t\tand that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and\n\t\t\tsaving the archive to the vault, Amazon Glacier returns the URI path of the newly created\n\t\t\tarchive resource. Using the URI path, you can then access the archive. After you upload\n\t\t\tan archive, you should save the archive ID returned to retrieve the archive at a later\n\t\t\tpoint. You can also get the vault inventory to obtain a list of archive IDs in a vault.\n\t\t\tFor more information, see <a>InitiateJob</a>.</p>\n\n\t\t<p>In the request, you must include the computed SHA256 tree hash of the entire archive you\n\t\t\thave uploaded. For information about computing a SHA256 tree hash, see <a href=\"http://docs.
|
299
|
+
"documentation": "\n\t\t<p>You call this operation to inform Amazon Glacier that all the archive parts have been uploaded\n\t\t\tand that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and\n\t\t\tsaving the archive to the vault, Amazon Glacier returns the URI path of the newly created\n\t\t\tarchive resource. Using the URI path, you can then access the archive. After you upload\n\t\t\tan archive, you should save the archive ID returned to retrieve the archive at a later\n\t\t\tpoint. You can also get the vault inventory to obtain a list of archive IDs in a vault.\n\t\t\tFor more information, see <a>InitiateJob</a>.</p>\n\n\t\t<p>In the request, you must include the computed SHA256 tree hash of the entire archive you\n\t\t\thave 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\n\t\t\tside, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the\n\t\t\tvalues match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error,\n\t\t\tand the operation fails. The <a>ListParts</a> operation returns a list of parts uploaded for\n\t\t\ta specific multipart upload. It includes checksum information for each uploaded part\n\t\t\tthat can be used to debug a bad checksum issue.</p>\n \n\t\t<p>Additionally, Amazon Glacier also checks for any missing content ranges when assembling the\n\t\t\tarchive, if missing content ranges are found, Amazon Glacier returns an error and the\n\t\t\toperation fails. </p>\n\n\t\t<p>Complete Multipart Upload is an idempotent operation. After your first successful complete\n\t\t\tmultipart upload, if you call the operation again within a short period, the operation\n\t\t\twill succeed and return the same archive ID. This is useful in the event you experience\n\t\t\ta network issue that causes an aborted connection or receive a 500 server error, in\n\t\t\twhich case you can repeat your Complete Multipart Upload request and get the same\n\t\t\tarchive ID without creating duplicate archives. Note, however, that after the multipart\n\t\t\tupload completes, you cannot call the List Parts operation and the multipart upload will\n\t\t\tnot appear in List Multipart Uploads response, even if idempotent complete is\n\t\t\tpossible.</p>\n\n\t\t<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>\n <p> For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> \n and \n <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>.\n </p> \n "
|
300
300
|
},
|
301
301
|
"CreateVault": {
|
302
302
|
"name": "CreateVault",
|
@@ -322,7 +322,7 @@
|
|
322
322
|
"location": "uri"
|
323
323
|
}
|
324
324
|
},
|
325
|
-
"documentation":
|
325
|
+
"documentation": "\n <p>Provides options to create a vault.</p>\n "
|
326
326
|
},
|
327
327
|
"output": {
|
328
328
|
"shape_name": "CreateVaultOutput",
|
@@ -428,7 +428,7 @@
|
|
428
428
|
"documentation": "\n <p>Returned if the request results in a vault or account limit being exceeded.</p>\n "
|
429
429
|
}
|
430
430
|
],
|
431
|
-
"documentation": "\n\t\t<p>This operation creates a new vault with the specified name. The name of the vault must be\n\t\t\tunique within a region for an AWS account. You can create up to 1,000 vaults per\n\t\t\taccount. If you need to create more vaults, contact Amazon Glacier.</p>\n\t\t<p>You must use the following guidelines when naming a vault. </p>\n\t\t<p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p> Names can be between 1 and 255 characters long. </p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen),\n\t\t\t\t\t\tand '.' (period).</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t</p>\n\t\t\n <p>This operation is idempotent.</p>\n\n\t\t<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.
|
431
|
+
"documentation": "\n\t\t<p>This operation creates a new vault with the specified name. The name of the vault must be\n\t\t\tunique within a region for an AWS account. You can create up to 1,000 vaults per\n\t\t\taccount. If you need to create more vaults, contact Amazon Glacier.</p>\n\t\t<p>You must use the following guidelines when naming a vault. </p>\n\t\t<p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p> Names can be between 1 and 255 characters long. </p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen),\n\t\t\t\t\t\tand '.' (period).</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t</p>\n\t\t\n <p>This operation is idempotent.</p>\n\n\t\t<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>\n <p> For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html\">Creating a Vault in Amazon Glacier</a> \n and \n <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>.\n </p>\n "
|
432
432
|
},
|
433
433
|
"DeleteArchive": {
|
434
434
|
"name": "DeleteArchive",
|
@@ -553,7 +553,7 @@
|
|
553
553
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
554
554
|
}
|
555
555
|
],
|
556
|
-
"documentation": "\n\t\t<p>This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval\n\t\t\tof this archive will fail. Archive retrievals that are in progress for this archive ID\n\t\t\tmay or may not succeed according to the following scenarios:</p>\n\t \t<ul>\n\t\t\t<li>If the archive retrieval job is actively preparing the data for download when Amazon\n\t\t\t\t\t\tGlacier receives the delete archive request, the archival retrieval\n\t\t\t\t\t\toperation might fail.\n\t\t\t</li>\n\t\t\t<li>If the archive retrieval job has successfully prepared the archive for download when\n\t\t\t\t\t\tAmazon Glacier receives the delete archive request, you will be able to\n\t\t\t\t\t\tdownload the output.\n\t\t\t</li>\n\t\t</ul>\n\n\t\t<p>This operation is idempotent. Attempting to delete an already-deleted archive does not\n\t\t\tresult in an error. </p>\n\n\t\t<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.
|
556
|
+
"documentation": "\n\t\t<p>This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval\n\t\t\tof this archive will fail. Archive retrievals that are in progress for this archive ID\n\t\t\tmay or may not succeed according to the following scenarios:</p>\n\t \t<ul>\n\t\t\t<li>If the archive retrieval job is actively preparing the data for download when Amazon\n\t\t\t\t\t\tGlacier receives the delete archive request, the archival retrieval\n\t\t\t\t\t\toperation might fail.\n\t\t\t</li>\n\t\t\t<li>If the archive retrieval job has successfully prepared the archive for download when\n\t\t\t\t\t\tAmazon Glacier receives the delete archive request, you will be able to\n\t\t\t\t\t\tdownload the output.\n\t\t\t</li>\n\t\t</ul>\n\n\t\t<p>This operation is idempotent. Attempting to delete an already-deleted archive does not\n\t\t\tresult in an error. </p>\n\n\t\t<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>\n <p> For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html\">Deleting an Archive in Amazon Glacier</a> \n and \n <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>.\n </p> \n "
|
557
557
|
},
|
558
558
|
"DeleteVault": {
|
559
559
|
"name": "DeleteVault",
|
@@ -672,7 +672,7 @@
|
|
672
672
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
673
673
|
}
|
674
674
|
],
|
675
|
-
"documentation": "\n\t\t<p>This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives\n\t\t\tin the vault as of the last inventory and there have been no writes to the vault since\n\t\t\tthe last inventory. If either of these conditions is not satisfied, the vault deletion\n\t\t\tfails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use\n\t\t\t\t<a>DescribeVault</a> to return the number of\n\t\t\tarchives in a vault, and you can use <a href=\"http://docs.
|
675
|
+
"documentation": "\n\t\t<p>This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives\n\t\t\tin the vault as of the last inventory and there have been no writes to the vault since\n\t\t\tthe last inventory. If either of these conditions is not satisfied, the vault deletion\n\t\t\tfails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use\n\t\t\t\t<a>DescribeVault</a> to return the number of\n\t\t\tarchives 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\n\t\t\tvault. 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>\n\n\t\t<p>This operation is idempotent.</p>\n\n\t\t<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>\n <p> For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html\">Deleting a Vault in Amazon Glacier</a> \n and \n <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>.\n </p>\n "
|
676
676
|
},
|
677
677
|
"DeleteVaultNotifications": {
|
678
678
|
"name": "DeleteVaultNotifications",
|
@@ -791,7 +791,7 @@
|
|
791
791
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
792
792
|
}
|
793
793
|
],
|
794
|
-
"documentation": "\n\t <p>This operation deletes the notification configuration set for a vault. The operation is\n\t\t\teventually consistent;that is, it might take some time for Amazon Glacier to\n\t\t\tcompletely disable the notifications and you might still receive some notifications for\n\t\t\ta short time after you send the delete request. </p>\n\n\t\t<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.
|
794
|
+
"documentation": "\n\t <p>This operation deletes the notification configuration set for a vault. The operation is\n\t\t\teventually consistent;that is, it might take some time for Amazon Glacier to\n\t\t\tcompletely disable the notifications and you might still receive some notifications for\n\t\t\ta short time after you send the delete request. </p>\n\n\t\t<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>\n <p> For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> \n and \n <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.\n </p> \n "
|
795
795
|
},
|
796
796
|
"DescribeJob": {
|
797
797
|
"name": "DescribeJob",
|
@@ -905,17 +905,17 @@
|
|
905
905
|
"SHA256TreeHash": {
|
906
906
|
"shape_name": "string",
|
907
907
|
"type": "string",
|
908
|
-
"documentation": "\n <p>For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.</p>\n "
|
908
|
+
"documentation": "\n <p>For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.</p>\n <p>\n The SHA256 tree hash value for the requested range of an archive. \n If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field \n returns a value. </p>\n <p> \n For the specific case when the whole archive is retrieved, this value is the \n same as the ArchiveSHA256TreeHash value. </p>\n <p>\n This field is null in the following situations:\n <ul>\n <li><p>Archive retrieval jobs that specify a range that is not tree-hash aligned.</p></li>\n </ul> \n <ul>\n <li><p>Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.</p></li>\n </ul> \n <ul>\n <li><p>Inventory jobs.</p></li>\n </ul> \n </p>\n "
|
909
909
|
},
|
910
910
|
"ArchiveSHA256TreeHash": {
|
911
911
|
"shape_name": "string",
|
912
912
|
"type": "string",
|
913
|
-
"documentation": null
|
913
|
+
"documentation": "\n <p>The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.\n </p>\n "
|
914
914
|
},
|
915
915
|
"RetrievalByteRange": {
|
916
916
|
"shape_name": "string",
|
917
917
|
"type": "string",
|
918
|
-
"documentation": null
|
918
|
+
"documentation": "\n <p>The retrieved byte range for archive retrieval jobs in the form \"<i>StartByteValue</i>-<i>EndByteValue</i>\" \n If no range was specified in the archive retrieval, then the whole archive is retrieved and \n <i>StartByteValue</i> equals 0 and <i>EndByteValue</i> equals the size of the archive minus 1. \n For inventory retrieval jobs this field is null. </p> \n "
|
919
919
|
}
|
920
920
|
},
|
921
921
|
"documentation": "\n <p>Describes an Amazon Glacier job.</p>\n "
|
@@ -1010,7 +1010,7 @@
|
|
1010
1010
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
1011
1011
|
}
|
1012
1012
|
],
|
1013
|
-
"documentation": "\n\t <p>This operation returns information about a job you previously initiated, including the job\n\t\t\tinitiation date, the user who initiated the job, the job status code/message and the\n\t\t\tAmazon SNS topic to notify after Amazon Glacier completes the job. For more information about\n\t\t\tinitiating a job, see <a>InitiateJob</a>. </p>\n\n\t\t<note><p>This operation enables you to check the status of your job. However, it is\n\t\t\t\t\tstrongly recommended that you set up an Amazon SNS topic and specify it in your\n\t\t\t\t\tinitiate job request so that Amazon Glacier can notify the topic after it completes\n\t\t\t\t\tthe job. </p></note>\n\n <p>A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. </p>\n\n\t\t<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.
|
1013
|
+
"documentation": "\n\t <p>This operation returns information about a job you previously initiated, including the job\n\t\t\tinitiation date, the user who initiated the job, the job status code/message and the\n\t\t\tAmazon SNS topic to notify after Amazon Glacier completes the job. For more information about\n\t\t\tinitiating a job, see <a>InitiateJob</a>. </p>\n\n\t\t<note><p>This operation enables you to check the status of your job. However, it is\n\t\t\t\t\tstrongly recommended that you set up an Amazon SNS topic and specify it in your\n\t\t\t\t\tinitiate job request so that Amazon Glacier can notify the topic after it completes\n\t\t\t\t\tthe job. </p></note>\n\n <p>A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. </p>\n\n\t\t<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>\n \n <p> For information about the underlying REST API, go to \n <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>.\n </p>\n \n "
|
1014
1014
|
},
|
1015
1015
|
"DescribeVault": {
|
1016
1016
|
"name": "DescribeVault",
|
@@ -1164,7 +1164,7 @@
|
|
1164
1164
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
1165
1165
|
}
|
1166
1166
|
],
|
1167
|
-
"documentation": "\n\t\t<p>This operation returns information about a vault, including the vault's Amazon Resource Name\n\t\t\t(ARN), the date the vault was created, the number of archives it contains, \n\t\t\tand the total size of all the archives in the vault. The number of archives and\n\t\t\ttheir total size are as of the last inventory generation. This means that if you add or\n\t\t\tremove an archive from a vault, and then immediately use Describe Vault, the change in\n\t\t\tcontents will not be immediately reflected. If you want to retrieve the latest inventory\n\t\t\tof the vault, use <a>InitiateJob</a>. Amazon Glacier generates vault inventories approximately daily. \n\t\t\tFor more information, see <a href=\"http://docs.
|
1167
|
+
"documentation": "\n\t\t<p>This operation returns information about a vault, including the vault's Amazon Resource Name\n\t\t\t(ARN), the date the vault was created, the number of archives it contains, \n\t\t\tand the total size of all the archives in the vault. The number of archives and\n\t\t\ttheir total size are as of the last inventory generation. This means that if you add or\n\t\t\tremove an archive from a vault, and then immediately use Describe Vault, the change in\n\t\t\tcontents will not be immediately reflected. If you want to retrieve the latest inventory\n\t\t\tof the vault, use <a>InitiateJob</a>. Amazon Glacier generates vault inventories approximately daily. \n\t\t\tFor more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory in Amazon Glacier</a>.\n\t\t</p>\n\n\t\t<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>\n <p>For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> \n and \n <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>.\n </p>\n "
|
1168
1168
|
},
|
1169
1169
|
"GetJobOutput": {
|
1170
1170
|
"name": "GetJobOutput",
|
@@ -1349,7 +1349,7 @@
|
|
1349
1349
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
1350
1350
|
}
|
1351
1351
|
],
|
1352
|
-
"documentation": "\n\t <p>This operation downloads the output of the job you initiated using <a>InitiateJob</a>. Depending on the\n\t\t\tjob type you specified when you initiated the job, the output will be either the content\n\t\t\tof an archive or a vault inventory.</p>\n\n <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\n\t\t\t\toutput within the 24 hours period after Amazon Glacier completes the job.</p>\n\n\t\t<p>If the job output is large, then you can use the <code>Range</code> request header to\n\t\t\tretrieve a portion of the output. This allows you to download the entire output in smaller\n\t\t\tchunks of bytes. For example, suppose you have 1 GB of job output you want to download and\n\t\t\tyou decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output\n\t\t\trequests. You use the following process to download the job output:</p>\n\n\t\t<ol>\n\t\t\t<li>\n<p>Download a 128 MB chunk of output by specifying the appropriate byte range using the\n\t\t\t\t\t\t<code>Range</code> header.</p>\n\t\t\t</li>\n\t\t\t<li>\n<p>Along with the data, the response includes a checksum of the payload. You compute\n\t\t\t\tthe checksum of the payload on the client and compare it with the checksum you received\n\t\t\t\tin the response to ensure you received all the expected data.</p>\n\t\t\t</li>\n\t\t\t<li>\n<p>Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time\n\t\t\t\tspecifying the appropriate byte range.</p>\n\t\t\t</li>\n\t\t\t<li>\n<p>After downloading all the parts of the job output, you have a list of eight checksum\n\t\t\t\tvalues. Compute the tree hash of these values to find the checksum of the entire output.\n\t\t\t\tUsing the Describe Job API, obtain job information of the job that provided you the\n\t\t\t\toutput. The response includes the checksum of the entire archive stored in Amazon Glacier.\n\t\t\t\tYou compare this value with the checksum you computed to ensure you have downloaded the\n\t\t\t\tentire archive content with no errors.</p>\n\t\t\t</li>\n\t\t</ol>\n\n\t\t<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.
|
1352
|
+
"documentation": "\n\t <p>This operation downloads the output of the job you initiated using <a>InitiateJob</a>. Depending on the\n\t\t\tjob type you specified when you initiated the job, the output will be either the content\n\t\t\tof an archive or a vault inventory.</p>\n\n <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\n\t\t\t\toutput within the 24 hours period after Amazon Glacier completes the job.</p>\n\n\t\t<p>If the job output is large, then you can use the <code>Range</code> request header to\n\t\t\tretrieve a portion of the output. This allows you to download the entire output in smaller\n\t\t\tchunks of bytes. For example, suppose you have 1 GB of job output you want to download and\n\t\t\tyou decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output\n\t\t\trequests. You use the following process to download the job output:</p>\n\n\t\t<ol>\n\t\t\t<li>\n<p>Download a 128 MB chunk of output by specifying the appropriate byte range using the\n\t\t\t\t\t\t<code>Range</code> header.</p>\n\t\t\t</li>\n\t\t\t<li>\n<p>Along with the data, the response includes a checksum of the payload. You compute\n\t\t\t\tthe checksum of the payload on the client and compare it with the checksum you received\n\t\t\t\tin the response to ensure you received all the expected data.</p>\n\t\t\t</li>\n\t\t\t<li>\n<p>Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time\n\t\t\t\tspecifying the appropriate byte range.</p>\n\t\t\t</li>\n\t\t\t<li>\n<p>After downloading all the parts of the job output, you have a list of eight checksum\n\t\t\t\tvalues. Compute the tree hash of these values to find the checksum of the entire output.\n\t\t\t\tUsing the Describe Job API, obtain job information of the job that provided you the\n\t\t\t\toutput. The response includes the checksum of the entire archive stored in Amazon Glacier.\n\t\t\t\tYou compare this value with the checksum you computed to ensure you have downloaded the\n\t\t\t\tentire archive content with no errors.</p>\n\t\t\t</li>\n\t\t</ol>\n\n\t\t<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>\n <p>For conceptual information and the underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory</a>, \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html\">Downloading an Archive</a>, \n and \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html\">Get Job Output </a> </p>\n "
|
1353
1353
|
},
|
1354
1354
|
"GetVaultNotifications": {
|
1355
1355
|
"name": "GetVaultNotifications",
|
@@ -1496,7 +1496,7 @@
|
|
1496
1496
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
1497
1497
|
}
|
1498
1498
|
],
|
1499
|
-
"documentation": "\n\t\t<p>This operation retrieves the <code class=\"code\">notification-configuration</code> subresource of the\n\t\t\tspecified vault.</p>\n\n\t\t<p>For information about setting a notification configuration on a vault, see <a>SetVaultNotifications</a>. If\n\t\t\ta notification configuration for a vault is not set, the operation returns a <code class=\"code\">404 Not\n\t\t\t\tFound</code> error. For more information about vault notifications, see <a href=\"http://docs.
|
1499
|
+
"documentation": "\n\t\t<p>This operation retrieves the <code class=\"code\">notification-configuration</code> subresource of the\n\t\t\tspecified vault.</p>\n\n\t\t<p>For information about setting a notification configuration on a vault, see <a>SetVaultNotifications</a>. If\n\t\t\ta notification configuration for a vault is not set, the operation returns a <code class=\"code\">404 Not\n\t\t\t\tFound</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>\n\n\t\t<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>\n <p>For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> \n and \n <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>.\n </p> \n "
|
1500
1500
|
},
|
1501
1501
|
"InitiateJob": {
|
1502
1502
|
"name": "InitiateJob",
|
@@ -1543,7 +1543,7 @@
|
|
1543
1543
|
"Description": {
|
1544
1544
|
"shape_name": "string",
|
1545
1545
|
"type": "string",
|
1546
|
-
"documentation": "\n <p>The optional description for the job.\n The description must be less than or equal to 1,024 bytes. \n The allowable characters are 7-bit ASCII without control codes
|
1546
|
+
"documentation": "\n <p>The optional description for the job.\n The description must be less than or equal to 1,024 bytes. \n The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.</p>\n "
|
1547
1547
|
},
|
1548
1548
|
"SNSTopic": {
|
1549
1549
|
"shape_name": "string",
|
@@ -1553,6 +1553,33 @@
|
|
1553
1553
|
"RetrievalByteRange": {
|
1554
1554
|
"shape_name": "string",
|
1555
1555
|
"type": "string",
|
1556
|
+
"documentation": "\n <p>The byte range to retrieve for an archive retrieval. in the form \"<i>StartByteValue</i>-<i>EndByteValue</i>\" \n If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte \n (1024*1024) aligned which means that <i>StartByteValue</i> must be divisible by 1 MB and <i>EndByteValue</i> \n plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size \n value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.\n </p>\n <p>\n An error occurs if you specify this field for an inventory retrieval job request. </p>\n "
|
1557
|
+
},
|
1558
|
+
"InventoryRetrievalParameters": {
|
1559
|
+
"shape_name": "InventoryRetrievalJobInput",
|
1560
|
+
"type": "structure",
|
1561
|
+
"members": {
|
1562
|
+
"StartDate": {
|
1563
|
+
"shape_name": "string",
|
1564
|
+
"type": "string",
|
1565
|
+
"documentation": null
|
1566
|
+
},
|
1567
|
+
"EndDate": {
|
1568
|
+
"shape_name": "string",
|
1569
|
+
"type": "string",
|
1570
|
+
"documentation": null
|
1571
|
+
},
|
1572
|
+
"Limit": {
|
1573
|
+
"shape_name": "string",
|
1574
|
+
"type": "string",
|
1575
|
+
"documentation": null
|
1576
|
+
},
|
1577
|
+
"Marker": {
|
1578
|
+
"shape_name": "string",
|
1579
|
+
"type": "string",
|
1580
|
+
"documentation": null
|
1581
|
+
}
|
1582
|
+
},
|
1556
1583
|
"documentation": null
|
1557
1584
|
}
|
1558
1585
|
},
|
@@ -1673,7 +1700,7 @@
|
|
1673
1700
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
1674
1701
|
}
|
1675
1702
|
],
|
1676
|
-
"documentation": "\n\t <p>This operation initiates a job of the specified type. In this release, you can initiate a\n\t\t\tjob to retrieve either an archive or a vault inventory (a list of archives in a vault). </p>\n\n\t\t<p>Retrieving data from Amazon Glacier is a two-step process: </p>\n\n\t\t<ol>\n\t\t\t<li><p>Initiate a retrieval job.</p></li>\n\t\t\t<li><p>After the job completes, download the bytes.</p></li>\n\t\t</ol>\n\n\t\t<p>The retrieval request is executed asynchronously. When you initiate a retrieval job,\n\t\t\tAmazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes\n\t\t\tthe job, you can get the job output (archive or inventory data). For information about\n\t\t\tgetting job output, see <a>GetJobOutput</a> operation. </p>\n\n\t\t<p>The job must complete before you can get its output. To determine when a job is complete,\n\t\t\tyou have the following options:</p>\n\n\t\t<ul>\n\t\t\t<li>\n<p><b>Use Amazon SNS Notification</b> You can specify an\n\t\t\t\t\t\tAmazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can\n\t\t\t\t\t\tpost a notification after the job is completed. You can specify an SNS topic\n\t\t\t\t\t\tper job request. The notification is sent only after Amazon Glacier completes the\n\t\t\t\t\t\tjob. In addition to specifying an SNS topic per job request, you can\n\t\t\t\t\t\tconfigure vault notifications for a vault so that job notifications are\n\t\t\t\t\t\talways sent. For more information, see <a>
|
1703
|
+
"documentation": "\n\t <p>This operation initiates a job of the specified type. In this release, you can initiate a\n\t\t\tjob to retrieve either an archive or a vault inventory (a list of archives in a vault). </p>\n\n\t\t<p>Retrieving data from Amazon Glacier is a two-step process: </p>\n\n\t\t<ol>\n\t\t\t<li><p>Initiate a retrieval job.</p></li>\n\t\t\t<li><p>After the job completes, download the bytes.</p></li>\n\t\t</ol>\n\n\t\t<p>The retrieval request is executed asynchronously. When you initiate a retrieval job,\n\t\t\tAmazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes\n\t\t\tthe job, you can get the job output (archive or inventory data). For information about\n\t\t\tgetting job output, see <a>GetJobOutput</a> operation. </p>\n\n\t\t<p>The job must complete before you can get its output. To determine when a job is complete,\n\t\t\tyou have the following options:</p>\n\n\t\t<ul>\n\t\t\t<li>\n<p><b>Use Amazon SNS Notification</b> You can specify an\n\t\t\t\t\t\tAmazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can\n\t\t\t\t\t\tpost a notification after the job is completed. You can specify an SNS topic\n\t\t\t\t\t\tper job request. The notification is sent only after Amazon Glacier completes the\n\t\t\t\t\t\tjob. In addition to specifying an SNS topic per job request, you can\n\t\t\t\t\t\tconfigure vault notifications for a vault so that job notifications are\n\t\t\t\t\t\talways sent. For more information, see <a>SetVaultNotifications</a>.</p>\n\t\t\t</li>\n\t\t\t<li>\n<p><b>Get job details</b> You can make a <a>DescribeJob</a> request\n\t\t\t\t\t\tto obtain job status information while a job is in progress. However, it is\n\t\t\t\t\t\tmore efficient to use an Amazon SNS notification to determine when a job is\n\t\t\t\t\t\tcomplete.</p>\n\t\t\t</li>\n\t\t</ul>\n\n\t\t<note><p>The information you get via notification is same that you get by calling <a>DescribeJob</a>.</p></note>\n\n\t\t<p>If for a specific event, you add both the notification configuration on the vault and also\n\t\t\tspecify an SNS topic in your initiate job request, Amazon Glacier sends both\n\t\t\tnotifications. For more information, see <a>SetVaultNotifications</a>.</p>\n\n\t\t<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>\n\n\t\t<p><b>About the Vault Inventory</b></p>\n\n\t\t<p>Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you\n\t\t\t\tinitiate a job for a vault inventory, Amazon Glacier returns the last inventory for\n\t\t\t\tthe vault. The inventory data you get might be up to a day or two days old. Also,\n\t\t\t\tthe initiate inventory job might take some time to complete before you can download\n\t\t\t\tthe vault inventory. So you do not want to retrieve a vault inventory for each vault\n\t\t\t\toperation. However, in some scenarios, you might find the vault inventory useful.\n\t\t\t\tFor example, when you upload an archive, you can provide an archive description but\n\t\t\t\tnot an archive name. Amazon Glacier provides you a unique archive ID, an opaque\n\t\t\t\tstring of characters. So, you might maintain your own database that maps archive\n\t\t\t\tnames to their corresponding Amazon Glacier assigned archive IDs. You might find the\n\t\t\t\tvault inventory useful in the event you need to reconcile information in your\n\t\t\t\tdatabase with the actual vault inventory. </p>\n \n <p><b>About Ranged Archive Retrieval</b></p>\n <p>\n You can initiate an archive retrieval for the whole archive or a range of the archive. \n In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. \n The range specified must be megabyte (MB) aligned, that is the range start value must be \n divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the \n archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a \n 400 response. Furthermore, to ensure you get checksum values for data you download using \n Get Job Output API, the range must be tree hash aligned. \n </p>\n\n\t\t<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. \n\t\t You must grant them explicit permission to perform specific actions. For more information, \n\t\t 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>\n <p>For conceptual information and the underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html\">Initiate a Job</a>\n and \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory</a> </p>\n \n "
|
1677
1704
|
},
|
1678
1705
|
"InitiateMultipartUpload": {
|
1679
1706
|
"name": "InitiateMultipartUpload",
|
@@ -1826,7 +1853,7 @@
|
|
1826
1853
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
1827
1854
|
}
|
1828
1855
|
],
|
1829
|
-
"documentation": "\n\t\t<p>This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource\n\t\t\tand returns its ID in the response. The multipart upload ID is used in subsequent\n\t\t\trequests to upload parts of an archive (see <a>UploadMultipartPart</a>).</p>\n\t\n\t <p>When you initiate a multipart upload, you specify the part size in number of bytes. The part\n\t\t\tsize must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576\n\t\t\t(1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable\n\t\t\tpart size is 1 MB, and the maximum is 4 GB.</p>\n\t\n\t\t<p>Every part you upload to this resource (see <a>UploadMultipartPart</a>), except the last one, must have the same size. The\n\t\t\tlast one can be the same size or smaller. For example, suppose you want to upload a 16.2\n\t\t\tMB file. If you initiate the multipart upload with a part size of 4 MB, you will upload\n\t\t\tfour parts of 4 MB each and one part of 0.2 MB. </p>\n\n\t\t<note><p>You don't need to know the size of the archive when you start a multipart upload because\n\t\t\t\t\tAmazon Glacier does not require you to specify the overall archive size.</p></note>\n\n\t\t<p>After you complete the multipart upload, Amazon Glacier removes the multipart upload resource\n\t\t\treferenced by the ID. Amazon Glacier also removes the multipart upload resource if you\n\t\t\tcancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.</p>\n\n\t\t<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.
|
1856
|
+
"documentation": "\n\t\t<p>This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource\n\t\t\tand returns its ID in the response. The multipart upload ID is used in subsequent\n\t\t\trequests to upload parts of an archive (see <a>UploadMultipartPart</a>).</p>\n\t\n\t <p>When you initiate a multipart upload, you specify the part size in number of bytes. The part\n\t\t\tsize must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576\n\t\t\t(1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable\n\t\t\tpart size is 1 MB, and the maximum is 4 GB.</p>\n\t\n\t\t<p>Every part you upload to this resource (see <a>UploadMultipartPart</a>), except the last one, must have the same size. The\n\t\t\tlast one can be the same size or smaller. For example, suppose you want to upload a 16.2\n\t\t\tMB file. If you initiate the multipart upload with a part size of 4 MB, you will upload\n\t\t\tfour parts of 4 MB each and one part of 0.2 MB. </p>\n\n\t\t<note><p>You don't need to know the size of the archive when you start a multipart upload because\n\t\t\t\t\tAmazon Glacier does not require you to specify the overall archive size.</p></note>\n\n\t\t<p>After you complete the multipart upload, Amazon Glacier removes the multipart upload resource\n\t\t\treferenced by the ID. Amazon Glacier also removes the multipart upload resource if you\n\t\t\tcancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.</p>\n\n\t\t<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>\n <p>For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> \n and \n <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> \n "
|
1830
1857
|
},
|
1831
1858
|
"ListJobs": {
|
1832
1859
|
"name": "ListJobs",
|
@@ -1965,17 +1992,17 @@
|
|
1965
1992
|
"SHA256TreeHash": {
|
1966
1993
|
"shape_name": "string",
|
1967
1994
|
"type": "string",
|
1968
|
-
"documentation": "\n <p>For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.</p>\n "
|
1995
|
+
"documentation": "\n <p>For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.</p>\n <p>\n The SHA256 tree hash value for the requested range of an archive. \n If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field \n returns a value. </p>\n <p> \n For the specific case when the whole archive is retrieved, this value is the \n same as the ArchiveSHA256TreeHash value. </p>\n <p>\n This field is null in the following situations:\n <ul>\n <li><p>Archive retrieval jobs that specify a range that is not tree-hash aligned.</p></li>\n </ul> \n <ul>\n <li><p>Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.</p></li>\n </ul> \n <ul>\n <li><p>Inventory jobs.</p></li>\n </ul> \n </p>\n "
|
1969
1996
|
},
|
1970
1997
|
"ArchiveSHA256TreeHash": {
|
1971
1998
|
"shape_name": "string",
|
1972
1999
|
"type": "string",
|
1973
|
-
"documentation": null
|
2000
|
+
"documentation": "\n <p>The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.\n </p>\n "
|
1974
2001
|
},
|
1975
2002
|
"RetrievalByteRange": {
|
1976
2003
|
"shape_name": "string",
|
1977
2004
|
"type": "string",
|
1978
|
-
"documentation": null
|
2005
|
+
"documentation": "\n <p>The retrieved byte range for archive retrieval jobs in the form \"<i>StartByteValue</i>-<i>EndByteValue</i>\" \n If no range was specified in the archive retrieval, then the whole archive is retrieved and \n <i>StartByteValue</i> equals 0 and <i>EndByteValue</i> equals the size of the archive minus 1. \n For inventory retrieval jobs this field is null. </p> \n "
|
1979
2006
|
}
|
1980
2007
|
},
|
1981
2008
|
"documentation": "\n <p>Describes an Amazon Glacier job.</p>\n "
|
@@ -2080,7 +2107,7 @@
|
|
2080
2107
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
2081
2108
|
}
|
2082
2109
|
],
|
2083
|
-
"documentation": "\n\t <p>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have\n\t\t\trecently finished. </p>\n\n\t\t<note><p>Amazon Glacier retains recently completed jobs for a period before deleting them; however,\n\t\t\t\t\tit eventually removes completed jobs. The output of completed jobs can be\n\t\t\t\t\tretrieved. Retaining completed jobs for a period of time after they have\n\t\t\t\t\tcompleted enables you to get a job output in the event you miss the job\n\t\t\t\t\tcompletion notification or your first attempt to download it fails. For example,\n\t\t\t\t\tsuppose you start an archive retrieval job to download an archive. After the job\n\t\t\t\t\tcompletes, you start to download the archive but encounter a network error. In\n\t\t\t\t\tthis scenario, you can retry and download the archive while the job exists. </p></note>\n\t\t\n\t\t<p>To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate\n\t\t\ta job, and after the job completes, you download the data. For an archive retrieval, the\n\t\t\toutput is the archive data, and for an inventory retrieval, it is the inventory list.\n\t\t\tThe List Job operation returns a list of these jobs sorted by job initiation\n\t\t\ttime.</p>\n\n\t\t<p>This List Jobs operation supports pagination. \n\t\t By default, this operation returns up to 1,000 jobs in the response. \n\t\t You should always check the response for a <code>marker</code> at which to continue the list; \n\t\t if there are no more items the <code>marker</code> is <code>null</code>.\n To return a list of jobs that begins\n\t\t\tat a specific job, set the <code>marker</code> request parameter to the value you\n\t\t\tobtained from a previous List Jobs request. You can also limit the number of jobs\n\t\t\treturned in the response by specifying the <code>limit</code> parameter in the\n\t\t\trequest.</p>\n\n\t\t<p>Additionally, you can filter the jobs list returned by specifying an optional\n\t\t\t\t<code>statuscode</code> (InProgress, Succeeded, or Failed) and\n\t\t\t\t<code>completed</code> (true, false) parameter. The <code>statuscode</code> allows\n\t\t\tyou to specify that only jobs that match a specified status are returned. The\n\t\t\t\t<code>completed</code> parameter allows you to specify that only jobs in a specific\n\t\t\tcompletion state are returned.</p>\n\n\t\t<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.
|
2110
|
+
"documentation": "\n\t <p>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have\n\t\t\trecently finished. </p>\n\n\t\t<note><p>Amazon Glacier retains recently completed jobs for a period before deleting them; however,\n\t\t\t\t\tit eventually removes completed jobs. The output of completed jobs can be\n\t\t\t\t\tretrieved. Retaining completed jobs for a period of time after they have\n\t\t\t\t\tcompleted enables you to get a job output in the event you miss the job\n\t\t\t\t\tcompletion notification or your first attempt to download it fails. For example,\n\t\t\t\t\tsuppose you start an archive retrieval job to download an archive. After the job\n\t\t\t\t\tcompletes, you start to download the archive but encounter a network error. In\n\t\t\t\t\tthis scenario, you can retry and download the archive while the job exists. </p></note>\n\t\t\n\t\t<p>To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate\n\t\t\ta job, and after the job completes, you download the data. For an archive retrieval, the\n\t\t\toutput is the archive data, and for an inventory retrieval, it is the inventory list.\n\t\t\tThe List Job operation returns a list of these jobs sorted by job initiation\n\t\t\ttime.</p>\n\n\t\t<p>This List Jobs operation supports pagination. \n\t\t By default, this operation returns up to 1,000 jobs in the response. \n\t\t You should always check the response for a <code>marker</code> at which to continue the list; \n\t\t if there are no more items the <code>marker</code> is <code>null</code>.\n To return a list of jobs that begins\n\t\t\tat a specific job, set the <code>marker</code> request parameter to the value you\n\t\t\tobtained from a previous List Jobs request. You can also limit the number of jobs\n\t\t\treturned in the response by specifying the <code>limit</code> parameter in the\n\t\t\trequest.</p>\n\n\t\t<p>Additionally, you can filter the jobs list returned by specifying an optional\n\t\t\t\t<code>statuscode</code> (InProgress, Succeeded, or Failed) and\n\t\t\t\t<code>completed</code> (true, false) parameter. The <code>statuscode</code> allows\n\t\t\tyou to specify that only jobs that match a specified status are returned. The\n\t\t\t\t<code>completed</code> parameter allows you to specify that only jobs in a specific\n\t\t\tcompletion state are returned.</p>\n\n\t\t<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>\n <p>For the underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html\">List Jobs </a> </p>\n "
|
2084
2111
|
},
|
2085
2112
|
"ListMultipartUploads": {
|
2086
2113
|
"name": "ListMultipartUploads",
|
@@ -2258,7 +2285,7 @@
|
|
2258
2285
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
2259
2286
|
}
|
2260
2287
|
],
|
2261
|
-
"documentation": "\n\t <p>This operation lists in-progress multipart uploads for the specified vault. An in-progress\n\t\t\tmultipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a>\n\t\t\trequest, but has not yet been completed or aborted. The list returned in the List\n\t\t\tMultipart Upload response has no guaranteed order.\n\t </p>\n\n\t\t<p>The List Multipart Uploads operation supports pagination.\n\t\t By default, this operation returns up to 1,000 multipart uploads in the response. \n\t\t You should always check the response for a <code>marker</code> at which to continue the list; \n\t\t if there are no more items the <code>marker</code> is <code>null</code>. \n\t\t To return a list of multipart uploads that begins at a\n\t\t\tspecific upload, set the <code>marker</code> request parameter to the value you obtained\n\t\t\tfrom a previous List Multipart Upload request. You can also limit the number of uploads\n\t\t\treturned in the response by specifying the <code>limit</code> parameter in the\n\t\t\trequest.</p>\n\n\t\t<p>Note the difference between this operation and listing parts (<a>ListParts</a>). The List\n\t\t\tMultipart Uploads operation lists all multipart uploads for a vault and does not require\n\t\t\ta multipart upload ID. The List Parts operation requires a multipart upload ID since\n\t\t\tparts are associated with a single upload.</p>\n\n\t\t<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. \n\t\t You must grant them explicit permission to perform specific actions. \n\t\t For more information, see <a href=\"http://docs.
|
2288
|
+
"documentation": "\n\t <p>This operation lists in-progress multipart uploads for the specified vault. An in-progress\n\t\t\tmultipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a>\n\t\t\trequest, but has not yet been completed or aborted. The list returned in the List\n\t\t\tMultipart Upload response has no guaranteed order.\n\t </p>\n\n\t\t<p>The List Multipart Uploads operation supports pagination.\n\t\t By default, this operation returns up to 1,000 multipart uploads in the response. \n\t\t You should always check the response for a <code>marker</code> at which to continue the list; \n\t\t if there are no more items the <code>marker</code> is <code>null</code>. \n\t\t To return a list of multipart uploads that begins at a\n\t\t\tspecific upload, set the <code>marker</code> request parameter to the value you obtained\n\t\t\tfrom a previous List Multipart Upload request. You can also limit the number of uploads\n\t\t\treturned in the response by specifying the <code>limit</code> parameter in the\n\t\t\trequest.</p>\n\n\t\t<p>Note the difference between this operation and listing parts (<a>ListParts</a>). The List\n\t\t\tMultipart Uploads operation lists all multipart uploads for a vault and does not require\n\t\t\ta multipart upload ID. The List Parts operation requires a multipart upload ID since\n\t\t\tparts are associated with a single upload.</p>\n\n\t\t<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. \n\t\t You must grant them explicit permission to perform specific actions. \n\t\t 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>\n \n <p>For conceptual information and the underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> \n and \n <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>\n "
|
2262
2289
|
},
|
2263
2290
|
"ListParts": {
|
2264
2291
|
"name": "ListParts",
|
@@ -2452,7 +2479,7 @@
|
|
2452
2479
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
2453
2480
|
}
|
2454
2481
|
],
|
2455
|
-
"documentation": "\n \t\t<p>This operation lists the parts of an archive that have been uploaded in a specific multipart\n\t\t\tupload. You can make this request at any time during an in-progress multipart upload\n\t\t\tbefore you complete the upload (see <a>CompleteMultipartUpload</a>. List Parts returns an error for\n\t\t\tcompleted uploads. The list returned in the List Parts response is sorted by part range.\n\t\t</p>\n\n\t\t<p>The List Parts operation supports pagination. \n\t\t By default, this operation returns up to 1,000 uploaded parts in the response. \n\t\t You should always check the response for a <code class=\"code\">marker</code> at which to continue \n\t\t the list; if there are no more items the <code class=\"code\">marker</code> is <code class=\"code\">null</code>. \n\t\t To return a list of parts that\n\t\t\tbegins at a specific part, set the <code>marker</code> request parameter to the value\n\t\t\tyou obtained from a previous List Parts request. You can also limit the number of parts\n\t\t\treturned in the response by specifying the <code>limit</code> parameter in the request.\n\t\t</p>\n\n\t\t<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. \n\t\t You must grant them explicit permission to perform specific actions. \n\t\t For more information, see <a href=\"http://docs.
|
2482
|
+
"documentation": "\n \t\t<p>This operation lists the parts of an archive that have been uploaded in a specific multipart\n\t\t\tupload. You can make this request at any time during an in-progress multipart upload\n\t\t\tbefore you complete the upload (see <a>CompleteMultipartUpload</a>. List Parts returns an error for\n\t\t\tcompleted uploads. The list returned in the List Parts response is sorted by part range.\n\t\t</p>\n\n\t\t<p>The List Parts operation supports pagination. \n\t\t By default, this operation returns up to 1,000 uploaded parts in the response. \n\t\t You should always check the response for a <code class=\"code\">marker</code> at which to continue \n\t\t the list; if there are no more items the <code class=\"code\">marker</code> is <code class=\"code\">null</code>. \n\t\t To return a list of parts that\n\t\t\tbegins at a specific part, set the <code>marker</code> request parameter to the value\n\t\t\tyou obtained from a previous List Parts request. You can also limit the number of parts\n\t\t\treturned in the response by specifying the <code>limit</code> parameter in the request.\n\t\t</p>\n\n\t\t<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. \n\t\t You must grant them explicit permission to perform specific actions. \n\t\t 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>\n <p>For conceptual information and the underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> \n and \n <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>\n "
|
2456
2483
|
},
|
2457
2484
|
"ListVaults": {
|
2458
2485
|
"name": "ListVaults",
|
@@ -2629,7 +2656,7 @@
|
|
2629
2656
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
2630
2657
|
}
|
2631
2658
|
],
|
2632
|
-
"documentation": "\n \t\t<p>This operation lists all vaults owned by the calling user's account. The list returned in\n\t\t\tthe response is ASCII-sorted by vault name. </p>\n\n\t\t<p>By default, this operation returns up to 1,000 items. If there are more vaults to list, the\n\t\t\tresponse <code class=\"code\">marker</code> field contains the vault Amazon Resource Name (ARN) at\n\t\t\twhich to continue the list with a new List Vaults request; otherwise, the\n\t\t\t\t<code class=\"code\">marker</code> field is <code class=\"code\">null</code>. To return a list of vaults that\n\t\t\tbegins at a specific vault, set the <code class=\"code\">marker</code> request parameter to the vault\n\t\t\tARN you obtained from a previous List Vaults request. You can also limit the number of\n\t\t\tvaults returned in the response by specifying the <code class=\"code\">limit</code> parameter in the\n\t\t\trequest. </p>\n\n\t\t<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.
|
2659
|
+
"documentation": "\n \t\t<p>This operation lists all vaults owned by the calling user's account. The list returned in\n\t\t\tthe response is ASCII-sorted by vault name. </p>\n\n\t\t<p>By default, this operation returns up to 1,000 items. If there are more vaults to list, the\n\t\t\tresponse <code class=\"code\">marker</code> field contains the vault Amazon Resource Name (ARN) at\n\t\t\twhich to continue the list with a new List Vaults request; otherwise, the\n\t\t\t\t<code class=\"code\">marker</code> field is <code class=\"code\">null</code>. To return a list of vaults that\n\t\t\tbegins at a specific vault, set the <code class=\"code\">marker</code> request parameter to the vault\n\t\t\tARN you obtained from a previous List Vaults request. You can also limit the number of\n\t\t\tvaults returned in the response by specifying the <code class=\"code\">limit</code> parameter in the\n\t\t\trequest. </p>\n\n\t\t<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>\n <p>For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> \n and \n <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>.\n </p>\n "
|
2633
2660
|
},
|
2634
2661
|
"SetVaultNotifications": {
|
2635
2662
|
"name": "SetVaultNotifications",
|
@@ -2771,7 +2798,7 @@
|
|
2771
2798
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
2772
2799
|
}
|
2773
2800
|
],
|
2774
|
-
"documentation": "\n \t\t<p>This operation configures notifications that will be sent when specific events happen\n\t\t\tto a vault. By default, you don't get any notifications. </p>\n\n\t\t<p>To configure vault notifications, send a PUT request to the\n\t\t\t\t<code class=\"code\">notification-configuration</code> subresource of the vault. The request should\n\t\t\tinclude a JSON document that provides an Amazon SNS topic and specific events for which\n\t\t\tyou want Amazon Glacier to send notifications to the topic.</p>\n\n\t\t<p>Amazon SNS topics must grant permission to the vault to be allowed to publish\n\t\t\tnotifications to the topic. You can configure a vault to publish a notification for the\n\t\t\tfollowing vault events:</p>\n\n\t\t<ul>\n\t\t\t<li>\n\t\t\t\t<b>ArchiveRetrievalCompleted</b> This event occurs when a\n\t\t\t\t\t\tjob that was initiated for an archive retrieval is completed (<a>InitiateJob</a>). The\n\t\t\t\t\t\tstatus of the completed job can be \"Succeeded\" or \"Failed\". The notification\n\t\t\t\t\t\tsent to the SNS topic is the same output as returned from <a>DescribeJob</a>.\n\t\t\t</li>\n\t\t\t<li>\n<b>InventoryRetrievalCompleted</b> This event occurs when\n\t\t\t\t\t\ta job that was initiated for an inventory retrieval is completed (<a>InitiateJob</a>). The\n\t\t\t\t\t\tstatus of the completed job can be \"Succeeded\" or \"Failed\". The notification\n\t\t\t\t\t\tsent to the SNS topic is the same output as returned from <a>DescribeJob</a>.\n\t\t\t</li>\n\t\t</ul>\n\n\t\t<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.
|
2801
|
+
"documentation": "\n \t\t<p>This operation configures notifications that will be sent when specific events happen\n\t\t\tto a vault. By default, you don't get any notifications. </p>\n\n\t\t<p>To configure vault notifications, send a PUT request to the\n\t\t\t\t<code class=\"code\">notification-configuration</code> subresource of the vault. The request should\n\t\t\tinclude a JSON document that provides an Amazon SNS topic and specific events for which\n\t\t\tyou want Amazon Glacier to send notifications to the topic.</p>\n\n\t\t<p>Amazon SNS topics must grant permission to the vault to be allowed to publish\n\t\t\tnotifications to the topic. You can configure a vault to publish a notification for the\n\t\t\tfollowing vault events:</p>\n\n\t\t<ul>\n\t\t\t<li>\n\t\t\t\t<b>ArchiveRetrievalCompleted</b> This event occurs when a\n\t\t\t\t\t\tjob that was initiated for an archive retrieval is completed (<a>InitiateJob</a>). The\n\t\t\t\t\t\tstatus of the completed job can be \"Succeeded\" or \"Failed\". The notification\n\t\t\t\t\t\tsent to the SNS topic is the same output as returned from <a>DescribeJob</a>.\n\t\t\t</li>\n\t\t\t<li>\n<b>InventoryRetrievalCompleted</b> This event occurs when\n\t\t\t\t\t\ta job that was initiated for an inventory retrieval is completed (<a>InitiateJob</a>). The\n\t\t\t\t\t\tstatus of the completed job can be \"Succeeded\" or \"Failed\". The notification\n\t\t\t\t\t\tsent to the SNS topic is the same output as returned from <a>DescribeJob</a>.\n\t\t\t</li>\n\t\t</ul>\n\n\t\t<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>\n <p>For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> \n and \n <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>.\n </p>\n "
|
2775
2802
|
},
|
2776
2803
|
"UploadArchive": {
|
2777
2804
|
"name": "UploadArchive",
|
@@ -2846,7 +2873,7 @@
|
|
2846
2873
|
"location_name": "x-amz-archive-id"
|
2847
2874
|
}
|
2848
2875
|
},
|
2849
|
-
"documentation": "\n <p>Contains the Amazon Glacier response to your request.</p>\n <p>For information about the underlying REST API, go to \n <a href=\"http://docs.
|
2876
|
+
"documentation": "\n <p>Contains the Amazon Glacier response to your request.</p>\n <p>For information about the underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html\">Upload Archive</a>. \n 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>\n "
|
2850
2877
|
},
|
2851
2878
|
"errors": [
|
2852
2879
|
{
|
@@ -2960,7 +2987,7 @@
|
|
2960
2987
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
2961
2988
|
}
|
2962
2989
|
],
|
2963
|
-
"documentation": "\n\t\t<p>This operation adds an archive to a vault. This is a synchronous operation, and for a\n\t\t\tsuccessful upload, your data is durably persisted. Amazon Glacier returns the archive ID in\n\t\t\tthe <code class=\"code\">x-amz-archive-id</code> header of the response.\n\t\t</p>\n\n\t\t<p>You must use the archive ID to access your data in Amazon Glacier. After you upload an archive,\n\t\t\tyou should save the archive ID returned so that you can retrieve or delete the archive\n\t\t\tlater. Besides saving the archive ID, you can also index it and give it a friendly name\n\t\t\tto allow for better searching. You can also use the optional archive description field\n\t\t\tto specify how the archive is referred to in an external index of archives, such as you\n\t\t\tmight create in Amazon DynamoDB. You can also get the vault inventory to obtain a list\n\t\t\tof archive IDs in a vault. For more information, see <a>InitiateJob</a>. \n\t\t</p>\n\n\t\t<p>You must provide a SHA256 tree hash of the data you are uploading. For information about\n\t\t\tcomputing a SHA256 tree hash, see <a href=\"http://docs.
|
2990
|
+
"documentation": "\n\t\t<p>This operation adds an archive to a vault. This is a synchronous operation, and for a\n\t\t\tsuccessful upload, your data is durably persisted. Amazon Glacier returns the archive ID in\n\t\t\tthe <code class=\"code\">x-amz-archive-id</code> header of the response.\n\t\t</p>\n\n\t\t<p>You must use the archive ID to access your data in Amazon Glacier. After you upload an archive,\n\t\t\tyou should save the archive ID returned so that you can retrieve or delete the archive\n\t\t\tlater. Besides saving the archive ID, you can also index it and give it a friendly name\n\t\t\tto allow for better searching. You can also use the optional archive description field\n\t\t\tto specify how the archive is referred to in an external index of archives, such as you\n\t\t\tmight create in Amazon DynamoDB. You can also get the vault inventory to obtain a list\n\t\t\tof archive IDs in a vault. For more information, see <a>InitiateJob</a>. \n\t\t</p>\n\n\t\t<p>You must provide a SHA256 tree hash of the data you are uploading. For information about\n\t\t\tcomputing a SHA256 tree hash, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html\">Computing Checksums</a>. </p>\n\n\t\t<p>You can optionally specify an archive description of up to 1,024 printable ASCII characters.\n\t\t\tYou can get the archive description when you either retrieve the archive or get the vault\n\t\t\tinventory. For more information, see <a>InitiateJob</a>. Amazon Glacier does not interpret the description\n\t\t\tin any way. An archive description does not need to be unique. You cannot use the\n\t\t\tdescription to retrieve or sort the archive list. \n\t\t</p>\n\n\t\t<p>Archives are immutable. After you upload an archive, you cannot edit the archive or its\n\t\t\tdescription. </p>\n\n\t\t<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>\n <p> For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html\">Uploading an Archive in Amazon Glacier</a> \n and \n <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>.\n </p> \n "
|
2964
2991
|
},
|
2965
2992
|
"UploadMultipartPart": {
|
2966
2993
|
"name": "UploadMultipartPart",
|
@@ -3141,7 +3168,7 @@
|
|
3141
3168
|
"documentation": "\n <p>Returned if the service cannot complete the request.</p>\n "
|
3142
3169
|
}
|
3143
3170
|
],
|
3144
|
-
"documentation": "\n\t <p>This operation uploads a part of an archive. You can upload archive parts in any order. You\n\t\t\tcan also upload them in parallel. You can upload up to 10,000 parts for a\n\t\t\tmultipart upload.</p>\n\n\t\t<p>Amazon Glacier rejects your upload part request if any of the following conditions is\n\t\t\ttrue:</p>\n\n\t\t<ul>\n\t\t\t<li>\n<p><b>SHA256 tree hash does not match</b>To ensure that part\n\t\t\t\t\t\tdata is not corrupted in transmission, you compute a SHA256 tree hash of the\n\t\t\t\t\t\tpart and include it in your request. Upon receiving the part data, Amazon Glacier\n\t\t\t\t\t\talso computes a SHA256 tree hash. If these hash values don't match, the\n\t\t\t\t\t\toperation fails. For information about computing a SHA256 tree hash, see\n\t\t\t\t\t\t\t<a href=\"http://docs.
|
3171
|
+
"documentation": "\n\t <p>This operation uploads a part of an archive. You can upload archive parts in any order. You\n\t\t\tcan also upload them in parallel. You can upload up to 10,000 parts for a\n\t\t\tmultipart upload.</p>\n\n\t\t<p>Amazon Glacier rejects your upload part request if any of the following conditions is\n\t\t\ttrue:</p>\n\n\t\t<ul>\n\t\t\t<li>\n<p><b>SHA256 tree hash does not match</b>To ensure that part\n\t\t\t\t\t\tdata is not corrupted in transmission, you compute a SHA256 tree hash of the\n\t\t\t\t\t\tpart and include it in your request. Upon receiving the part data, Amazon Glacier\n\t\t\t\t\t\talso computes a SHA256 tree hash. If these hash values don't match, the\n\t\t\t\t\t\toperation fails. For information about computing a SHA256 tree hash, see\n\t\t\t\t\t\t\t<a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html\">Computing Checksums</a>.</p>\n\t\t\t</li>\n\t\t\t<li>\n<p><b>Part size does not match</b>The size of each part except the last must match the size specified in the\n\t\t\t\t\t\tcorresponding <a>InitiateMultipartUpload</a> request. The size of the last part must\n\t\t\t\t\t\t\tbe the same size as, or smaller than, the specified size.</p>\n\t\t\t\t<note><p>If you upload a part whose size is smaller than the part size you specified in your initiate\n\t\t\t\t\t\t\tmultipart upload request and that part is not the last part, then the\n\t\t\t\t\t\t\tupload part request will succeed. However, the subsequent Complete\n\t\t\t\t\t\t\tMultipart Upload request will fail.</p></note>\n\t\t\t</li>\n\t\t\t<li>\n<b>Range does not align</b>The byte range value in the\n\t\t\t\t\t\trequest does not align with the part size specified in the corresponding\n\t\t\t\t\t\tinitiate request. For example, if you specify a part size of 4194304 bytes\n\t\t\t\t\t\t(4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to\n\t\t\t\t\t\t8388607 (8 MB - 1) are valid part ranges. However, if you set a range\n\t\t\t\t\t\tvalue of 2 MB to 6 MB, the range does not align with the part size and the\n\t\t\t\t\t\tupload will fail.\n\t\t\t</li>\n\t\t</ul>\n\n\t\t<p>This operation is idempotent. If you upload the same part multiple times, the data included\n\t\t\tin the most recent request overwrites the previously uploaded data.</p>\n\n\t\t<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>\n <p> For conceptual information and underlying REST API, go to \n <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> \n and \n <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> \n "
|
3145
3172
|
}
|
3146
3173
|
}
|
3147
3174
|
}
|
@@ -7,7 +7,7 @@
|
|
7
7
|
"service_full_name": "AWS Support",
|
8
8
|
"endpoint_prefix": "support",
|
9
9
|
"xmlnamespace": "http://support.amazonaws.com/doc/2013-04-15/",
|
10
|
-
"documentation": "\n <fullname>AWS Support</fullname>\n \n \n <p>The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions and data types. This service enables you to manage
|
10
|
+
"documentation": "\n <fullname>AWS Support</fullname>\n \n \n <p>The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.</p>\n \n <p>The AWS Support service also exposes a set of <a href=\"https://aws.amazon.com/support/trustedadvisor\">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </p> \n \n <p>The following list describes the AWS Support case management actions: </p>\n <ul>\n <li>\n<b>Service names, issue categories, and available severity levels. </b>The actions <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> enable you to obtain AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> action. </li>\n <li>\n<b>Case creation, case details, and case resolution.</b> The actions <a>CreateCase</a>, <a>DescribeCases</a>, and <a>ResolveCase</a> enable you to create AWS Support cases, retrieve them, and resolve them.</li>\n <li>\n<b>Case communication.</b> The actions <a>DescribeCommunications</a> and <a>AddCommunicationToCase</a> enable you to retrieve and add communication to AWS Support cases. </li>\n </ul>\n \n <p>The following list describes the actions available from the AWS Support service for Trusted Advisor:</p>\n <ul>\n <li>\n<a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> \n <li>Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> \n <li>\n<a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li>\n <li>\n<a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li>\n <li>\n<a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li>\n </ul>\n \n <p>For authentication of requests, AWS Support uses <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p>\n \n <p>See the AWS Support <a href=\"http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html\">User Guide</a> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </p>\n \n \n ",
|
11
11
|
"operations": {
|
12
12
|
"AddCommunicationToCase": {
|
13
13
|
"name": "AddCommunicationToCase",
|
@@ -18,14 +18,14 @@
|
|
18
18
|
"caseId": {
|
19
19
|
"shape_name": "CaseId",
|
20
20
|
"type": "string",
|
21
|
-
"documentation": "\n <p>
|
21
|
+
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
|
22
22
|
},
|
23
23
|
"communicationBody": {
|
24
24
|
"shape_name": "CommunicationBody",
|
25
25
|
"type": "string",
|
26
26
|
"min_length": 1,
|
27
27
|
"max_length": 8000,
|
28
|
-
"documentation": "\n <p>
|
28
|
+
"documentation": "\n <p>The body of an email communication to add to the support case.</p>\n ",
|
29
29
|
"required": true
|
30
30
|
},
|
31
31
|
"ccEmailAddresses": {
|
@@ -38,7 +38,7 @@
|
|
38
38
|
},
|
39
39
|
"min_length": 0,
|
40
40
|
"max_length": 10,
|
41
|
-
"documentation": "\n <p>
|
41
|
+
"documentation": "\n <p>The email addresses in the CC line of an email to be added to the support case.</p>\n "
|
42
42
|
}
|
43
43
|
},
|
44
44
|
"documentation": "\n <p>To be written.</p>\n "
|
@@ -50,10 +50,10 @@
|
|
50
50
|
"result": {
|
51
51
|
"shape_name": "Result",
|
52
52
|
"type": "boolean",
|
53
|
-
"documentation": "\n <p>
|
53
|
+
"documentation": "\n <p>True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an error.</p>\n "
|
54
54
|
}
|
55
55
|
},
|
56
|
-
"documentation": "\n <p>
|
56
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
57
57
|
},
|
58
58
|
"errors": [
|
59
59
|
{
|
@@ -63,10 +63,10 @@
|
|
63
63
|
"message": {
|
64
64
|
"shape_name": "ErrorMessage",
|
65
65
|
"type": "string",
|
66
|
-
"documentation": "\n <p>
|
66
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
67
67
|
}
|
68
68
|
},
|
69
|
-
"documentation": "\n <p>
|
69
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
70
70
|
},
|
71
71
|
{
|
72
72
|
"shape_name": "CaseIdNotFound",
|
@@ -75,13 +75,13 @@
|
|
75
75
|
"message": {
|
76
76
|
"shape_name": "ErrorMessage",
|
77
77
|
"type": "string",
|
78
|
-
"documentation": "\n <p>
|
78
|
+
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p> \n "
|
79
79
|
}
|
80
80
|
},
|
81
|
-
"documentation": "\n <p>
|
81
|
+
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
|
82
82
|
}
|
83
83
|
],
|
84
|
-
"documentation": "\n <p>
|
84
|
+
"documentation": "\n <p>Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication.</p>\n <p>The response indicates the success or failure of the request.</p>\n <p>This operation implements a subset of the behavior on the AWS Support <a href=\"https://aws.amazon.com/support\">Your Support Cases</a> web form.</p>\n "
|
85
85
|
},
|
86
86
|
"CreateCase": {
|
87
87
|
"name": "CreateCase",
|
@@ -92,33 +92,31 @@
|
|
92
92
|
"subject": {
|
93
93
|
"shape_name": "Subject",
|
94
94
|
"type": "string",
|
95
|
-
"documentation": "\n <p>
|
95
|
+
"documentation": "\n <p>The title of the AWS Support case.</p>\n ",
|
96
96
|
"required": true
|
97
97
|
},
|
98
98
|
"serviceCode": {
|
99
99
|
"shape_name": "ServiceCode",
|
100
100
|
"type": "string",
|
101
101
|
"pattern": "[0-9a-z\\-_]+",
|
102
|
-
"documentation": "\n <p>
|
103
|
-
"required": true
|
102
|
+
"documentation": "\n <p>The code for the AWS service returned by the call to <a>DescribeServices</a>.</p>\n "
|
104
103
|
},
|
105
104
|
"severityCode": {
|
106
105
|
"shape_name": "SeverityCode",
|
107
106
|
"type": "string",
|
108
|
-
"documentation": "\n <p>
|
107
|
+
"documentation": "\n <p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p>\n <note><p>The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.</p></note>\n \n "
|
109
108
|
},
|
110
109
|
"categoryCode": {
|
111
110
|
"shape_name": "CategoryCode",
|
112
111
|
"type": "string",
|
113
|
-
"documentation": "\n <p>
|
114
|
-
"required": true
|
112
|
+
"documentation": "\n <p>The category of problem for the AWS Support case. </p>\n "
|
115
113
|
},
|
116
114
|
"communicationBody": {
|
117
115
|
"shape_name": "CommunicationBody",
|
118
116
|
"type": "string",
|
119
117
|
"min_length": 1,
|
120
118
|
"max_length": 8000,
|
121
|
-
"documentation": "\n <p>
|
119
|
+
"documentation": "\n <p>The communication body text when you create an AWS Support case by calling <a>CreateCase</a>.</p>\n ",
|
122
120
|
"required": true
|
123
121
|
},
|
124
122
|
"ccEmailAddresses": {
|
@@ -131,17 +129,17 @@
|
|
131
129
|
},
|
132
130
|
"min_length": 0,
|
133
131
|
"max_length": 10,
|
134
|
-
"documentation": "\n <p>
|
132
|
+
"documentation": "\n <p>A list of email addresses that AWS Support copies on case correspondence.</p>\n "
|
135
133
|
},
|
136
134
|
"language": {
|
137
135
|
"shape_name": "Language",
|
138
136
|
"type": "string",
|
139
|
-
"documentation": "\n <p>
|
137
|
+
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
|
140
138
|
},
|
141
139
|
"issueType": {
|
142
140
|
"shape_name": "IssueType",
|
143
141
|
"type": "string",
|
144
|
-
"documentation": "\n <p>
|
142
|
+
"documentation": "\n <p>The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </p>\n "
|
145
143
|
}
|
146
144
|
},
|
147
145
|
"documentation": "\n \n "
|
@@ -153,10 +151,10 @@
|
|
153
151
|
"caseId": {
|
154
152
|
"shape_name": "CaseId",
|
155
153
|
"type": "string",
|
156
|
-
"documentation": "\n <p>
|
154
|
+
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
|
157
155
|
}
|
158
156
|
},
|
159
|
-
"documentation": "\n <p>
|
157
|
+
"documentation": "\n <p>The AWS Support case ID returned by a successful completion of the <a>CreateCase</a> action. </p>\n "
|
160
158
|
},
|
161
159
|
"errors": [
|
162
160
|
{
|
@@ -166,10 +164,10 @@
|
|
166
164
|
"message": {
|
167
165
|
"shape_name": "ErrorMessage",
|
168
166
|
"type": "string",
|
169
|
-
"documentation": "\n <p>
|
167
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
170
168
|
}
|
171
169
|
},
|
172
|
-
"documentation": "\n <p>
|
170
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
173
171
|
},
|
174
172
|
{
|
175
173
|
"shape_name": "CaseCreationLimitExceeded",
|
@@ -178,13 +176,13 @@
|
|
178
176
|
"message": {
|
179
177
|
"shape_name": "ErrorMessage",
|
180
178
|
"type": "string",
|
181
|
-
"documentation": "\n <p>
|
179
|
+
"documentation": "\n <p>An error message that indicates that you have exceeded the number of cases you can have open. </p>\n "
|
182
180
|
}
|
183
181
|
},
|
184
|
-
"documentation": "\n <p>
|
182
|
+
"documentation": "\n <p>The case creation limit for the account has been exceeded. </p>\n "
|
185
183
|
}
|
186
184
|
],
|
187
|
-
"documentation": "\n <p>Creates a new case in the AWS Support Center. This
|
185
|
+
"documentation": "\n <p>Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. Its parameters require you to specify the following information: </p>\n <ol>\n <li>\n<b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li>\n <li>\n<b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li>\n <li>\n<b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li>\n <li>\n<b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page.</li>\n <li>\n<b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page.</li>\n <li>\n<b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li>\n <li>\n<b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href=\"http://aws.amazon.com/tools/\">AWS SDK</a>. </li>\n <li>\n<b>IssueType.</b> The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </li>\n</ol>\n \n <note><p>The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call <a>AddCommunicationToCase</a> to add information to an open case.</p> </note>\n \n <p>A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> action to retrieve existing AWS Support cases. </p>\n \n \n "
|
188
186
|
},
|
189
187
|
"DescribeCases": {
|
190
188
|
"name": "DescribeCases",
|
@@ -202,44 +200,44 @@
|
|
202
200
|
},
|
203
201
|
"min_length": 0,
|
204
202
|
"max_length": 100,
|
205
|
-
"documentation": "\n <p>A list of
|
203
|
+
"documentation": "\n <p>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. </p>\n "
|
206
204
|
},
|
207
205
|
"displayId": {
|
208
206
|
"shape_name": "DisplayId",
|
209
207
|
"type": "string",
|
210
|
-
"documentation": "\n <p>
|
208
|
+
"documentation": "\n <p>The ID displayed for a case in the AWS Support Center user interface. </p>\n "
|
211
209
|
},
|
212
210
|
"afterTime": {
|
213
211
|
"shape_name": "AfterTime",
|
214
212
|
"type": "string",
|
215
|
-
"documentation": "\n <p>
|
213
|
+
"documentation": "\n <p>The start date for a filtered date search on support case communications.</p>\n "
|
216
214
|
},
|
217
215
|
"beforeTime": {
|
218
216
|
"shape_name": "BeforeTime",
|
219
217
|
"type": "string",
|
220
|
-
"documentation": "\n <p>
|
218
|
+
"documentation": "\n <p>The end date for a filtered date search on support case communications.</p>\n "
|
221
219
|
},
|
222
220
|
"includeResolvedCases": {
|
223
221
|
"shape_name": "IncludeResolvedCases",
|
224
222
|
"type": "boolean",
|
225
|
-
"documentation": "\n <p>
|
223
|
+
"documentation": "\n <p>Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results.</p>\n "
|
226
224
|
},
|
227
225
|
"nextToken": {
|
228
226
|
"shape_name": "NextToken",
|
229
227
|
"type": "string",
|
230
|
-
"documentation": "\n <p>
|
228
|
+
"documentation": "\n <p>A resumption point for pagination.</p> \n "
|
231
229
|
},
|
232
230
|
"maxResults": {
|
233
231
|
"shape_name": "MaxResults",
|
234
232
|
"type": "integer",
|
235
233
|
"min_length": 10,
|
236
234
|
"max_length": 100,
|
237
|
-
"documentation": "\n <p>
|
235
|
+
"documentation": "\n <p>The maximum number of results to return before paginating.</p> \n "
|
238
236
|
},
|
239
237
|
"language": {
|
240
238
|
"shape_name": "Language",
|
241
239
|
"type": "string",
|
242
|
-
"documentation": "\n <p>
|
240
|
+
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
|
243
241
|
}
|
244
242
|
},
|
245
243
|
"documentation": "\n \n "
|
@@ -258,47 +256,47 @@
|
|
258
256
|
"caseId": {
|
259
257
|
"shape_name": "CaseId",
|
260
258
|
"type": "string",
|
261
|
-
"documentation": "\n <p>
|
259
|
+
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
|
262
260
|
},
|
263
261
|
"displayId": {
|
264
262
|
"shape_name": "DisplayId",
|
265
263
|
"type": "string",
|
266
|
-
"documentation": "\n <p>
|
264
|
+
"documentation": "\n <p>The ID displayed for the case in the AWS Support Center. This is a numeric string. </p>\n "
|
267
265
|
},
|
268
266
|
"subject": {
|
269
267
|
"shape_name": "Subject",
|
270
268
|
"type": "string",
|
271
|
-
"documentation": "\n <p>
|
269
|
+
"documentation": "\n <p>The subject line for the case in the AWS Support Center.</p>\n "
|
272
270
|
},
|
273
271
|
"status": {
|
274
272
|
"shape_name": "Status",
|
275
273
|
"type": "string",
|
276
|
-
"documentation": "\n <p>
|
274
|
+
"documentation": "\n <p>The status of the case. </p>\n "
|
277
275
|
},
|
278
276
|
"serviceCode": {
|
279
277
|
"shape_name": "ServiceCode",
|
280
278
|
"type": "string",
|
281
|
-
"documentation": "\n <p>
|
279
|
+
"documentation": "\n <p>The code for the AWS service returned by the call to <a>DescribeServices</a>.</p>\n "
|
282
280
|
},
|
283
281
|
"categoryCode": {
|
284
282
|
"shape_name": "CategoryCode",
|
285
283
|
"type": "string",
|
286
|
-
"documentation": "\n <p>
|
284
|
+
"documentation": "\n <p>The category of problem for the AWS Support case.</p>\n "
|
287
285
|
},
|
288
286
|
"severityCode": {
|
289
287
|
"shape_name": "SeverityCode",
|
290
288
|
"type": "string",
|
291
|
-
"documentation": "\n <p>
|
289
|
+
"documentation": "\n <p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p>\n "
|
292
290
|
},
|
293
291
|
"submittedBy": {
|
294
292
|
"shape_name": "SubmittedBy",
|
295
293
|
"type": "string",
|
296
|
-
"documentation": "\n <p>
|
294
|
+
"documentation": "\n <p>The email address of the account that submitted the case.</p> \n "
|
297
295
|
},
|
298
296
|
"timeCreated": {
|
299
297
|
"shape_name": "TimeCreated",
|
300
298
|
"type": "string",
|
301
|
-
"documentation": "\n <p>
|
299
|
+
"documentation": "\n <p>The time that the case was case created in the AWS Support Center. </p>\n "
|
302
300
|
},
|
303
301
|
"recentCommunications": {
|
304
302
|
"shape_name": "RecentCaseCommunications",
|
@@ -314,35 +312,35 @@
|
|
314
312
|
"caseId": {
|
315
313
|
"shape_name": "CaseId",
|
316
314
|
"type": "string",
|
317
|
-
"documentation": "\n <p>
|
315
|
+
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
|
318
316
|
},
|
319
317
|
"body": {
|
320
318
|
"shape_name": "CommunicationBody",
|
321
319
|
"type": "string",
|
322
|
-
"documentation": "\n <p>
|
320
|
+
"documentation": "\n <p>The text of the communication between the customer and AWS Support.</p>\n "
|
323
321
|
},
|
324
322
|
"submittedBy": {
|
325
323
|
"shape_name": "SubmittedBy",
|
326
324
|
"type": "string",
|
327
|
-
"documentation": "\n <p>
|
325
|
+
"documentation": "\n <p>The email address of the account that submitted the AWS Support case. </p>\n "
|
328
326
|
},
|
329
327
|
"timeCreated": {
|
330
328
|
"shape_name": "TimeCreated",
|
331
329
|
"type": "string",
|
332
|
-
"documentation": "\n <p>
|
330
|
+
"documentation": "\n <p>The time the support case was created. </p>\n "
|
333
331
|
}
|
334
332
|
},
|
335
|
-
"documentation": "\n <p>
|
333
|
+
"documentation": "\n <p>Exposes the fields used by a communication for an AWS Support case.</p>\n "
|
336
334
|
},
|
337
|
-
"documentation": "\n <p>
|
335
|
+
"documentation": "\n <p>The five most recent communications associated with the case.</p>\n "
|
338
336
|
},
|
339
337
|
"nextToken": {
|
340
338
|
"shape_name": "NextToken",
|
341
339
|
"type": "string",
|
342
|
-
"documentation": "\n <p>
|
340
|
+
"documentation": "\n <p>A resumption point for pagination.</p>\n "
|
343
341
|
}
|
344
342
|
},
|
345
|
-
"documentation": "\n <p>
|
343
|
+
"documentation": "\n <p>The five most recent communications between you and AWS Support Center. Includes a <code>nextToken</code> to retrieve the next set of communications.</p>\n "
|
346
344
|
},
|
347
345
|
"ccEmailAddresses": {
|
348
346
|
"shape_name": "CcEmailAddressList",
|
@@ -352,25 +350,25 @@
|
|
352
350
|
"type": "string",
|
353
351
|
"documentation": null
|
354
352
|
},
|
355
|
-
"documentation": "\n <p>
|
353
|
+
"documentation": "\n <p>The email addresses that receive copies of communication about the case.</p>\n "
|
356
354
|
},
|
357
355
|
"language": {
|
358
356
|
"shape_name": "Language",
|
359
357
|
"type": "string",
|
360
|
-
"documentation": "\n <p>
|
358
|
+
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
|
361
359
|
}
|
362
360
|
},
|
363
|
-
"documentation": "\n <p>JSON-formatted object that contains the metadata for a support case. It is contained the response from a <a
|
361
|
+
"documentation": "\n <p>A JSON-formatted object that contains the metadata for a support case. It is contained the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p>\n <ol>\n <li>\n<b>CaseID.</b> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>.</li>\n <li>\n<b>CategoryCode.</b> The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to <a>DescribeServices</a>.</li>\n <li>\n<b>DisplayId.</b> The identifier for the case on pages in the AWS Support Center.</li>\n <li>\n<b>Language.</b> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</li>\n <li>\n<b>RecentCommunications.</b> One or more <a>Communication</a> objects. Fields of these objects are <code>Body</code>, <code>CaseId</code>, <code>SubmittedBy</code>, and <code>TimeCreated</code>.</li> \n <li>\n<b>NextToken.</b> A resumption point for pagination.</li>\n <li>\n<b>ServiceCode.</b> The identifier for the AWS service that corresponds to the service code defined in the call to <a>DescribeServices</a>.</li>\n <li>\n<b>SeverityCode. </b>The severity code assigned to the case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>.</li>\n <li>\n<b>Status.</b> The status of the case in the AWS Support Center.</li>\n <li>\n<b>Subject.</b> The subject line of the case.</li>\n <li>\n<b>SubmittedBy.</b> The email address of the account that submitted the case.</li>\n <li>\n<b>TimeCreated.</b> The time the case was created, in ISO-8601 format.</li>\n </ol>\n \n "
|
364
362
|
},
|
365
|
-
"documentation": "\n
|
363
|
+
"documentation": "\n <p>The details for the cases that match the request.</p> \n "
|
366
364
|
},
|
367
365
|
"nextToken": {
|
368
366
|
"shape_name": "NextToken",
|
369
367
|
"type": "string",
|
370
|
-
"documentation": "\n <p>
|
368
|
+
"documentation": "\n <p>A resumption point for pagination.</p>\n "
|
371
369
|
}
|
372
370
|
},
|
373
|
-
"documentation": "\n <p>Returns an array of <a
|
371
|
+
"documentation": "\n <p>Returns an array of <a>CaseDetails</a> objects and a <code>NextToken</code> that defines a point for pagination in the result set.</p>\n "
|
374
372
|
},
|
375
373
|
"errors": [
|
376
374
|
{
|
@@ -380,10 +378,10 @@
|
|
380
378
|
"message": {
|
381
379
|
"shape_name": "ErrorMessage",
|
382
380
|
"type": "string",
|
383
|
-
"documentation": "\n <p>
|
381
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
384
382
|
}
|
385
383
|
},
|
386
|
-
"documentation": "\n <p>
|
384
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
387
385
|
},
|
388
386
|
{
|
389
387
|
"shape_name": "CaseIdNotFound",
|
@@ -392,13 +390,13 @@
|
|
392
390
|
"message": {
|
393
391
|
"shape_name": "ErrorMessage",
|
394
392
|
"type": "string",
|
395
|
-
"documentation": "\n <p>
|
393
|
+
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p> \n "
|
396
394
|
}
|
397
395
|
},
|
398
|
-
"documentation": "\n <p>
|
396
|
+
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
|
399
397
|
}
|
400
398
|
],
|
401
|
-
"documentation": "\n <p>
|
399
|
+
"documentation": "\n <p>Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. </p>\n \n <p>The response returns the following in JSON format:</p> \n <ol>\n <li>One or more <a>CaseDetails</a> data types. </li>\n <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li>\n </ol>\n "
|
402
400
|
},
|
403
401
|
"DescribeCommunications": {
|
404
402
|
"name": "DescribeCommunications",
|
@@ -409,30 +407,30 @@
|
|
409
407
|
"caseId": {
|
410
408
|
"shape_name": "CaseId",
|
411
409
|
"type": "string",
|
412
|
-
"documentation": "\n <p>
|
410
|
+
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p> \n ",
|
413
411
|
"required": true
|
414
412
|
},
|
415
413
|
"beforeTime": {
|
416
414
|
"shape_name": "BeforeTime",
|
417
415
|
"type": "string",
|
418
|
-
"documentation": "\n <p>
|
416
|
+
"documentation": "\n <p>The end date for a filtered date search on support case communications.</p>\n "
|
419
417
|
},
|
420
418
|
"afterTime": {
|
421
419
|
"shape_name": "AfterTime",
|
422
420
|
"type": "string",
|
423
|
-
"documentation": "\n <p>
|
421
|
+
"documentation": "\n <p>The start date for a filtered date search on support case communications.</p>\n "
|
424
422
|
},
|
425
423
|
"nextToken": {
|
426
424
|
"shape_name": "NextToken",
|
427
425
|
"type": "string",
|
428
|
-
"documentation": "\n <p>
|
426
|
+
"documentation": "\n <p>A resumption point for pagination.</p>\n "
|
429
427
|
},
|
430
428
|
"maxResults": {
|
431
429
|
"shape_name": "MaxResults",
|
432
430
|
"type": "integer",
|
433
431
|
"min_length": 10,
|
434
432
|
"max_length": 100,
|
435
|
-
"documentation": "\n <p>
|
433
|
+
"documentation": "\n <p>The maximum number of results to return before paginating.</p>\n "
|
436
434
|
}
|
437
435
|
},
|
438
436
|
"documentation": "\n \n "
|
@@ -451,35 +449,35 @@
|
|
451
449
|
"caseId": {
|
452
450
|
"shape_name": "CaseId",
|
453
451
|
"type": "string",
|
454
|
-
"documentation": "\n <p>
|
452
|
+
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
|
455
453
|
},
|
456
454
|
"body": {
|
457
455
|
"shape_name": "CommunicationBody",
|
458
456
|
"type": "string",
|
459
|
-
"documentation": "\n <p>
|
457
|
+
"documentation": "\n <p>The text of the communication between the customer and AWS Support.</p>\n "
|
460
458
|
},
|
461
459
|
"submittedBy": {
|
462
460
|
"shape_name": "SubmittedBy",
|
463
461
|
"type": "string",
|
464
|
-
"documentation": "\n <p>
|
462
|
+
"documentation": "\n <p>The email address of the account that submitted the AWS Support case. </p>\n "
|
465
463
|
},
|
466
464
|
"timeCreated": {
|
467
465
|
"shape_name": "TimeCreated",
|
468
466
|
"type": "string",
|
469
|
-
"documentation": "\n <p>
|
467
|
+
"documentation": "\n <p>The time the support case was created. </p>\n "
|
470
468
|
}
|
471
469
|
},
|
472
|
-
"documentation": "\n <p>
|
470
|
+
"documentation": "\n <p>Exposes the fields used by a communication for an AWS Support case.</p>\n "
|
473
471
|
},
|
474
|
-
"documentation": "\n <p>
|
472
|
+
"documentation": "\n <p>The communications for the case.</p>\n "
|
475
473
|
},
|
476
474
|
"nextToken": {
|
477
475
|
"shape_name": "NextToken",
|
478
476
|
"type": "string",
|
479
|
-
"documentation": "\n <p>
|
477
|
+
"documentation": "\n <p>A resumption point for pagination.</p>\n "
|
480
478
|
}
|
481
479
|
},
|
482
|
-
"documentation": "\n <p>
|
480
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
483
481
|
},
|
484
482
|
"errors": [
|
485
483
|
{
|
@@ -489,10 +487,10 @@
|
|
489
487
|
"message": {
|
490
488
|
"shape_name": "ErrorMessage",
|
491
489
|
"type": "string",
|
492
|
-
"documentation": "\n <p>
|
490
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
493
491
|
}
|
494
492
|
},
|
495
|
-
"documentation": "\n <p>
|
493
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
496
494
|
},
|
497
495
|
{
|
498
496
|
"shape_name": "CaseIdNotFound",
|
@@ -501,13 +499,13 @@
|
|
501
499
|
"message": {
|
502
500
|
"shape_name": "ErrorMessage",
|
503
501
|
"type": "string",
|
504
|
-
"documentation": "\n <p>
|
502
|
+
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p> \n "
|
505
503
|
}
|
506
504
|
},
|
507
|
-
"documentation": "\n <p>
|
505
|
+
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
|
508
506
|
}
|
509
507
|
],
|
510
|
-
"documentation": "\n <p>
|
508
|
+
"documentation": "\n <p>Returns communications regarding the support case. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. The <code>CaseId</code> parameter enables you to identify a specific case by its <code>CaseId</code> value.</p>\n <p>The <code>MaxResults</code> and <code>NextToken</code> parameters enable you to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination.</p>\n "
|
511
509
|
},
|
512
510
|
"DescribeServices": {
|
513
511
|
"name": "DescribeServices",
|
@@ -526,12 +524,12 @@
|
|
526
524
|
},
|
527
525
|
"min_length": 0,
|
528
526
|
"max_length": 100,
|
529
|
-
"documentation": "\n <p>
|
527
|
+
"documentation": "\n <p>A JSON-formatted list of service codes available for AWS services.</p>\n "
|
530
528
|
},
|
531
529
|
"language": {
|
532
530
|
"shape_name": "Language",
|
533
531
|
"type": "string",
|
534
|
-
"documentation": "\n <p>
|
532
|
+
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
|
535
533
|
}
|
536
534
|
},
|
537
535
|
"documentation": "\n \n "
|
@@ -550,12 +548,12 @@
|
|
550
548
|
"code": {
|
551
549
|
"shape_name": "ServiceCode",
|
552
550
|
"type": "string",
|
553
|
-
"documentation": "\n <p>
|
551
|
+
"documentation": "\n <p>The code for an AWS service returned by <a>DescribeServices</a> response. Has a corresponding name represented by Service.name.</p>\n "
|
554
552
|
},
|
555
553
|
"name": {
|
556
554
|
"shape_name": "ServiceName",
|
557
555
|
"type": "string",
|
558
|
-
"documentation": "\n <p>
|
556
|
+
"documentation": "\n <p>The friendly name for an AWS service. Has a corresponding code represented by Service.code. </p>\n "
|
559
557
|
},
|
560
558
|
"categories": {
|
561
559
|
"shape_name": "CategoryList",
|
@@ -567,25 +565,25 @@
|
|
567
565
|
"code": {
|
568
566
|
"shape_name": "CategoryCode",
|
569
567
|
"type": "string",
|
570
|
-
"documentation": "\n <p>
|
568
|
+
"documentation": "\n <p>The category code for the support case. </p>\n "
|
571
569
|
},
|
572
570
|
"name": {
|
573
571
|
"shape_name": "CategoryName",
|
574
572
|
"type": "string",
|
575
|
-
"documentation": "\n <p>
|
573
|
+
"documentation": "\n <p>The category name for the support case. </p>\n "
|
576
574
|
}
|
577
575
|
},
|
578
|
-
"documentation": "\n <p>JSON-formatted name/value pair that represents the name and category of problem selected from the <a
|
576
|
+
"documentation": "\n <p>A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the <a>DescribeServices</a> response for each AWS service.</p>\n "
|
579
577
|
},
|
580
|
-
"documentation": "\n <p>
|
578
|
+
"documentation": "\n <p>A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call <a>CreateCase</a>.</p>\n "
|
581
579
|
}
|
582
580
|
},
|
583
|
-
"documentation": "\n <p>
|
581
|
+
"documentation": "\n <p>Represents an AWS Service returned by the <a>DescribeServices</a> action. </p>\n "
|
584
582
|
},
|
585
|
-
"documentation": "\n <p>JSON-formatted list of AWS services.</p>\n "
|
583
|
+
"documentation": "\n <p>A JSON-formatted list of AWS services.</p>\n "
|
586
584
|
}
|
587
585
|
},
|
588
|
-
"documentation": "\n <p>
|
586
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
589
587
|
},
|
590
588
|
"errors": [
|
591
589
|
{
|
@@ -595,13 +593,13 @@
|
|
595
593
|
"message": {
|
596
594
|
"shape_name": "ErrorMessage",
|
597
595
|
"type": "string",
|
598
|
-
"documentation": "\n <p>
|
596
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
599
597
|
}
|
600
598
|
},
|
601
|
-
"documentation": "\n <p>
|
599
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
602
600
|
}
|
603
601
|
],
|
604
|
-
"documentation": "\n <p>Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a
|
602
|
+
"documentation": "\n <p>Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories.</p>\n \n<p>The service codes and category codes correspond to the values that are displayed in the\n <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. The values in those\n fields, however, do not necessarily match the service codes and categories returned by the\n <code>DescribeServices</code> request. Always use the service codes and categories obtained\n programmatically. This practice ensures that you always have the most recent set of service\n and category codes.</p> \n \n "
|
605
603
|
},
|
606
604
|
"DescribeSeverityLevels": {
|
607
605
|
"name": "DescribeSeverityLevels",
|
@@ -612,7 +610,7 @@
|
|
612
610
|
"language": {
|
613
611
|
"shape_name": "Language",
|
614
612
|
"type": "string",
|
615
|
-
"documentation": "\n <p>
|
613
|
+
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
|
616
614
|
}
|
617
615
|
},
|
618
616
|
"documentation": " \n "
|
@@ -631,20 +629,20 @@
|
|
631
629
|
"code": {
|
632
630
|
"shape_name": "SeverityLevelCode",
|
633
631
|
"type": "string",
|
634
|
-
"documentation": "\n <p>
|
632
|
+
"documentation": "\n <p>One of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in <code>SeverityLevel.name</code>. </p>\n "
|
635
633
|
},
|
636
634
|
"name": {
|
637
635
|
"shape_name": "SeverityLevelName",
|
638
636
|
"type": "string",
|
639
|
-
"documentation": "\n <p>
|
637
|
+
"documentation": "\n <p>The name of the severity level that corresponds to the severity level code.</p>\n "
|
640
638
|
}
|
641
639
|
},
|
642
|
-
"documentation": "\n <p>
|
640
|
+
"documentation": "\n <p>A code and name pair that represent a severity level that can be applied to a support case. </p>\n "
|
643
641
|
},
|
644
|
-
"documentation": "\n <p>
|
642
|
+
"documentation": "\n <p>The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.</p>\n "
|
645
643
|
}
|
646
644
|
},
|
647
|
-
"documentation": "\n <p>
|
645
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
648
646
|
},
|
649
647
|
"errors": [
|
650
648
|
{
|
@@ -654,13 +652,13 @@
|
|
654
652
|
"message": {
|
655
653
|
"shape_name": "ErrorMessage",
|
656
654
|
"type": "string",
|
657
|
-
"documentation": "\n <p>
|
655
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
658
656
|
}
|
659
657
|
},
|
660
|
-
"documentation": "\n <p>
|
658
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
661
659
|
}
|
662
660
|
],
|
663
|
-
"documentation": "\n <p>
|
661
|
+
"documentation": "\n <p>Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </p>\n \n "
|
664
662
|
},
|
665
663
|
"DescribeTrustedAdvisorCheckRefreshStatuses": {
|
666
664
|
"name": "DescribeTrustedAdvisorCheckRefreshStatuses",
|
@@ -676,7 +674,7 @@
|
|
676
674
|
"type": "string",
|
677
675
|
"documentation": null
|
678
676
|
},
|
679
|
-
"documentation": "\n <p>
|
677
|
+
"documentation": "\n <p>The IDs of the Trusted Advisor checks.</p>\n ",
|
680
678
|
"required": true
|
681
679
|
}
|
682
680
|
},
|
@@ -696,29 +694,29 @@
|
|
696
694
|
"checkId": {
|
697
695
|
"shape_name": "String",
|
698
696
|
"type": "string",
|
699
|
-
"documentation": "\n <p>
|
697
|
+
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
|
700
698
|
"required": true
|
701
699
|
},
|
702
700
|
"status": {
|
703
701
|
"shape_name": "String",
|
704
702
|
"type": "string",
|
705
|
-
"documentation": "\n <p>
|
703
|
+
"documentation": "\n <p>The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</p>\n ",
|
706
704
|
"required": true
|
707
705
|
},
|
708
706
|
"millisUntilNextRefreshable": {
|
709
707
|
"shape_name": "Long",
|
710
708
|
"type": "long",
|
711
|
-
"documentation": "\n <p>
|
709
|
+
"documentation": "\n <p>The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.</p>\n ",
|
712
710
|
"required": true
|
713
711
|
}
|
714
712
|
},
|
715
|
-
"documentation": "\n <p>
|
713
|
+
"documentation": "\n <p>The refresh status of a Trusted Advisor check. </p>\n "
|
716
714
|
},
|
717
|
-
"documentation": "\n <p>
|
715
|
+
"documentation": "\n <p>The refresh status of the specified Trusted Advisor checks.</p>\n ",
|
718
716
|
"required": true
|
719
717
|
}
|
720
718
|
},
|
721
|
-
"documentation": "\n <p>
|
719
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
722
720
|
},
|
723
721
|
"errors": [
|
724
722
|
{
|
@@ -728,13 +726,13 @@
|
|
728
726
|
"message": {
|
729
727
|
"shape_name": "ErrorMessage",
|
730
728
|
"type": "string",
|
731
|
-
"documentation": "\n <p>
|
729
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
732
730
|
}
|
733
731
|
},
|
734
|
-
"documentation": "\n <p>
|
732
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
735
733
|
}
|
736
734
|
],
|
737
|
-
"documentation": "\n <p>Returns the status of
|
735
|
+
"documentation": "\n <p>Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p>\n "
|
738
736
|
},
|
739
737
|
"DescribeTrustedAdvisorCheckResult": {
|
740
738
|
"name": "DescribeTrustedAdvisorCheckResult",
|
@@ -745,16 +743,16 @@
|
|
745
743
|
"checkId": {
|
746
744
|
"shape_name": "String",
|
747
745
|
"type": "string",
|
748
|
-
"documentation": "
|
746
|
+
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
|
749
747
|
"required": true
|
750
748
|
},
|
751
749
|
"language": {
|
752
750
|
"shape_name": "String",
|
753
751
|
"type": "string",
|
754
|
-
"documentation": "\n <p>
|
752
|
+
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
|
755
753
|
}
|
756
754
|
},
|
757
|
-
"documentation": "\n
|
755
|
+
"documentation": "\n "
|
758
756
|
},
|
759
757
|
"output": {
|
760
758
|
"shape_name": "DescribeTrustedAdvisorCheckResultResponse",
|
@@ -767,19 +765,19 @@
|
|
767
765
|
"checkId": {
|
768
766
|
"shape_name": "String",
|
769
767
|
"type": "string",
|
770
|
-
"documentation": "\n <p>
|
768
|
+
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
|
771
769
|
"required": true
|
772
770
|
},
|
773
771
|
"timestamp": {
|
774
772
|
"shape_name": "String",
|
775
773
|
"type": "string",
|
776
|
-
"documentation": "\n <p>
|
774
|
+
"documentation": "\n <p>The time of the last refresh of the check.</p>\n ",
|
777
775
|
"required": true
|
778
776
|
},
|
779
777
|
"status": {
|
780
778
|
"shape_name": "String",
|
781
779
|
"type": "string",
|
782
|
-
"documentation": "\n <p>
|
780
|
+
"documentation": "\n <p>The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</p>\n ",
|
783
781
|
"required": true
|
784
782
|
},
|
785
783
|
"resourcesSummary": {
|
@@ -789,29 +787,29 @@
|
|
789
787
|
"resourcesProcessed": {
|
790
788
|
"shape_name": "Long",
|
791
789
|
"type": "long",
|
792
|
-
"documentation": "\n <p>
|
790
|
+
"documentation": "\n <p>The number of AWS resources that were analyzed by the Trusted Advisor check.</p>\n ",
|
793
791
|
"required": true
|
794
792
|
},
|
795
793
|
"resourcesFlagged": {
|
796
794
|
"shape_name": "Long",
|
797
795
|
"type": "long",
|
798
|
-
"documentation": "\n <p>
|
796
|
+
"documentation": "\n <p>The number of AWS resources that were flagged (listed) by the Trusted Advisor check.</p>\n ",
|
799
797
|
"required": true
|
800
798
|
},
|
801
799
|
"resourcesIgnored": {
|
802
800
|
"shape_name": "Long",
|
803
801
|
"type": "long",
|
804
|
-
"documentation": "\n <p>
|
802
|
+
"documentation": "\n <p>The number of AWS resources ignored by Trusted Advisor because information was unavailable.</p>\n ",
|
805
803
|
"required": true
|
806
804
|
},
|
807
805
|
"resourcesSuppressed": {
|
808
806
|
"shape_name": "Long",
|
809
807
|
"type": "long",
|
810
|
-
"documentation": "\n <p>
|
808
|
+
"documentation": "\n <p>The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.</p>\n ",
|
811
809
|
"required": true
|
812
810
|
}
|
813
811
|
},
|
814
|
-
"documentation": "\n <p>
|
812
|
+
"documentation": "\n <p>Details about AWS resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>. </p>\n ",
|
815
813
|
"required": true
|
816
814
|
},
|
817
815
|
"categorySpecificSummary": {
|
@@ -825,20 +823,20 @@
|
|
825
823
|
"estimatedMonthlySavings": {
|
826
824
|
"shape_name": "Double",
|
827
825
|
"type": "double",
|
828
|
-
"documentation": "\n <p>
|
826
|
+
"documentation": "\n <p>The estimated monthly savings that might be realized if the recommended actions are taken.</p>\n ",
|
829
827
|
"required": true
|
830
828
|
},
|
831
829
|
"estimatedPercentMonthlySavings": {
|
832
830
|
"shape_name": "Double",
|
833
831
|
"type": "double",
|
834
|
-
"documentation": "\n <p>
|
832
|
+
"documentation": "\n <p>The estimated percentage of savings that might be realized if the recommended actions are taken.</p>\n ",
|
835
833
|
"required": true
|
836
834
|
}
|
837
835
|
},
|
838
|
-
"documentation": "\n <p>
|
836
|
+
"documentation": "\n <p>The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.</p>\n "
|
839
837
|
}
|
840
838
|
},
|
841
|
-
"documentation": "\n <p>
|
839
|
+
"documentation": "\n <p>Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.</p>\n ",
|
842
840
|
"required": true
|
843
841
|
},
|
844
842
|
"flaggedResources": {
|
@@ -851,25 +849,25 @@
|
|
851
849
|
"status": {
|
852
850
|
"shape_name": "String",
|
853
851
|
"type": "string",
|
854
|
-
"documentation": "\n <p>
|
852
|
+
"documentation": "\n <p>The status code for the resource identified in the Trusted Advisor check.</p>\n ",
|
855
853
|
"required": true
|
856
854
|
},
|
857
855
|
"region": {
|
858
856
|
"shape_name": "String",
|
859
857
|
"type": "string",
|
860
|
-
"documentation": "\n <p>AWS region in which the identified resource is located. </p>\n ",
|
858
|
+
"documentation": "\n <p>The AWS region in which the identified resource is located. </p>\n ",
|
861
859
|
"required": true
|
862
860
|
},
|
863
861
|
"resourceId": {
|
864
862
|
"shape_name": "String",
|
865
863
|
"type": "string",
|
866
|
-
"documentation": "\n <p>
|
864
|
+
"documentation": "\n <p>The unique identifier for the identified resource.</p>\n ",
|
867
865
|
"required": true
|
868
866
|
},
|
869
867
|
"isSuppressed": {
|
870
868
|
"shape_name": "Boolean",
|
871
869
|
"type": "boolean",
|
872
|
-
"documentation": "\n <p>
|
870
|
+
"documentation": "\n <p>Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.</p>\n "
|
873
871
|
},
|
874
872
|
"metadata": {
|
875
873
|
"shape_name": "StringList",
|
@@ -879,20 +877,20 @@
|
|
879
877
|
"type": "string",
|
880
878
|
"documentation": null
|
881
879
|
},
|
882
|
-
"documentation": "\n <p>Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the <a
|
880
|
+
"documentation": "\n <p>Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the <a>TrustedAdvisorCheckDescription</a> object returned by the call to <a>DescribeTrustedAdvisorChecks</a>.</p>\n ",
|
883
881
|
"required": true
|
884
882
|
}
|
885
883
|
},
|
886
|
-
"documentation": "\n <p>
|
884
|
+
"documentation": "\n <p>Contains information about a resource identified by a Trusted Advisor check. </p>\n "
|
887
885
|
},
|
888
|
-
"documentation": "\n <p>
|
886
|
+
"documentation": "\n <p>The details about each resource listed in the check result.</p>\n ",
|
889
887
|
"required": true
|
890
888
|
}
|
891
889
|
},
|
892
|
-
"documentation": "\n <p>
|
890
|
+
"documentation": "\n <p>The detailed results of the Trusted Advisor check.</p>\n "
|
893
891
|
}
|
894
892
|
},
|
895
|
-
"documentation": "\n <p>
|
893
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
896
894
|
},
|
897
895
|
"errors": [
|
898
896
|
{
|
@@ -902,13 +900,13 @@
|
|
902
900
|
"message": {
|
903
901
|
"shape_name": "ErrorMessage",
|
904
902
|
"type": "string",
|
905
|
-
"documentation": "\n <p>
|
903
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
906
904
|
}
|
907
905
|
},
|
908
|
-
"documentation": "\n <p>
|
906
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
909
907
|
}
|
910
908
|
],
|
911
|
-
"documentation": "\n <p>
|
909
|
+
"documentation": "\n <p>Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p>\n <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects:</p>\n <ul>\n <li><a>TrustedAdvisorCategorySpecificSummary</a></li>\n <li><a>TrustedAdvisorResourceDetail</a></li>\n <li><a>TrustedAdvisorResourcesSummary</a></li>\n </ul>\n<p>In addition, the response contains these fields:</p>\n <ul>\n <li>\n<b>Status.</b> The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</li>\n <li>\n<b>Timestamp.</b> The time of the last refresh of the check.</li>\n <li>\n<b>CheckId.</b> The unique identifier for the check.</li>\n </ul>\n "
|
912
910
|
},
|
913
911
|
"DescribeTrustedAdvisorCheckSummaries": {
|
914
912
|
"name": "DescribeTrustedAdvisorCheckSummaries",
|
@@ -924,7 +922,7 @@
|
|
924
922
|
"type": "string",
|
925
923
|
"documentation": null
|
926
924
|
},
|
927
|
-
"documentation": "\n <p>
|
925
|
+
"documentation": "\n <p>The IDs of the Trusted Advisor checks.</p>\n ",
|
928
926
|
"required": true
|
929
927
|
}
|
930
928
|
},
|
@@ -944,25 +942,25 @@
|
|
944
942
|
"checkId": {
|
945
943
|
"shape_name": "String",
|
946
944
|
"type": "string",
|
947
|
-
"documentation": "\n <p>
|
945
|
+
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
|
948
946
|
"required": true
|
949
947
|
},
|
950
948
|
"timestamp": {
|
951
949
|
"shape_name": "String",
|
952
950
|
"type": "string",
|
953
|
-
"documentation": "\n <p
|
951
|
+
"documentation": "\n <p>The time of the last refresh of the check.</p>\n ",
|
954
952
|
"required": true
|
955
953
|
},
|
956
954
|
"status": {
|
957
955
|
"shape_name": "String",
|
958
956
|
"type": "string",
|
959
|
-
"documentation": "\n <p>
|
957
|
+
"documentation": "\n <p>The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</p>\n ",
|
960
958
|
"required": true
|
961
959
|
},
|
962
960
|
"hasFlaggedResources": {
|
963
961
|
"shape_name": "Boolean",
|
964
962
|
"type": "boolean",
|
965
|
-
"documentation": "\n <p>
|
963
|
+
"documentation": "\n <p>Specifies whether the Trusted Advisor check has flagged resources.</p>\n "
|
966
964
|
},
|
967
965
|
"resourcesSummary": {
|
968
966
|
"shape_name": "TrustedAdvisorResourcesSummary",
|
@@ -971,29 +969,29 @@
|
|
971
969
|
"resourcesProcessed": {
|
972
970
|
"shape_name": "Long",
|
973
971
|
"type": "long",
|
974
|
-
"documentation": "\n <p>
|
972
|
+
"documentation": "\n <p>The number of AWS resources that were analyzed by the Trusted Advisor check.</p>\n ",
|
975
973
|
"required": true
|
976
974
|
},
|
977
975
|
"resourcesFlagged": {
|
978
976
|
"shape_name": "Long",
|
979
977
|
"type": "long",
|
980
|
-
"documentation": "\n <p>
|
978
|
+
"documentation": "\n <p>The number of AWS resources that were flagged (listed) by the Trusted Advisor check.</p>\n ",
|
981
979
|
"required": true
|
982
980
|
},
|
983
981
|
"resourcesIgnored": {
|
984
982
|
"shape_name": "Long",
|
985
983
|
"type": "long",
|
986
|
-
"documentation": "\n <p>
|
984
|
+
"documentation": "\n <p>The number of AWS resources ignored by Trusted Advisor because information was unavailable.</p>\n ",
|
987
985
|
"required": true
|
988
986
|
},
|
989
987
|
"resourcesSuppressed": {
|
990
988
|
"shape_name": "Long",
|
991
989
|
"type": "long",
|
992
|
-
"documentation": "\n <p>
|
990
|
+
"documentation": "\n <p>The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.</p>\n ",
|
993
991
|
"required": true
|
994
992
|
}
|
995
993
|
},
|
996
|
-
"documentation": "\n <p>
|
994
|
+
"documentation": "\n <p>Details about AWS resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>. </p>\n ",
|
997
995
|
"required": true
|
998
996
|
},
|
999
997
|
"categorySpecificSummary": {
|
@@ -1007,30 +1005,30 @@
|
|
1007
1005
|
"estimatedMonthlySavings": {
|
1008
1006
|
"shape_name": "Double",
|
1009
1007
|
"type": "double",
|
1010
|
-
"documentation": "\n <p>
|
1008
|
+
"documentation": "\n <p>The estimated monthly savings that might be realized if the recommended actions are taken.</p>\n ",
|
1011
1009
|
"required": true
|
1012
1010
|
},
|
1013
1011
|
"estimatedPercentMonthlySavings": {
|
1014
1012
|
"shape_name": "Double",
|
1015
1013
|
"type": "double",
|
1016
|
-
"documentation": "\n <p>
|
1014
|
+
"documentation": "\n <p>The estimated percentage of savings that might be realized if the recommended actions are taken.</p>\n ",
|
1017
1015
|
"required": true
|
1018
1016
|
}
|
1019
1017
|
},
|
1020
|
-
"documentation": "\n <p>
|
1018
|
+
"documentation": "\n <p>The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.</p>\n "
|
1021
1019
|
}
|
1022
1020
|
},
|
1023
|
-
"documentation": "\n <p>
|
1021
|
+
"documentation": "\n <p>Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.</p>\n ",
|
1024
1022
|
"required": true
|
1025
1023
|
}
|
1026
1024
|
},
|
1027
|
-
"documentation": "\n <p>
|
1025
|
+
"documentation": "\n <p>A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.</p>\n "
|
1028
1026
|
},
|
1029
|
-
"documentation": "\n
|
1027
|
+
"documentation": "\n <p>The summary information for the requested Trusted Advisor checks.</p>\n ",
|
1030
1028
|
"required": true
|
1031
1029
|
}
|
1032
1030
|
},
|
1033
|
-
"documentation": "\n <p>
|
1031
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
1034
1032
|
},
|
1035
1033
|
"errors": [
|
1036
1034
|
{
|
@@ -1040,13 +1038,13 @@
|
|
1040
1038
|
"message": {
|
1041
1039
|
"shape_name": "ErrorMessage",
|
1042
1040
|
"type": "string",
|
1043
|
-
"documentation": "\n <p>
|
1041
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
1044
1042
|
}
|
1045
1043
|
},
|
1046
|
-
"documentation": "\n <p>
|
1044
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
1047
1045
|
}
|
1048
1046
|
],
|
1049
|
-
"documentation": "\n <p>
|
1047
|
+
"documentation": "\n <p>Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p> \n <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects.</p> \n "
|
1050
1048
|
},
|
1051
1049
|
"DescribeTrustedAdvisorChecks": {
|
1052
1050
|
"name": "DescribeTrustedAdvisorChecks",
|
@@ -1057,7 +1055,7 @@
|
|
1057
1055
|
"language": {
|
1058
1056
|
"shape_name": "String",
|
1059
1057
|
"type": "string",
|
1060
|
-
"documentation": "\n <p>
|
1058
|
+
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n ",
|
1061
1059
|
"required": true
|
1062
1060
|
}
|
1063
1061
|
},
|
@@ -1077,25 +1075,25 @@
|
|
1077
1075
|
"id": {
|
1078
1076
|
"shape_name": "String",
|
1079
1077
|
"type": "string",
|
1080
|
-
"documentation": "\n <p>
|
1078
|
+
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
|
1081
1079
|
"required": true
|
1082
1080
|
},
|
1083
1081
|
"name": {
|
1084
1082
|
"shape_name": "String",
|
1085
1083
|
"type": "string",
|
1086
|
-
"documentation": "\n <p>
|
1084
|
+
"documentation": "\n <p>The display name for the Trusted Advisor check.</p>\n ",
|
1087
1085
|
"required": true
|
1088
1086
|
},
|
1089
1087
|
"description": {
|
1090
1088
|
"shape_name": "String",
|
1091
1089
|
"type": "string",
|
1092
|
-
"documentation": "\n <p>
|
1090
|
+
"documentation": "\n <p>The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).</p>\n ",
|
1093
1091
|
"required": true
|
1094
1092
|
},
|
1095
1093
|
"category": {
|
1096
1094
|
"shape_name": "String",
|
1097
1095
|
"type": "string",
|
1098
|
-
"documentation": "\n <p>
|
1096
|
+
"documentation": "\n <p>The category of the Trusted Advisor check.</p>\n ",
|
1099
1097
|
"required": true
|
1100
1098
|
},
|
1101
1099
|
"metadata": {
|
@@ -1106,17 +1104,17 @@
|
|
1106
1104
|
"type": "string",
|
1107
1105
|
"documentation": null
|
1108
1106
|
},
|
1109
|
-
"documentation": "\n <p>
|
1107
|
+
"documentation": "\n <p>The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the <b>Metadata</b> element of the <a>TrustedAdvisorResourceDetail</a> for the check.</p>\n ",
|
1110
1108
|
"required": true
|
1111
1109
|
}
|
1112
1110
|
},
|
1113
|
-
"documentation": "\n <p>
|
1111
|
+
"documentation": "\n <p>The description and metadata for a Trusted Advisor check.</p>\n "
|
1114
1112
|
},
|
1115
|
-
"documentation": "\n
|
1113
|
+
"documentation": "\n <p>Information about all available Trusted Advisor checks.</p>\n ",
|
1116
1114
|
"required": true
|
1117
1115
|
}
|
1118
1116
|
},
|
1119
|
-
"documentation": "\n <p>
|
1117
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
1120
1118
|
},
|
1121
1119
|
"errors": [
|
1122
1120
|
{
|
@@ -1126,13 +1124,13 @@
|
|
1126
1124
|
"message": {
|
1127
1125
|
"shape_name": "ErrorMessage",
|
1128
1126
|
"type": "string",
|
1129
|
-
"documentation": "\n <p>
|
1127
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
1130
1128
|
}
|
1131
1129
|
},
|
1132
|
-
"documentation": "\n <p>
|
1130
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
1133
1131
|
}
|
1134
1132
|
],
|
1135
|
-
"documentation": "\n <p>
|
1133
|
+
"documentation": "\n <p>Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English (\"en\") and Japanese (\"ja\") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check.</p> \n "
|
1136
1134
|
},
|
1137
1135
|
"RefreshTrustedAdvisorCheck": {
|
1138
1136
|
"name": "RefreshTrustedAdvisorCheck",
|
@@ -1143,7 +1141,7 @@
|
|
1143
1141
|
"checkId": {
|
1144
1142
|
"shape_name": "String",
|
1145
1143
|
"type": "string",
|
1146
|
-
"documentation": "\n
|
1144
|
+
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
|
1147
1145
|
"required": true
|
1148
1146
|
}
|
1149
1147
|
},
|
@@ -1160,27 +1158,27 @@
|
|
1160
1158
|
"checkId": {
|
1161
1159
|
"shape_name": "String",
|
1162
1160
|
"type": "string",
|
1163
|
-
"documentation": "\n <p>
|
1161
|
+
"documentation": "\n <p>The unique identifier for the Trusted Advisor check.</p>\n ",
|
1164
1162
|
"required": true
|
1165
1163
|
},
|
1166
1164
|
"status": {
|
1167
1165
|
"shape_name": "String",
|
1168
1166
|
"type": "string",
|
1169
|
-
"documentation": "\n <p>
|
1167
|
+
"documentation": "\n <p>The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</p>\n ",
|
1170
1168
|
"required": true
|
1171
1169
|
},
|
1172
1170
|
"millisUntilNextRefreshable": {
|
1173
1171
|
"shape_name": "Long",
|
1174
1172
|
"type": "long",
|
1175
|
-
"documentation": "\n <p>
|
1173
|
+
"documentation": "\n <p>The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.</p>\n ",
|
1176
1174
|
"required": true
|
1177
1175
|
}
|
1178
1176
|
},
|
1179
|
-
"documentation": "\n <p>
|
1177
|
+
"documentation": "\n <p>The current refresh status for a check, including the amount of time until the check is eligible for refresh. </p>\n ",
|
1180
1178
|
"required": true
|
1181
1179
|
}
|
1182
1180
|
},
|
1183
|
-
"documentation": "\n "
|
1181
|
+
"documentation": "\n <p>The current refresh status of a Trusted Advisor check.</p>\n "
|
1184
1182
|
},
|
1185
1183
|
"errors": [
|
1186
1184
|
{
|
@@ -1190,13 +1188,13 @@
|
|
1190
1188
|
"message": {
|
1191
1189
|
"shape_name": "ErrorMessage",
|
1192
1190
|
"type": "string",
|
1193
|
-
"documentation": "\n <p>
|
1191
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
1194
1192
|
}
|
1195
1193
|
},
|
1196
|
-
"documentation": "\n <p>
|
1194
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
1197
1195
|
}
|
1198
1196
|
],
|
1199
|
-
"documentation": "\n <p>
|
1197
|
+
"documentation": "\n <p>Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p>\n <p>The response contains a <a>RefreshTrustedAdvisorCheckResult</a> object, which contains these fields:</p>\n <ul>\n <li>\n<b>Status.</b> The refresh status of the check: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</li>\n <li>\n<b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li>\n <li>\n<b>CheckId.</b> The unique identifier for the check.</li>\n </ul>\n "
|
1200
1198
|
},
|
1201
1199
|
"ResolveCase": {
|
1202
1200
|
"name": "ResolveCase",
|
@@ -1207,7 +1205,7 @@
|
|
1207
1205
|
"caseId": {
|
1208
1206
|
"shape_name": "CaseId",
|
1209
1207
|
"type": "string",
|
1210
|
-
"documentation": "\n <p>
|
1208
|
+
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
|
1211
1209
|
}
|
1212
1210
|
},
|
1213
1211
|
"documentation": "\n \n "
|
@@ -1219,15 +1217,15 @@
|
|
1219
1217
|
"initialCaseStatus": {
|
1220
1218
|
"shape_name": "CaseStatus",
|
1221
1219
|
"type": "string",
|
1222
|
-
"documentation": "\n <p>
|
1220
|
+
"documentation": "\n <p>The status of the case when the <a>ResolveCase</a> request was sent.</p>\n "
|
1223
1221
|
},
|
1224
1222
|
"finalCaseStatus": {
|
1225
1223
|
"shape_name": "CaseStatus",
|
1226
1224
|
"type": "string",
|
1227
|
-
"documentation": "\n <p>
|
1225
|
+
"documentation": "\n <p>The status of the case after the <a>ResolveCase</a> request was processed.</p>\n "
|
1228
1226
|
}
|
1229
1227
|
},
|
1230
|
-
"documentation": "\n <p>
|
1228
|
+
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
1231
1229
|
},
|
1232
1230
|
"errors": [
|
1233
1231
|
{
|
@@ -1237,10 +1235,10 @@
|
|
1237
1235
|
"message": {
|
1238
1236
|
"shape_name": "ErrorMessage",
|
1239
1237
|
"type": "string",
|
1240
|
-
"documentation": "\n <p>
|
1238
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
1241
1239
|
}
|
1242
1240
|
},
|
1243
|
-
"documentation": "\n <p>
|
1241
|
+
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
1244
1242
|
},
|
1245
1243
|
{
|
1246
1244
|
"shape_name": "CaseIdNotFound",
|
@@ -1249,13 +1247,13 @@
|
|
1249
1247
|
"message": {
|
1250
1248
|
"shape_name": "ErrorMessage",
|
1251
1249
|
"type": "string",
|
1252
|
-
"documentation": "\n <p>
|
1250
|
+
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p> \n "
|
1253
1251
|
}
|
1254
1252
|
},
|
1255
|
-
"documentation": "\n <p>
|
1253
|
+
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
|
1256
1254
|
}
|
1257
1255
|
],
|
1258
|
-
"documentation": "\n \n <p>Takes a <
|
1256
|
+
"documentation": "\n \n <p>Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed.</p>\n "
|
1259
1257
|
}
|
1260
1258
|
}
|
1261
1259
|
}
|