/usr/lib/python3/dist-packages/botocore/data/aws/cloudtrail.json is in python3-botocore 0.29.0+repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 | {
"api_version": "2013-11-01",
"type": "json",
"json_version": 1.1,
"target_prefix": "com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101",
"signature_version": "v4",
"service_full_name": "AWS CloudTrail",
"service_abbreviation": "CloudTrail",
"endpoint_prefix": "cloudtrail",
"xmlnamespace": "http://cloudtrail.amazonaws.com/doc/2013-11-01/",
"documentation": "\n <fullname>AWS Cloud Trail</fullname>\n <p>This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.</p> \n <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>\n \n \n <note>\n As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code \n 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 \n 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>.\n </note>\n \n \n<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>",
"operations": {
"CreateTrail": {
"name": "CreateTrail",
"input": {
"shape_name": "CreateTrailRequest",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the trail.</p>\n \n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.</p>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>\n "
},
"trail": {
"shape_name": "Trail",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <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>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
}
},
"documentation": "\n <p>Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions. </p>\n "
}
},
"documentation": "\n <p>Specifies the settings for each trail.</p>\n "
},
"output": {
"shape_name": "CreateTrailResponse",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the trail.</p>\n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.</p>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>\n "
},
"trail": {
"shape_name": "Trail",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <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>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
}
},
"documentation": "\n <p>Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions. </p>\n "
}
},
"documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n "
},
"errors": [
{
"shape_name": "MaximumNumberOfTrailsExceededException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the maximum number of trails is reached.\n\t"
},
{
"shape_name": "TrailAlreadyExistsException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the specified trail already exists.\n\t"
},
{
"shape_name": "S3BucketDoesNotExistException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the specified S3 bucket does not exist.\n\t"
},
{
"shape_name": "InsufficientS3BucketPolicyException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the policy on the S3 bucket is not sufficient.\n\t"
},
{
"shape_name": "InsufficientSnsTopicPolicyException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the policy on the SNS topic is not sufficient.\n\t"
},
{
"shape_name": "InvalidS3BucketNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided S3 bucket name is not valid.\n\t"
},
{
"shape_name": "InvalidS3PrefixException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided S3 prefix is not valid.\n\t"
},
{
"shape_name": "InvalidSnsTopicNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided SNS topic name is not valid.\n\t"
},
{
"shape_name": "InvalidTrailNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
},
{
"shape_name": "TrailNotProvidedException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t"
}
],
"documentation": "\n <p>From the command line, use <code>create-subscription</code>. </p>\n <p>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. </p>\n <note>\n Support for passing <a>Trail</a> as a parameter ends as early as February 25, 2014. The request and response examples in this topic show the use of parameters as well as a Trail object. Until Trail is removed, you can use either Trail or the parameter list. \n \n </note>\n \n \n "
},
"DeleteTrail": {
"name": "DeleteTrail",
"input": {
"shape_name": "DeleteTrailRequest",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of a trail to be deleted.</p>\n ",
"required": true
}
},
"documentation": "\n <a>The request that specifies the name of a trail to delete.</a>\n "
},
"output": {
"shape_name": "DeleteTrailResponse",
"type": "structure",
"members": {},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "TrailNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t"
},
{
"shape_name": "InvalidTrailNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
}
],
"documentation": "\n <p>Deletes a trail.</p>\n "
},
"DescribeTrails": {
"name": "DescribeTrails",
"input": {
"shape_name": "DescribeTrailsRequest",
"type": "structure",
"members": {
"trailNameList": {
"shape_name": "TrailNameList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The list of trails.</p>\n "
}
},
"documentation": "\n <p>Returns the list of trails.</p>\n "
},
"output": {
"shape_name": "DescribeTrailsResponse",
"type": "structure",
"members": {
"trailList": {
"shape_name": "TrailList",
"type": "list",
"members": {
"shape_name": "Trail",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <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>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
}
},
"documentation": "\n <p>The settings for a trail.</p>\n "
},
"documentation": "\n <p>The list of trails.</p>\n "
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [],
"documentation": "\n <p>Retrieves the settings for some or all trails associated with an account. </p>\n "
},
"GetTrailStatus": {
"name": "GetTrailStatus",
"input": {
"shape_name": "GetTrailStatusRequest",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the trail for which you are requesting the current status.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The name of a trail about which you want the current status.</p>\n "
},
"output": {
"shape_name": "GetTrailStatusResponse",
"type": "structure",
"members": {
"IsLogging": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Whether the CloudTrail is currently logging AWS API calls.</p>\n "
},
"LatestDeliveryError": {
"shape_name": "String",
"type": "string",
"documentation": "\n <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>\n "
},
"LatestNotificationError": {
"shape_name": "String",
"type": "string",
"documentation": "\n <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>\n "
},
"LatestDeliveryTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": "\n <p>Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.</p>\n "
},
"LatestNotificationTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": "\n <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>\n "
},
"StartLoggingTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": "\n <p>Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account. </p>\n "
},
"StopLoggingTime": {
"shape_name": "Date",
"type": "timestamp",
"documentation": "\n <p>Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account. </p>\n "
},
"LatestDeliveryAttemptTime": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
},
"LatestNotificationAttemptTime": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
},
"LatestNotificationAttemptSucceeded": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
},
"LatestDeliveryAttemptSucceeded": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
},
"TimeLoggingStarted": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
},
"TimeLoggingStopped": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
}
},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "TrailNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t"
},
{
"shape_name": "InvalidTrailNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
}
],
"documentation": "\n <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>\n \n <p>The CloudTrail API is currently undergoing revision. This action currently returns both\n new fields and fields slated for removal from the API. The following lists indicate the\n plans for each field: </p>\n\n<p><b>List of Members Planned for Ongoing Support</b></p>\n<ul>\n <li>IsLogging</li>\n <li>LatestDeliveryTime</li>\n <li>LatestNotificationTime</li>\n <li>StartLoggingTime</li>\n <li>StopLoggingTime</li>\n <li>LatestNotificationError</li>\n <li>LatestDeliveryError</li>\n</ul>\n\n<p><b>List of Members Scheduled for Removal</b></p>\n<ul>\n <li>\n<b>LatestDeliveryAttemptTime</b>: Use <i>LatestDeliveryTime</i> instead.</li>\n <li>\n<b>LatestNotificationAttemptTime</b>: Use <i>LatestNotificationTime</i> instead. </li>\n <li>\n<b>LatestDeliveryAttemptSucceeded</b>: No replacement. See the note following this list.</li>\n <li>\n<b>LatestNotificationAttemptSucceeded</b>: No replacement. See the note following this list. </li>\n <li>\n<b>TimeLoggingStarted</b>: Use <i>StartLoggingTime</i> instead.</li>\n <li>\n<b>TimeLoggingStopped</b>: Use <i>StopLoggingtime</i> instead.</li>\n \n</ul>\n \n<note>\n No replacements have been created for <i>LatestDeliveryAttemptSucceeded</i> and <i>LatestNotificationAttemptSucceeded</i>. Use <i>LatestDeliveryError</i> and <i>LatestNotificationError</i> to evaluate success or failure of log delivery or notification. Empty values returned for these fields indicate success. An error in <i>LatestDeliveryError</i> generally indicates either a missing bucket or insufficient permissions to write to the bucket. Similarly, an error in <i>LatestNotificationError</i> indicates either a missing topic or insufficient permissions. \n \n</note> \n\n\n "
},
"StartLogging": {
"name": "StartLogging",
"input": {
"shape_name": "StartLoggingRequest",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the trail for which CloudTrail logs AWS API calls.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The request to CloudTrail to start logging AWS API calls for an account.</p>\n "
},
"output": {
"shape_name": "StartLoggingResponse",
"type": "structure",
"members": {},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "TrailNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t"
},
{
"shape_name": "InvalidTrailNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
}
],
"documentation": "\n <p>Starts the recording of AWS API calls and log file delivery for a trail.</p>\n "
},
"StopLogging": {
"name": "StopLogging",
"input": {
"shape_name": "StopLoggingRequest",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Communicates to CloudTrail the name of the trail for which to stop logging AWS API calls.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Passes the request to CloudTrail to stop logging AWS API calls for the specified account.</p>\n "
},
"output": {
"shape_name": "StopLoggingResponse",
"type": "structure",
"members": {},
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
},
"errors": [
{
"shape_name": "TrailNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t"
},
{
"shape_name": "InvalidTrailNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
}
],
"documentation": "\n <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>\n "
},
"UpdateTrail": {
"name": "UpdateTrail",
"input": {
"shape_name": "UpdateTrailRequest",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the trail.</p>\n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.</p>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>\n "
},
"trail": {
"shape_name": "Trail",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <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>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
}
},
"documentation": "\n <p>Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions. </p>\n "
}
},
"documentation": "\n <p>Specifies settings to update for the trail.</p>\n "
},
"output": {
"shape_name": "UpdateTrailResponse",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the trail.</p>\n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.</p>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>\n "
},
"trail": {
"shape_name": "Trail",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
},
"S3BucketName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
},
"S3KeyPrefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
},
"SnsTopicName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <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>\n "
},
"IncludeGlobalServiceEvents": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
}
},
"documentation": "\n <p>Represents the CloudTrail settings that were updated by calling <a>UpdateTrail</a>.</p>\n "
}
},
"documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n "
},
"errors": [
{
"shape_name": "S3BucketDoesNotExistException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the specified S3 bucket does not exist.\n\t"
},
{
"shape_name": "InsufficientS3BucketPolicyException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the policy on the S3 bucket is not sufficient.\n\t"
},
{
"shape_name": "InsufficientSnsTopicPolicyException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the policy on the SNS topic is not sufficient.\n\t"
},
{
"shape_name": "TrailNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t"
},
{
"shape_name": "InvalidS3BucketNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided S3 bucket name is not valid.\n\t"
},
{
"shape_name": "InvalidS3PrefixException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided S3 prefix is not valid.\n\t"
},
{
"shape_name": "InvalidSnsTopicNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided SNS topic name is not valid.\n\t"
},
{
"shape_name": "InvalidTrailNameException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
},
{
"shape_name": "TrailNotProvidedException",
"type": "structure",
"members": {},
"documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t"
}
],
"documentation": "\n <p>From the command line, use <code>update-subscription</code>.</p> \n <p>Updates the settings that specify delivery of log files. Changes to a trail do not require\n stopping the CloudTrail service. Use this action to designate an existing bucket for log\n delivery. If the existing bucket has previously been a target for CloudTrail log files,\n an IAM policy exists for the bucket. </p>\n \n <note>\n Support for passing <a>Trail</a> as a parameter ends as early as February 25, 2014. The request and response examples in this topic show the use of parameters as well as a Trail object. Until Trail is removed, you can use either Trail or the parameter list. \n \n </note>\n \n "
}
},
"metadata": {
"regions": {
"us-east-1": "https://cloudtrail.us-east-1.amazonaws.com",
"us-west-2": "https://cloudtrail.us-west-2.amazonaws.com"
}
},
"retry": {
"__default__": {
"max_attempts": 5,
"delay": {
"type": "exponential",
"base": "rand",
"growth_factor": 2
},
"policies": {
"general_socket_errors": {
"applies_when": {
"socket_errors": [
"GENERAL_CONNECTION_ERROR"
]
}
},
"general_server_error": {
"applies_when": {
"response": {
"http_status_code": 500
}
}
},
"service_unavailable": {
"applies_when": {
"response": {
"http_status_code": 503
}
}
},
"limit_exceeded": {
"applies_when": {
"response": {
"http_status_code": 509
}
}
}
}
}
}
}
|