Skip to content

Commit

Permalink
docs(client-cloudtrail): Documentation updates for CloudTrail.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Aug 10, 2023
1 parent 6cdc987 commit 7cf068b
Show file tree
Hide file tree
Showing 4 changed files with 8,984 additions and 8,923 deletions.
2 changes: 1 addition & 1 deletion clients/client-cloudtrail/src/commands/StartQueryCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
* <p>This exception is thrown when the provided S3 prefix is not valid.</p>
*
* @throws {@link MaxConcurrentQueriesException} (client fault)
* <p>You are already running the maximum number of concurrent queries. Wait a minute for some
* <p>You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some
* queries to finish, and then run the query again.</p>
*
* @throws {@link NoManagementAccountSLRExistsException} (client fault)
Expand Down
2 changes: 1 addition & 1 deletion clients/client-cloudtrail/src/endpoint/ruleset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ o={[t]:"booleanEquals",[u]:[true,{[t]:"getAttr",[u]:[{[v]:e},"supportsDualStack"
p=[j],
q=[k],
r=[m];
const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]}]},{type:b,rules:[{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[n,o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://cloudtrail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[n],type:b,rules:[{type:b,rules:[{conditions:[{[t]:f,[u]:[m,"us-gov-east-1"]}],endpoint:{url:"https://cloudtrail.us-gov-east-1.amazonaws.com",properties:l,headers:l},type:d},{conditions:[{[t]:f,[u]:[m,"us-gov-west-1"]}],endpoint:{url:"https://cloudtrail.us-gov-west-1.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://cloudtrail.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://cloudtrail.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]},{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[n,o],type:b,rules:[{endpoint:{url:"https://cloudtrail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[n],type:b,rules:[{conditions:[{[t]:f,[u]:[m,"us-gov-east-1"]}],endpoint:{url:"https://cloudtrail.us-gov-east-1.amazonaws.com",properties:l,headers:l},type:d},{conditions:[{[t]:f,[u]:[m,"us-gov-west-1"]}],endpoint:{url:"https://cloudtrail.us-gov-west-1.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{endpoint:{url:"https://cloudtrail.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://cloudtrail.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]};
export const ruleSet: RuleSetObject = _data;
103 changes: 100 additions & 3 deletions clients/client-cloudtrail/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -774,11 +774,21 @@ export interface AdvancedFieldSelector {
* </li>
* <li>
* <p>
* <code>AWS::ManagedBlockchain::Network</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::ManagedBlockchain::Node</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::MedicalImaging::Datastore</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::SageMaker::ExperimentTrialComponent</code>
* </p>
* </li>
Expand All @@ -802,6 +812,16 @@ export interface AdvancedFieldSelector {
* <code>AWS::S3Outposts::Object</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::SSMMessages::ControlChannel</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::VerifiedPermissions::PolicyStore</code>
* </p>
* </li>
* </ul>
* <p> You can have only one <code>resources.type</code> field per selector. To log data
* events on more than one resource type, add another selector.</p>
Expand Down Expand Up @@ -952,6 +972,16 @@ export interface AdvancedFieldSelector {
* </p>
* </li>
* </ul>
* <p>When <code>resources.type</code> equals <code>AWS::ManagedBlockchain::Network</code>,
* and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN
* must be in the following format:</p>
* <ul>
* <li>
* <p>
* <code>arn:<partition>:managedblockchain:::networks/<network_name></code>
* </p>
* </li>
* </ul>
* <p>When <code>resources.type</code> equals <code>AWS::ManagedBlockchain::Node</code>,
* and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN
* must be in the following format:</p>
Expand All @@ -962,6 +992,16 @@ export interface AdvancedFieldSelector {
* </p>
* </li>
* </ul>
* <p>When <code>resources.type</code> equals <code>AWS::MedicalImaging::Datastore</code>,
* and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN
* must be in the following format:</p>
* <ul>
* <li>
* <p>
* <code>arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID></code>
* </p>
* </li>
* </ul>
* <p>When <code>resources.type</code> equals <code>AWS::SageMaker::ExperimentTrialComponent</code>, and the operator is set to
* <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>
* <ul>
Expand Down Expand Up @@ -1018,6 +1058,26 @@ export interface AdvancedFieldSelector {
* </p>
* </li>
* </ul>
* <p>When <code>resources.type</code> equals <code>AWS::SSMMessages::ControlChannel</code>, and
* the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be
* in the following format:</p>
* <ul>
* <li>
* <p>
* <code>arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID></code>
* </p>
* </li>
* </ul>
* <p>When resources.type equals <code>AWS::VerifiedPermissions::PolicyStore</code>, and the operator is
* set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the
* following format:</p>
* <ul>
* <li>
* <p>
* <code>arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID></code>
* </p>
* </li>
* </ul>
* </li>
* </ul>
*/
Expand Down Expand Up @@ -1611,7 +1671,17 @@ export interface CreateEventDataStoreRequest {
/**
* @public
* <p>The retention period of the event data store, in days. You can set a retention period of
* up to 2557 days, the equivalent of seven years.</p>
* up to 2557 days, the equivalent of seven years. CloudTrail Lake determines whether to retain an event by checking if the <code>eventTime</code>
* of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events
* when the <code>eventTime</code> is older than 90 days.</p>
* <note>
* <p>If you plan to copy trail events to this event data store, we recommend
* that you consider both the age of the events that you
* want to copy as well as how long you want to keep the copied events
* in your event data store. For example, if you copy trail events that are 5 years old
* and specify a retention period of 7 years, the event data store
* will retain those events for two years.</p>
* </note>
*/
RetentionPeriod?: number;

Expand Down Expand Up @@ -3727,11 +3797,21 @@ export interface DataResource {
* </li>
* <li>
* <p>
* <code>AWS::ManagedBlockchain::Network</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::ManagedBlockchain::Node</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::MedicalImaging::Datastore</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::SageMaker::ExperimentTrialComponent</code>
* </p>
* </li>
Expand All @@ -3755,6 +3835,16 @@ export interface DataResource {
* <code>AWS::S3Outposts::Object</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::SSMMessages::ControlChannel</code>
* </p>
* </li>
* <li>
* <p>
* <code>AWS::VerifiedPermissions::PolicyStore</code>
* </p>
* </li>
* </ul>
*/
Type?: string;
Expand Down Expand Up @@ -6249,7 +6339,7 @@ export class InvalidQueryStatementException extends __BaseException {

/**
* @public
* <p>You are already running the maximum number of concurrent queries. Wait a minute for some
* <p>You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some
* queries to finish, and then run the query again.</p>
*/
export class MaxConcurrentQueriesException extends __BaseException {
Expand Down Expand Up @@ -6527,7 +6617,14 @@ export interface UpdateEventDataStoreRequest {

/**
* @public
* <p>The retention period, in days.</p>
* <p>The retention period of the event data store, in days. You can set a retention period of
* up to 2557 days, the equivalent of seven years. CloudTrail Lake determines whether to retain an event by checking if the <code>eventTime</code>
* of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events
* when the <code>eventTime</code> is older than 90 days.</p>
* <note>
* <p>If you decrease the retention period of an event data store, CloudTrail will remove any events with an <code>eventTime</code> older than the new retention period. For example, if the previous
* retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an <code>eventTime</code> older than 100 days.</p>
* </note>
*/
RetentionPeriod?: number;

Expand Down
Loading

0 comments on commit 7cf068b

Please sign in to comment.