aws-sdk-core 2.0.48 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (197) hide show
  1. checksums.yaml +4 -4
  2. data/apis/autoscaling/2011-01-01/api-2.json +636 -33
  3. data/apis/cloudhsm/2014-05-30/api-2.json +3 -6
  4. data/apis/ec2/2014-10-01/api-2.json +10267 -0
  5. data/apis/ec2/2014-10-01/paginators-1.json +125 -0
  6. data/apis/ec2/2014-10-01/resources-1.json +2289 -0
  7. data/apis/ec2/2014-10-01/waiters-2.json +453 -0
  8. data/apis/ec2/2015-03-01/api-2.json +11245 -0
  9. data/apis/ec2/2015-03-01/paginators-1.json +125 -0
  10. data/apis/ec2/2015-03-01/resources-1.json +2479 -0
  11. data/apis/ec2/2015-03-01/waiters-2.json +458 -0
  12. data/apis/ec2/2015-04-15/api-2.json +182 -2
  13. data/apis/ecs/2014-11-13/api-2.json +316 -7
  14. data/apis/ecs/2014-11-13/paginators-1.json +40 -0
  15. data/apis/ecs/2014-11-13/waiters-2.json +93 -0
  16. data/apis/redshift/2012-12-01/waiters-2.json +19 -0
  17. data/apis/s3/2006-03-01/api-2.json +1 -2
  18. data/apis/sqs/2012-11-05/api-2.json +5 -6
  19. data/ca-bundle.crt +3554 -0
  20. data/lib/aws-sdk-core.rb +127 -44
  21. data/lib/aws-sdk-core/api/builder.rb +95 -0
  22. data/lib/aws-sdk-core/api/customizations.rb +152 -0
  23. data/lib/aws-sdk-core/api/docs/builder.rb +220 -0
  24. data/lib/aws-sdk-core/api/docs/client_type_documenter.rb +109 -0
  25. data/lib/aws-sdk-core/api/docs/docstring_provider.rb +66 -0
  26. data/lib/aws-sdk-core/api/docs/operation_documenter.rb +107 -0
  27. data/lib/aws-sdk-core/api/docs/param_formatter.rb +163 -0
  28. data/lib/aws-sdk-core/api/docs/request_syntax_example.rb +22 -0
  29. data/lib/aws-sdk-core/api/docs/response_structure_example.rb +91 -0
  30. data/lib/aws-sdk-core/api/docs/utils.rb +133 -0
  31. data/lib/aws-sdk-core/api/shape_map.rb +140 -0
  32. data/lib/aws-sdk-core/assume_role_credentials.rb +9 -6
  33. data/lib/aws-sdk-core/client.rb +9 -6
  34. data/lib/aws-sdk-core/client_stubs.rb +127 -133
  35. data/lib/aws-sdk-core/client_waiters.rb +1 -1
  36. data/lib/aws-sdk-core/credential_provider.rb +44 -0
  37. data/lib/aws-sdk-core/credential_provider_chain.rb +3 -2
  38. data/lib/aws-sdk-core/credentials.rb +5 -0
  39. data/lib/aws-sdk-core/deprecations.rb +69 -0
  40. data/lib/aws-sdk-core/dynamodb.rb +12 -0
  41. data/lib/aws-sdk-core/eager_loader.rb +31 -0
  42. data/lib/aws-sdk-core/ecs.rb +2 -0
  43. data/lib/aws-sdk-core/empty_structure.rb +1 -82
  44. data/lib/aws-sdk-core/endpoint_provider.rb +1 -1
  45. data/lib/aws-sdk-core/instance_profile_credentials.rb +9 -10
  46. data/lib/aws-sdk-core/json.rb +56 -0
  47. data/lib/aws-sdk-core/json/builder.rb +33 -34
  48. data/lib/aws-sdk-core/json/error_handler.rb +2 -2
  49. data/lib/aws-sdk-core/json/handler.rb +67 -0
  50. data/lib/aws-sdk-core/json/json_engine.rb +15 -0
  51. data/lib/aws-sdk-core/json/oj_engine.rb +15 -0
  52. data/lib/aws-sdk-core/json/parser.rb +30 -38
  53. data/lib/aws-sdk-core/pageable_response.rb +9 -12
  54. data/lib/aws-sdk-core/pager.rb +69 -0
  55. data/lib/aws-sdk-core/param_converter.rb +203 -0
  56. data/lib/aws-sdk-core/param_validator.rb +148 -0
  57. data/lib/aws-sdk-core/plugins/dynamodb_simple_attributes.rb +21 -18
  58. data/lib/aws-sdk-core/plugins/glacier_account_id.rb +9 -1
  59. data/lib/aws-sdk-core/plugins/glacier_checksums.rb +2 -3
  60. data/lib/aws-sdk-core/plugins/param_converter.rb +27 -0
  61. data/lib/aws-sdk-core/plugins/param_validator.rb +28 -0
  62. data/lib/aws-sdk-core/plugins/protocols/json_rpc.rb +3 -7
  63. data/lib/aws-sdk-core/plugins/protocols/rest_json.rb +1 -2
  64. data/lib/aws-sdk-core/plugins/protocols/rest_xml.rb +1 -1
  65. data/lib/aws-sdk-core/plugins/regional_endpoint.rb +1 -1
  66. data/lib/aws-sdk-core/plugins/request_signer.rb +5 -5
  67. data/lib/aws-sdk-core/plugins/response_paging.rb +20 -11
  68. data/lib/aws-sdk-core/plugins/s3_get_bucket_location_fix.rb +1 -1
  69. data/lib/aws-sdk-core/plugins/s3_request_signer.rb +1 -2
  70. data/lib/aws-sdk-core/plugins/stub_responses.rb +25 -27
  71. data/lib/aws-sdk-core/query/ec2_param_builder.rb +29 -34
  72. data/lib/aws-sdk-core/query/handler.rb +32 -18
  73. data/lib/aws-sdk-core/query/param_builder.rb +45 -53
  74. data/lib/aws-sdk-core/refreshing_credentials.rb +3 -15
  75. data/lib/aws-sdk-core/rest/handler.rb +22 -0
  76. data/lib/aws-sdk-core/rest/request/body.rb +58 -0
  77. data/lib/aws-sdk-core/rest/request/builder.rb +50 -0
  78. data/lib/aws-sdk-core/rest/request/endpoint.rb +70 -0
  79. data/lib/aws-sdk-core/rest/request/headers.rb +48 -0
  80. data/lib/aws-sdk-core/rest/response/body.rb +43 -0
  81. data/lib/aws-sdk-core/rest/response/headers.rb +60 -0
  82. data/lib/aws-sdk-core/rest/response/parser.rb +47 -0
  83. data/lib/aws-sdk-core/rest/response/status_code.rb +24 -0
  84. data/lib/aws-sdk-core/shared_credentials.rb +11 -6
  85. data/lib/aws-sdk-core/signers/base.rb +1 -1
  86. data/lib/aws-sdk-core/signers/s3.rb +2 -3
  87. data/lib/aws-sdk-core/signers/v2.rb +7 -4
  88. data/lib/aws-sdk-core/signers/v4.rb +11 -22
  89. data/lib/aws-sdk-core/structure.rb +26 -145
  90. data/lib/aws-sdk-core/stubbing/data_applicator.rb +46 -0
  91. data/lib/aws-sdk-core/stubbing/empty_stub.rb +53 -0
  92. data/lib/aws-sdk-core/stubbing/protocols/ec2.rb +49 -0
  93. data/lib/aws-sdk-core/stubbing/protocols/json.rb +40 -0
  94. data/lib/aws-sdk-core/stubbing/protocols/query.rb +40 -0
  95. data/lib/aws-sdk-core/stubbing/protocols/rest.rb +67 -0
  96. data/lib/aws-sdk-core/stubbing/protocols/rest_json.rb +25 -0
  97. data/lib/aws-sdk-core/stubbing/protocols/rest_xml.rb +38 -0
  98. data/lib/aws-sdk-core/stubbing/stub_data.rb +34 -0
  99. data/lib/aws-sdk-core/version.rb +1 -1
  100. data/lib/aws-sdk-core/xml/builder.rb +58 -52
  101. data/lib/aws-sdk-core/xml/default_map.rb +10 -0
  102. data/lib/aws-sdk-core/xml/doc_builder.rb +86 -0
  103. data/lib/aws-sdk-core/xml/error_handler.rb +7 -2
  104. data/lib/aws-sdk-core/xml/parser.rb +4 -4
  105. data/lib/aws-sdk-core/xml/parser/frame.rb +75 -70
  106. data/lib/aws-sdk-core/xml/parser/stack.rb +4 -4
  107. data/lib/seahorse.rb +0 -11
  108. data/lib/seahorse/client/base.rb +3 -12
  109. data/lib/seahorse/client/http/request.rb +9 -5
  110. data/lib/seahorse/client/plugins/endpoint.rb +5 -56
  111. data/lib/seahorse/client/plugins/restful_bindings.rb +38 -31
  112. data/lib/seahorse/client/request_context.rb +2 -2
  113. data/lib/seahorse/client/response.rb +6 -5
  114. data/lib/seahorse/model/api.rb +18 -61
  115. data/lib/seahorse/model/operation.rb +24 -54
  116. data/lib/seahorse/model/shapes.rb +120 -364
  117. data/lib/seahorse/util.rb +2 -6
  118. metadata +56 -109
  119. data/apis/autoscaling/2011-01-01/docs-2.json +0 -1246
  120. data/apis/cloudformation/2010-05-15/docs-2.json +0 -725
  121. data/apis/cloudfront/2014-11-06/docs-2.json +0 -1125
  122. data/apis/cloudhsm/2014-05-30/docs-2.json +0 -472
  123. data/apis/cloudsearch/2013-01-01/docs-2.json +0 -865
  124. data/apis/cloudsearchdomain/2013-01-01/docs-2.json +0 -311
  125. data/apis/cloudtrail/2013-11-01/docs-2.json +0 -328
  126. data/apis/codedeploy/2014-10-06/docs-2.json +0 -1261
  127. data/apis/cognito-identity/2014-06-30/docs-2.json +0 -506
  128. data/apis/cognito-sync/2014-06-30/docs-2.json +0 -582
  129. data/apis/config/2014-10-17/docs-2.json +0 -513
  130. data/apis/config/2014-11-12/docs-2.json +0 -514
  131. data/apis/datapipeline/2012-10-29/docs-2.json +0 -607
  132. data/apis/directconnect/2012-10-25/docs-2.json +0 -494
  133. data/apis/ds/2015-04-16/docs-2.json +0 -753
  134. data/apis/dynamodb/2011-12-05/api-2.json +0 -949
  135. data/apis/dynamodb/2011-12-05/docs-2.json +0 -606
  136. data/apis/dynamodb/2011-12-05/paginators-1.json +0 -26
  137. data/apis/dynamodb/2011-12-05/waiters-2.json +0 -35
  138. data/apis/dynamodb/2012-08-10/docs-2.json +0 -977
  139. data/apis/ec2/2015-04-15/docs-2.json +0 -5368
  140. data/apis/ecs/2014-11-13/docs-2.json +0 -791
  141. data/apis/elasticache/2015-02-02/docs-2.json +0 -1390
  142. data/apis/elasticbeanstalk/2010-12-01/docs-2.json +0 -1114
  143. data/apis/elasticfilesystem/2015-02-01/docs-2.json +0 -414
  144. data/apis/elasticloadbalancing/2012-06-01/docs-2.json +0 -1078
  145. data/apis/elasticmapreduce/2009-03-31/docs-2.json +0 -969
  146. data/apis/elastictranscoder/2012-09-25/docs-2.json +0 -1152
  147. data/apis/email/2010-12-01/docs-2.json +0 -441
  148. data/apis/glacier/2012-06-01/docs-2.json +0 -575
  149. data/apis/iam/2010-05-08/docs-2.json +0 -2138
  150. data/apis/importexport/2010-06-01/docs-2.json +0 -432
  151. data/apis/kinesis/2013-12-02/docs-2.json +0 -424
  152. data/apis/kms/2014-11-01/docs-2.json +0 -628
  153. data/apis/lambda/2014-11-11/docs-2.json +0 -303
  154. data/apis/lambda/2015-03-31/docs-2.json +0 -490
  155. data/apis/logs/2014-03-28/docs-2.json +0 -599
  156. data/apis/machinelearning/2014-12-12/docs-2.json +0 -1034
  157. data/apis/monitoring/2010-08-01/docs-2.json +0 -514
  158. data/apis/opsworks/2013-02-18/docs-2.json +0 -1592
  159. data/apis/rds/2014-10-31/docs-2.json +0 -2074
  160. data/apis/redshift/2012-12-01/docs-2.json +0 -1890
  161. data/apis/route53/2013-04-01/docs-2.json +0 -1159
  162. data/apis/route53domains/2014-05-15/docs-2.json +0 -620
  163. data/apis/s3/2006-03-01/docs-2.json +0 -2213
  164. data/apis/sdb/2009-04-15/docs-2.json +0 -339
  165. data/apis/sns/2010-03-31/docs-2.json +0 -564
  166. data/apis/sqs/2012-11-05/docs-2.json +0 -503
  167. data/apis/ssm/2014-11-06/docs-2.json +0 -440
  168. data/apis/storagegateway/2013-06-30/docs-2.json +0 -1331
  169. data/apis/sts/2011-06-15/docs-2.json +0 -351
  170. data/apis/support/2013-04-15/docs-2.json +0 -680
  171. data/apis/swf/2012-01-25/docs-2.json +0 -1569
  172. data/apis/workspaces/2015-04-08/docs-2.json +0 -457
  173. data/lib/aws-sdk-core/api/customizer.rb +0 -75
  174. data/lib/aws-sdk-core/api/docstrings.rb +0 -38
  175. data/lib/aws-sdk-core/api/documenter.rb +0 -241
  176. data/lib/aws-sdk-core/api/operation_documenter.rb +0 -173
  177. data/lib/aws-sdk-core/api/operation_example.rb +0 -133
  178. data/lib/aws-sdk-core/api/service_customizations.rb +0 -140
  179. data/lib/aws-sdk-core/client_paging.rb +0 -31
  180. data/lib/aws-sdk-core/json/rest_handler.rb +0 -20
  181. data/lib/aws-sdk-core/json/rpc_body_handler.rb +0 -38
  182. data/lib/aws-sdk-core/json/rpc_headers_handler.rb +0 -34
  183. data/lib/aws-sdk-core/json/simple_body_handler.rb +0 -34
  184. data/lib/aws-sdk-core/paging/null_pager.rb +0 -20
  185. data/lib/aws-sdk-core/paging/null_provider.rb +0 -13
  186. data/lib/aws-sdk-core/paging/pager.rb +0 -70
  187. data/lib/aws-sdk-core/paging/provider.rb +0 -22
  188. data/lib/aws-sdk-core/rest_body_handler.rb +0 -111
  189. data/lib/aws-sdk-core/signers/handler.rb +0 -18
  190. data/lib/aws-sdk-core/xml/rest_handler.rb +0 -20
  191. data/lib/seahorse/client/param_converter.rb +0 -207
  192. data/lib/seahorse/client/param_validator.rb +0 -139
  193. data/lib/seahorse/client/plugins/json_simple.rb +0 -33
  194. data/lib/seahorse/client/plugins/param_conversion.rb +0 -29
  195. data/lib/seahorse/client/plugins/param_validation.rb +0 -30
  196. data/lib/seahorse/client/xml/builder.rb +0 -91
  197. data/lib/seahorse/model/shape_map.rb +0 -47
@@ -1,311 +0,0 @@
1
- {
2
- "version": "2.0",
3
- "operations": {
4
- "Search": "<p>Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:</p> <ul> <li> <code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. </li> <li> <code>structured</code>: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.</li> <li> <code>lucene</code>: specify search criteria using the Apache Lucene query parser syntax.</li> <li> <code>dismax</code>: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.</li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html\">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p> <p>The endpoint for submitting <code>Search</code> requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </p>",
5
- "Suggest": "<p>Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. </p> <p>For more information about configuring suggesters and retrieving suggestions, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p> <p>The endpoint for submitting <code>Suggest</code> requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </p>",
6
- "UploadDocuments": "<p>Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. </p> <p>The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </p> <p>For more information about formatting your data for Amazon CloudSearch, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html\">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html\">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>"
7
- },
8
- "service": "<p>You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. </p> <p>The endpoints for submitting <code>UploadDocuments</code>, <code>Search</code>, and <code>Suggest</code> requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint. </p> <p>For more information, see the <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide\">Amazon CloudSearch Developer Guide</a>.</p>",
9
- "shapes": {
10
- "Adds": {
11
- "base": null,
12
- "refs": {
13
- "UploadDocumentsResponse$adds": "<p>The number of documents that were added to the search domain.</p>"
14
- }
15
- },
16
- "Blob": {
17
- "base": null,
18
- "refs": {
19
- "UploadDocumentsRequest$documents": "<p>A batch of documents formatted in JSON or HTML.</p>"
20
- }
21
- },
22
- "Bucket": {
23
- "base": "<p>A container for facet information. </p>",
24
- "refs": {
25
- "BucketList$member": null
26
- }
27
- },
28
- "BucketInfo": {
29
- "base": "<p>A container for the calculated facet values and counts.</p>",
30
- "refs": {
31
- "Facets$value": null
32
- }
33
- },
34
- "BucketList": {
35
- "base": null,
36
- "refs": {
37
- "BucketInfo$buckets": "<p>A list of the calculated facet values and counts.</p>"
38
- }
39
- },
40
- "ContentType": {
41
- "base": null,
42
- "refs": {
43
- "UploadDocumentsRequest$contentType": "<p>The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:</p> <ul> <li>application/json</li> <li>application/xml</li> </ul>"
44
- }
45
- },
46
- "Cursor": {
47
- "base": null,
48
- "refs": {
49
- "SearchRequest$cursor": "<p>Retrieves a cursor value you can use to page through large result sets. Use the <code>size</code> parameter to control the number of hits to include in each response. You can specify either the <code>cursor</code> or <code>start</code> parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to <code>initial</code>. In subsequent requests, specify the cursor value returned in the hits section of the response. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html\">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
50
- }
51
- },
52
- "Deletes": {
53
- "base": null,
54
- "refs": {
55
- "UploadDocumentsResponse$deletes": "<p>The number of documents that were deleted from the search domain.</p>"
56
- }
57
- },
58
- "DocumentServiceException": {
59
- "base": "<p>Information about any problems encountered while processing an upload request.</p>",
60
- "refs": {
61
- }
62
- },
63
- "DocumentServiceWarning": {
64
- "base": "<p>A warning returned by the document service when an issue is discovered while processing an upload request.</p>",
65
- "refs": {
66
- "DocumentServiceWarnings$member": null
67
- }
68
- },
69
- "DocumentServiceWarnings": {
70
- "base": null,
71
- "refs": {
72
- "UploadDocumentsResponse$warnings": "<p>Any warnings returned by the document service about the documents being uploaded.</p>"
73
- }
74
- },
75
- "Expr": {
76
- "base": null,
77
- "refs": {
78
- "SearchRequest$expr": "<p>Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields. </p> <p>You specify the expressions in JSON using the form <code>{\"EXPRESSIONNAME\":\"EXPRESSION\"}</code>. You can define and use multiple expressions in a search request. For example:</p> <p><code> {\"expression1\":\"_score*rating\", \"expression2\":\"(1/rank)*year\"} </code> </p> <p>For information about the variables, operators, and functions you can use in expressions, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions\">Writing Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
79
- }
80
- },
81
- "Exprs": {
82
- "base": null,
83
- "refs": {
84
- "Hit$exprs": "<p>The expressions returned from a document that matches the search request.</p>"
85
- }
86
- },
87
- "Facet": {
88
- "base": null,
89
- "refs": {
90
- "SearchRequest$facet": "<p>Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}</code>.</p> <p>You can specify the following faceting options:</p> <ul> <li> <p><code>buckets</code> specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html\"> Searching for a Range of Values</a> in the <i>Amazon CloudSearch Developer Guide</i>. Buckets are returned in the order they are specified in the request. The <code>sort</code> and <code>size</code> options are not valid if you specify <code>buckets</code>.</p> </li> <li> <p><code>size</code> specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The <code>size</code> parameter is only valid when you specify the <code>sort</code> option; it cannot be used in conjunction with <code>buckets</code>.</p> </li> <li> <p><code>sort</code> specifies how you want to sort the facets in the results: <code>bucket</code> or <code>count</code>. Specify <code>bucket</code> to sort alphabetically or numerically by facet value (in ascending order). Specify <code>count</code> to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the <code>buckets</code> option instead of <code>sort</code>. </p> </li> </ul> <p>If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.</p> <p>To count particular buckets of values, use the <code>buckets</code> option. For example, the following request uses the <code>buckets</code> option to calculate and return facet counts by decade.</p> <p><code> {\"year\":{\"buckets\":[\"[1970,1979]\",\"[1980,1989]\",\"[1990,1999]\",\"[2000,2009]\",\"[2010,}\"]}} </code></p> <p>To sort facets by facet count, use the <code>count</code> option. For example, the following request sets the <code>sort</code> option to <code>count</code> to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the <code>size</code> option to 3 returns only the top three facet values.</p> <p><code> {\"year\":{\"sort\":\"count\",\"size\":3}} </code></p> <p>To sort the facets by value, use the <code>bucket</code> option. For example, the following request sets the <code>sort</code> option to <code>bucket</code> to sort the facet values numerically by year, with earliest year listed first. </p> <p><code> {\"year\":{\"sort\":\"bucket\"}} </code></p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html\">Getting and Using Facet Information</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
91
- }
92
- },
93
- "Facets": {
94
- "base": null,
95
- "refs": {
96
- "SearchResponse$facets": "<p>The requested facet information.</p>"
97
- }
98
- },
99
- "FieldValue": {
100
- "base": null,
101
- "refs": {
102
- "Fields$value": null
103
- }
104
- },
105
- "Fields": {
106
- "base": null,
107
- "refs": {
108
- "Hit$fields": "<p>The fields returned from a document that matches the search request.</p>"
109
- }
110
- },
111
- "FilterQuery": {
112
- "base": null,
113
- "refs": {
114
- "SearchRequest$filterQuery": "<p>Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use <code>filterQuery</code> in conjunction with the <code>query</code> parameter to filter the documents that match the constraints specified in the <code>query</code> parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The <code>filterQuery</code> parameter supports the full structured query syntax. </p> <p>For more information about using filters, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html\">Filtering Matching Documents</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
115
- }
116
- },
117
- "Highlight": {
118
- "base": null,
119
- "refs": {
120
- "SearchRequest$highlight": "<p>Retrieves highlights for matches in the specified <code>text</code> or <code>text-array</code> fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}</code>.</p> <p>You can specify the following highlight options:</p> <ul> <li> <code>format</code>: specifies the format of the data in the text field: <code>text</code> or <code>html</code>. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is <code>html</code>. </li> <li> <code>max_phrases</code>: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted. </li> <li> <code>pre_tag</code>: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is <code>&amp;lt;em&amp;gt;</code>. The default for text highlights is <code>*</code>. </li> <li> <code>post_tag</code>: specifies the string to append to an occurrence of a search term. The default for HTML highlights is <code>&amp;lt;/em&amp;gt;</code>. The default for text highlights is <code>*</code>. </li> </ul> <p>If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: <code>&amp;lt;em&gt;search-term&amp;lt;/em&amp;gt;</code>.</p> <p>For example, the following request retrieves highlights for the <code>actors</code> and <code>title</code> fields.</p> <p> <code>{ \"actors\": {}, \"title\": {\"format\": \"text\",\"max_phrases\": 2,\"pre_tag\": \"<b>\",\"post_tag\": \"</b>\"} }</code></p>"
121
- }
122
- },
123
- "Highlights": {
124
- "base": null,
125
- "refs": {
126
- "Hit$highlights": "<p>The highlights returned from a document that matches the search request.</p>"
127
- }
128
- },
129
- "Hit": {
130
- "base": "<p>Information about a document that matches the search request.</p>",
131
- "refs": {
132
- "HitList$member": null
133
- }
134
- },
135
- "HitList": {
136
- "base": null,
137
- "refs": {
138
- "Hits$hit": "<p>A document that matches the search request.</p>"
139
- }
140
- },
141
- "Hits": {
142
- "base": "<p>The collection of documents that match the search request.</p>",
143
- "refs": {
144
- "SearchResponse$hits": "<p>The documents that match the search criteria.</p>"
145
- }
146
- },
147
- "Long": {
148
- "base": null,
149
- "refs": {
150
- "Bucket$count": "<p>The number of hits that contain the facet value in the specified facet field.</p>",
151
- "Hits$found": "<p>The total number of documents that match the search request.</p>",
152
- "Hits$start": "<p>The index of the first matching document.</p>",
153
- "SearchStatus$timems": "<p>How long it took to process the request, in milliseconds.</p>",
154
- "SuggestModel$found": "<p>The number of documents that were found to match the query string.</p>",
155
- "SuggestStatus$timems": "<p>How long it took to process the request, in milliseconds.</p>",
156
- "SuggestionMatch$score": "<p>The relevance score of a suggested match.</p>"
157
- }
158
- },
159
- "Partial": {
160
- "base": null,
161
- "refs": {
162
- "SearchRequest$partial": "<p>Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.</p>"
163
- }
164
- },
165
- "Query": {
166
- "base": null,
167
- "refs": {
168
- "SearchRequest$query": "<p>Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the <code>queryOptions</code> parameter. By default, the <code>simple</code> query parser is used to process requests. To use the <code>structured</code>, <code>lucene</code>, or <code>dismax</code> query parser, you must also specify the <code>queryParser</code> parameter. </p> <p>For more information about specifying search criteria, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html\">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
169
- "SuggestRequest$query": "<p>Specifies the string for which you want to get suggestions.</p>"
170
- }
171
- },
172
- "QueryOptions": {
173
- "base": null,
174
- "refs": {
175
- "SearchRequest$queryOptions": "<p>Configures options for the query parser specified in the <code>queryParser</code> parameter. You specify the options in JSON using the following form <code>{\"OPTION1\":\"VALUE1\",\"OPTION2\":VALUE2\"...\"OPTIONN\":\"VALUEN\"}.</code></p> <p>The options you can configure vary according to which parser you use:</p> <ul> <li> <code>defaultOperator</code>: The default operator used to combine individual terms in the search string. For example: <code>defaultOperator: 'or'</code>. For the <code>dismax</code> parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of <code>0%</code> is the equivalent to OR, and a value of <code>100%</code> is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, <code>defaultOperator: 50%</code>. Valid values: <code>and</code>, <code>or</code>, a percentage in the range 0%-100% (<code>dismax</code>). Default: <code>and</code> (<code>simple</code>, <code>structured</code>, <code>lucene</code>) or <code>100</code> (<code>dismax</code>). Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>.</li> <li> <code>fields</code>: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost the importance of the <code>title</code> field over the <code>description</code> field you could specify: <code>\"fields\":[\"title^5\",\"description\"]</code>. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All <code>text</code> and <code>text-array</code> fields. Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>.</li> <li> <code>operators</code>: An array of the operators or special characters you want to disable for the simple query parser. If you disable the <code>and</code>, <code>or</code>, or <code>not</code> operators, the corresponding operators (<code>+</code>, <code>|</code>, <code>-</code>) have no special meaning and are dropped from the search string. Similarly, disabling <code>prefix</code> disables the wildcard operator (<code>*</code>) and disabling <code>phrase</code> disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling <code>near</code> disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the <code>fuzzy</code> operator disables the ability to use the ~ operator to perform a fuzzy search. <code>escape</code> disables the ability to use a backslash (<code>\\</code>) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: <code>\"operators\":[\"and\",\"not\",\"or\", \"prefix\"]</code>. Valid values: <code>and</code>, <code>escape</code>, <code>fuzzy</code>, <code>near</code>, <code>not</code>, <code>or</code>, <code>phrase</code>, <code>precedence</code>, <code>prefix</code>, <code>whitespace</code>. Default: All operators and special characters are enabled. Valid for: <code>simple</code>.</li> <li> <code>phraseFields</code>: An array of the <code>text</code> or <code>text-array</code> fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The <code>phraseSlop</code> option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost phrase matches in the <code>title</code> field over the <code>abstract</code> field, you could specify: <code>\"phraseFields\":[\"title^3\", \"plot\"]</code> Valid values: The name of any <code>text</code> or <code>text-array</code> field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with <code>phraseFields</code>, proximity scoring is disabled even if <code>phraseSlop</code> is specified. Valid for: <code>dismax</code>.</li> <li> <code>phraseSlop</code>: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the <code>phraseFields</code> option; for example, <code>phraseSlop: 2</code>. You must also specify <code>phraseFields</code> to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>.</li> <li> <code>explicitPhraseSlop</code>: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify <code>\"explicitPhraseSlop\":3</code>. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>.</li> <li> <code>tieBreaker</code>: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a <code>tieBreaker</code> value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is <code>(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)</code>. Set <code>tieBreaker</code> to 0 to disregard all but the highest scoring field (pure max): <code>\"tieBreaker\":0</code>. Set to 1 to sum the scores from all fields (pure sum): <code>\"tieBreaker\":1</code>. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: <code>dismax</code>. </li> </ul>"
176
- }
177
- },
178
- "QueryParser": {
179
- "base": null,
180
- "refs": {
181
- "SearchRequest$queryParser": "<p>Specifies which query parser to use to process the request. If <code>queryParser</code> is not specified, Amazon CloudSearch uses the <code>simple</code> query parser. </p> <p>Amazon CloudSearch supports four query parsers:</p> <ul> <li> <code>simple</code>: perform simple searches of <code>text</code> and <code>text-array</code> fields. By default, the <code>simple</code> query parser searches all <code>text</code> and <code>text-array</code> fields. You can specify which fields to search by with the <code>queryOptions</code> parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the <code>queryOptions</code> parameter.) You can use the <code>-</code> (NOT), <code>|</code> (OR), and <code>*</code> (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html\">Searching for Text</a> in the <i>Amazon CloudSearch Developer Guide</i>. </li> <li> <code>structured</code>: perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, <code>matchall</code>, and <code>near</code>. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html\">Constructing Compound Queries</a> in the <i>Amazon CloudSearch Developer Guide</i>. </li> <li> <code>lucene</code>: search using the Apache Lucene query parser syntax. For more information, see <a href=\"http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description\">Apache Lucene Query Parser Syntax</a>. </li> <li> <code>dismax</code>: search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see <a href=\"http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax\">DisMax Query Parser Syntax</a>. </li> </ul>"
182
- }
183
- },
184
- "Return": {
185
- "base": null,
186
- "refs": {
187
- "SearchRequest$return": "<p>Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (<code>_all_fields</code>). To return only the document IDs for the matching documents, specify <code>_no_fields</code>. To retrieve the relevance score calculated for each document, specify <code>_score</code>. </p>"
188
- }
189
- },
190
- "SearchException": {
191
- "base": "<p>Information about any problems encountered while processing a search request.</p>",
192
- "refs": {
193
- }
194
- },
195
- "SearchRequest": {
196
- "base": "<p>Container for the parameters to the <code>Search</code> request.</p>",
197
- "refs": {
198
- }
199
- },
200
- "SearchResponse": {
201
- "base": "<p>The result of a <code>Search</code> request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.</p>",
202
- "refs": {
203
- }
204
- },
205
- "SearchStatus": {
206
- "base": "<p>Contains the resource id (<code>rid</code>) and the time it took to process the request (<code>timems</code>).</p>",
207
- "refs": {
208
- "SearchResponse$status": "<p>The status information returned for the search request.</p>"
209
- }
210
- },
211
- "Size": {
212
- "base": null,
213
- "refs": {
214
- "SearchRequest$size": "<p>Specifies the maximum number of search hits to include in the response. </p>"
215
- }
216
- },
217
- "Sort": {
218
- "base": null,
219
- "refs": {
220
- "SearchRequest$sort": "<p>Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (<code>asc</code> or <code>desc</code>) for each field; for example, <code>year desc,title asc</code>. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no <code>sort</code> parameter is specified, results are sorted by their default relevance scores in descending order: <code>_score desc</code>. You can also sort by document ID (<code>_id asc</code>) and version (<code>_version desc</code>).</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html\">Sorting Results</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
221
- }
222
- },
223
- "Start": {
224
- "base": null,
225
- "refs": {
226
- "SearchRequest$start": "<p>Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the <code>start</code> or <code>cursor</code> parameter in a request, they are mutually exclusive. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html\">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
227
- }
228
- },
229
- "String": {
230
- "base": null,
231
- "refs": {
232
- "Bucket$value": "<p>The facet value being counted.</p>",
233
- "DocumentServiceException$status": "<p>The return status of a document upload request, <code>error</code> or <code>success</code>.</p>",
234
- "DocumentServiceException$message": "<p>The description of the errors returned by the document service.</p>",
235
- "DocumentServiceWarning$message": "<p>The description for a warning returned by the document service.</p>",
236
- "Exprs$key": null,
237
- "Exprs$value": null,
238
- "Facets$key": null,
239
- "FieldValue$member": null,
240
- "Fields$key": null,
241
- "Highlights$key": null,
242
- "Highlights$value": null,
243
- "Hit$id": "<p>The document ID of a document that matches the search request.</p>",
244
- "Hits$cursor": "<p>A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.</p>",
245
- "SearchException$message": "<p>A description of the error returned by the search service.</p>",
246
- "SearchStatus$rid": "<p>The encrypted resource ID for the request.</p>",
247
- "SuggestModel$query": "<p>The query string specified in the suggest request.</p>",
248
- "SuggestStatus$rid": "<p>The encrypted resource ID for the request.</p>",
249
- "SuggestionMatch$suggestion": "<p>The string that matches the query string specified in the <code>SuggestRequest</code>. </p>",
250
- "SuggestionMatch$id": "<p>The document ID of the suggested document.</p>",
251
- "UploadDocumentsResponse$status": "<p>The status of an <code>UploadDocumentsRequest</code>.</p>"
252
- }
253
- },
254
- "SuggestModel": {
255
- "base": "<p>Container for the suggestion information returned in a <code>SuggestResponse</code>.</p>",
256
- "refs": {
257
- "SuggestResponse$suggest": "<p>Container for the matching search suggestion information.</p>"
258
- }
259
- },
260
- "SuggestRequest": {
261
- "base": "<p>Container for the parameters to the <code>Suggest</code> request.</p>",
262
- "refs": {
263
- }
264
- },
265
- "SuggestResponse": {
266
- "base": "<p>Contains the response to a <code>Suggest</code> request.</p>",
267
- "refs": {
268
- }
269
- },
270
- "SuggestStatus": {
271
- "base": "<p>Contains the resource id (<code>rid</code>) and the time it took to process the request (<code>timems</code>).</p>",
272
- "refs": {
273
- "SuggestResponse$status": "<p>The status of a <code>SuggestRequest</code>. Contains the resource ID (<code>rid</code>) and how long it took to process the request (<code>timems</code>).</p>"
274
- }
275
- },
276
- "Suggester": {
277
- "base": null,
278
- "refs": {
279
- "SuggestRequest$suggester": "<p>Specifies the name of the suggester to use to find suggested matches.</p>"
280
- }
281
- },
282
- "SuggestionMatch": {
283
- "base": "<p>An autocomplete suggestion that matches the query string specified in a <code>SuggestRequest</code>. </p>",
284
- "refs": {
285
- "Suggestions$member": null
286
- }
287
- },
288
- "Suggestions": {
289
- "base": null,
290
- "refs": {
291
- "SuggestModel$suggestions": "<p>The documents that match the query string.</p>"
292
- }
293
- },
294
- "SuggestionsSize": {
295
- "base": null,
296
- "refs": {
297
- "SuggestRequest$size": "<p>Specifies the maximum number of suggestions to return. </p>"
298
- }
299
- },
300
- "UploadDocumentsRequest": {
301
- "base": "<p>Container for the parameters to the <code>UploadDocuments</code> request.</p>",
302
- "refs": {
303
- }
304
- },
305
- "UploadDocumentsResponse": {
306
- "base": "<p>Contains the response to an <code>UploadDocuments</code> request.</p>",
307
- "refs": {
308
- }
309
- }
310
- }
311
- }
@@ -1,328 +0,0 @@
1
- {
2
- "version": "2.0",
3
- "operations": {
4
- "CreateTrail": "<p>From the command line, use <code>create-subscription</code>. </p> <p>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. </p>",
5
- "DeleteTrail": "<p>Deletes a trail.</p>",
6
- "DescribeTrails": "<p>Retrieves settings for the trail associated with the current region for your account.</p>",
7
- "GetTrailStatus": "<p>Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. </p>",
8
- "LookupEvents": "<p>Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. The rate of lookup requests is limited to one per second per account.</p> <important>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</important>",
9
- "StartLogging": "<p>Starts the recording of AWS API calls and log file delivery for a trail.</p>",
10
- "StopLogging": "<p>Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording.</p>",
11
- "UpdateTrail": "<p>From the command line, use <code>update-subscription</code>.</p> <p>Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. </p>"
12
- },
13
- "service": "<fullname>AWS CloudTrail</fullname> <p>This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.</p> <p>CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.</p> <note> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services page</a>. </note> <p>See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.</p>",
14
- "shapes": {
15
- "Boolean": {
16
- "base": null,
17
- "refs": {
18
- "CreateTrailRequest$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>",
19
- "CreateTrailResponse$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>",
20
- "GetTrailStatusResponse$IsLogging": "<p>Whether the CloudTrail is currently logging AWS API calls.</p>",
21
- "Trail$IncludeGlobalServiceEvents": "<p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>",
22
- "UpdateTrailRequest$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>",
23
- "UpdateTrailResponse$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>"
24
- }
25
- },
26
- "CloudWatchLogsDeliveryUnavailableException": {
27
- "base": "<p>Cannot set a CloudWatch Logs delivery for this region.</p>",
28
- "refs": {
29
- }
30
- },
31
- "CreateTrailRequest": {
32
- "base": "<p>Specifies the settings for each trail.</p>",
33
- "refs": {
34
- }
35
- },
36
- "CreateTrailResponse": {
37
- "base": "Returns the objects or data listed below if successful. Otherwise, returns an error.",
38
- "refs": {
39
- }
40
- },
41
- "Date": {
42
- "base": null,
43
- "refs": {
44
- "Event$EventTime": "<p>The date and time of the event returned.</p>",
45
- "GetTrailStatusResponse$LatestDeliveryTime": "<p>Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.</p>",
46
- "GetTrailStatusResponse$LatestNotificationTime": "<p>Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket. </p>",
47
- "GetTrailStatusResponse$StartLoggingTime": "<p>Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account. </p>",
48
- "GetTrailStatusResponse$StopLoggingTime": "<p>Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account. </p>",
49
- "GetTrailStatusResponse$LatestCloudWatchLogsDeliveryTime": "<p>Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.</p>",
50
- "LookupEventsRequest$StartTime": "<p>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</p>",
51
- "LookupEventsRequest$EndTime": "<p>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</p>"
52
- }
53
- },
54
- "DeleteTrailRequest": {
55
- "base": "<a>The request that specifies the name of a trail to delete.</a>",
56
- "refs": {
57
- }
58
- },
59
- "DeleteTrailResponse": {
60
- "base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
61
- "refs": {
62
- }
63
- },
64
- "DescribeTrailsRequest": {
65
- "base": "<p>Returns information about the trail.</p>",
66
- "refs": {
67
- }
68
- },
69
- "DescribeTrailsResponse": {
70
- "base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
71
- "refs": {
72
- }
73
- },
74
- "Event": {
75
- "base": "<p>Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event. </p>",
76
- "refs": {
77
- "EventsList$member": null
78
- }
79
- },
80
- "EventsList": {
81
- "base": null,
82
- "refs": {
83
- "LookupEventsResponse$Events": "<p>A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.</p>"
84
- }
85
- },
86
- "GetTrailStatusRequest": {
87
- "base": "<p>The name of a trail about which you want the current status.</p>",
88
- "refs": {
89
- }
90
- },
91
- "GetTrailStatusResponse": {
92
- "base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
93
- "refs": {
94
- }
95
- },
96
- "InsufficientS3BucketPolicyException": {
97
- "base": "<p>This exception is thrown when the policy on the S3 bucket is not sufficient.</p>",
98
- "refs": {
99
- }
100
- },
101
- "InsufficientSnsTopicPolicyException": {
102
- "base": "<p>This exception is thrown when the policy on the SNS topic is not sufficient.</p>",
103
- "refs": {
104
- }
105
- },
106
- "InvalidCloudWatchLogsLogGroupArnException": {
107
- "base": "<p>This exception is thrown when the provided CloudWatch log group is not valid.</p>",
108
- "refs": {
109
- }
110
- },
111
- "InvalidCloudWatchLogsRoleArnException": {
112
- "base": "<p>This exception is thrown when the provided role is not valid.</p>",
113
- "refs": {
114
- }
115
- },
116
- "InvalidLookupAttributesException": {
117
- "base": "<p>Occurs when an invalid lookup attribute is specified.</p>",
118
- "refs": {
119
- }
120
- },
121
- "InvalidMaxResultsException": {
122
- "base": "<p>This exception is thrown if the limit specified is invalid. </p>",
123
- "refs": {
124
- }
125
- },
126
- "InvalidNextTokenException": {
127
- "base": "<p>Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid. </p>",
128
- "refs": {
129
- }
130
- },
131
- "InvalidS3BucketNameException": {
132
- "base": "<p>This exception is thrown when the provided S3 bucket name is not valid.</p>",
133
- "refs": {
134
- }
135
- },
136
- "InvalidS3PrefixException": {
137
- "base": "<p>This exception is thrown when the provided S3 prefix is not valid.</p>",
138
- "refs": {
139
- }
140
- },
141
- "InvalidSnsTopicNameException": {
142
- "base": "<p>This exception is thrown when the provided SNS topic name is not valid. </p>",
143
- "refs": {
144
- }
145
- },
146
- "InvalidTimeRangeException": {
147
- "base": "<p>Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </p>",
148
- "refs": {
149
- }
150
- },
151
- "InvalidTrailNameException": {
152
- "base": "<p>This exception is thrown when the provided trail name is not valid.</p>",
153
- "refs": {
154
- }
155
- },
156
- "LookupAttribute": {
157
- "base": "<p>Specifies an attribute and value that filter the events returned.</p>",
158
- "refs": {
159
- "LookupAttributesList$member": null
160
- }
161
- },
162
- "LookupAttributeKey": {
163
- "base": null,
164
- "refs": {
165
- "LookupAttribute$AttributeKey": "<p>Specifies an attribute on which to filter the events returned.</p>"
166
- }
167
- },
168
- "LookupAttributesList": {
169
- "base": null,
170
- "refs": {
171
- "LookupEventsRequest$LookupAttributes": "<p>Contains a list of lookup attributes. Currently the list can contain only one item.</p>"
172
- }
173
- },
174
- "LookupEventsRequest": {
175
- "base": "<p>Contains a request for LookupEvents.</p>",
176
- "refs": {
177
- }
178
- },
179
- "LookupEventsResponse": {
180
- "base": "<p>Contains a response to a LookupEvents action.</p>",
181
- "refs": {
182
- }
183
- },
184
- "MaxResults": {
185
- "base": null,
186
- "refs": {
187
- "LookupEventsRequest$MaxResults": "<p>The number of events to return. Possible values are 1 through 50. The default is 10.</p>"
188
- }
189
- },
190
- "MaximumNumberOfTrailsExceededException": {
191
- "base": "<p>This exception is thrown when the maximum number of trails is reached.</p>",
192
- "refs": {
193
- }
194
- },
195
- "NextToken": {
196
- "base": null,
197
- "refs": {
198
- "LookupEventsRequest$NextToken": "<p>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</p>",
199
- "LookupEventsResponse$NextToken": "<p>The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</p>"
200
- }
201
- },
202
- "Resource": {
203
- "base": "<p>Specifies the type and name of a resource referenced by an event.</p>",
204
- "refs": {
205
- "ResourceList$member": null
206
- }
207
- },
208
- "ResourceList": {
209
- "base": "<p>A list of resources referenced by the event returned.</p>",
210
- "refs": {
211
- "Event$Resources": "<p>A list of resources referenced by the event returned.</p>"
212
- }
213
- },
214
- "S3BucketDoesNotExistException": {
215
- "base": "<p>This exception is thrown when the specified S3 bucket does not exist.</p>",
216
- "refs": {
217
- }
218
- },
219
- "StartLoggingRequest": {
220
- "base": "<p>The request to CloudTrail to start logging AWS API calls for an account.</p>",
221
- "refs": {
222
- }
223
- },
224
- "StartLoggingResponse": {
225
- "base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
226
- "refs": {
227
- }
228
- },
229
- "StopLoggingRequest": {
230
- "base": "<p>Passes the request to CloudTrail to stop logging AWS API calls for the specified account.</p>",
231
- "refs": {
232
- }
233
- },
234
- "StopLoggingResponse": {
235
- "base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
236
- "refs": {
237
- }
238
- },
239
- "String": {
240
- "base": null,
241
- "refs": {
242
- "CreateTrailRequest$Name": "<p>Specifies the name of the trail.</p>",
243
- "CreateTrailRequest$S3BucketName": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>",
244
- "CreateTrailRequest$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.</p>",
245
- "CreateTrailRequest$SnsTopicName": "<p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.</p>",
246
- "CreateTrailRequest$CloudWatchLogsLogGroupArn": "<p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.</p>",
247
- "CreateTrailRequest$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.</p>",
248
- "CreateTrailResponse$Name": "<p>Specifies the name of the trail.</p>",
249
- "CreateTrailResponse$S3BucketName": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>",
250
- "CreateTrailResponse$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.</p>",
251
- "CreateTrailResponse$SnsTopicName": "<p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.</p>",
252
- "CreateTrailResponse$CloudWatchLogsLogGroupArn": "<p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.</p>",
253
- "CreateTrailResponse$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.</p>",
254
- "DeleteTrailRequest$Name": "<p>The name of a trail to be deleted.</p>",
255
- "Event$EventId": "<p>The CloudTrail ID of the event returned.</p>",
256
- "Event$EventName": "<p>The name of the event returned.</p>",
257
- "Event$Username": "<p>A user name or role name of the requester that called the API in the event returned.</p>",
258
- "Event$CloudTrailEvent": "<p>A JSON string that contains a representation of the event returned.</p>",
259
- "GetTrailStatusRequest$Name": "<p>The name of the trail for which you are requesting the current status.</p>",
260
- "GetTrailStatusResponse$LatestDeliveryError": "<p>Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html\">Error Responses</a> in the Amazon S3 API Reference. </p>",
261
- "GetTrailStatusResponse$LatestNotificationError": "<p>Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the <a href=\"http://docs.aws.amazon.com/sns/latest/dg/welcome.html\">Amazon SNS Developer Guide</a>. </p>",
262
- "GetTrailStatusResponse$LatestCloudWatchLogsDeliveryError": "<p>Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.</p>",
263
- "LookupAttribute$AttributeValue": "<p>Specifies a value for the specified AttributeKey.</p>",
264
- "Resource$ResourceType": "<p>The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: <b>Instance</b> for EC2, <b>Trail</b> for CloudTrail, <b>DBInstance</b> for RDS, and <b>AccessKey</b> for IAM. For a list of resource types supported for event lookup, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/lookup_supported_resourcetypes.html\">Resource Types Supported for Event Lookup</a>.</p>",
265
- "Resource$ResourceName": "<p>The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2 Instance.</p>",
266
- "StartLoggingRequest$Name": "<p>The name of the trail for which CloudTrail logs AWS API calls.</p>",
267
- "StopLoggingRequest$Name": "<p>Communicates to CloudTrail the name of the trail for which to stop logging AWS API calls.</p>",
268
- "Trail$Name": "<p>Name of the trail set by calling <a>CreateTrail</a>.</p>",
269
- "Trail$S3BucketName": "<p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>",
270
- "Trail$S3KeyPrefix": "<p>Value of the Amazon S3 prefix.</p>",
271
- "Trail$SnsTopicName": "<p>Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. </p>",
272
- "Trail$CloudWatchLogsLogGroupArn": "<p>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.</p>",
273
- "Trail$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.</p>",
274
- "TrailNameList$member": null,
275
- "UpdateTrailRequest$Name": "<p>Specifies the name of the trail.</p>",
276
- "UpdateTrailRequest$S3BucketName": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>",
277
- "UpdateTrailRequest$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.</p>",
278
- "UpdateTrailRequest$SnsTopicName": "<p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.</p>",
279
- "UpdateTrailRequest$CloudWatchLogsLogGroupArn": "<p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.</p>",
280
- "UpdateTrailRequest$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.</p>",
281
- "UpdateTrailResponse$Name": "<p>Specifies the name of the trail.</p>",
282
- "UpdateTrailResponse$S3BucketName": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>",
283
- "UpdateTrailResponse$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.</p>",
284
- "UpdateTrailResponse$SnsTopicName": "<p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.</p>",
285
- "UpdateTrailResponse$CloudWatchLogsLogGroupArn": "<p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.</p>",
286
- "UpdateTrailResponse$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.</p>"
287
- }
288
- },
289
- "Trail": {
290
- "base": "<p>The settings for a trail.</p>",
291
- "refs": {
292
- "TrailList$member": null
293
- }
294
- },
295
- "TrailAlreadyExistsException": {
296
- "base": "<p>This exception is thrown when the specified trail already exists.</p>",
297
- "refs": {
298
- }
299
- },
300
- "TrailList": {
301
- "base": null,
302
- "refs": {
303
- "DescribeTrailsResponse$trailList": "<p>The list of trails.</p>"
304
- }
305
- },
306
- "TrailNameList": {
307
- "base": null,
308
- "refs": {
309
- "DescribeTrailsRequest$trailNameList": "<p>The trail returned.</p>"
310
- }
311
- },
312
- "TrailNotFoundException": {
313
- "base": "<p>This exception is thrown when the trail with the given name is not found.</p>",
314
- "refs": {
315
- }
316
- },
317
- "UpdateTrailRequest": {
318
- "base": "<p>Specifies settings to update for the trail.</p>",
319
- "refs": {
320
- }
321
- },
322
- "UpdateTrailResponse": {
323
- "base": "Returns the objects or data listed below if successful. Otherwise, returns an error.",
324
- "refs": {
325
- }
326
- }
327
- }
328
- }