AWS cli documentation change
Summary
Updated AWS CLI version reference, added pagination token documentation, restructured audit event field descriptions, and added/enhanced parameter constraints (e.g., string length limits, IAM ARN validation).
Security assessment
The changes introduce input validation constraints (e.g., `stringValue` max length of 500, `iamPrincipalArn` min/max length) and clarify security-related field formats (e.g., ARN patterns). While these improve security posture by enforcing data integrity and preventing malformed inputs, there is no explicit mention of addressing a specific vulnerability or incident.
Diff
diff --git a/cli/latest/reference/connectcases/get-case-audit-events.md b/cli/latest/reference/connectcases/get-case-audit-events.md index 4b9c96e18..e51843cff 100644 --- a//cli/latest/reference/connectcases/get-case-audit-events.md +++ b//cli/latest/reference/connectcases/get-case-audit-events.md @@ -15 +15 @@ - * [AWS CLI 2.31.3 Command Reference](../../index.html) » + * [AWS CLI 2.31.5 Command Reference](../../index.html) » @@ -119 +119 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/connec -> The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided. +> The maximum number of audit events to return. When no value is provided, 25 is the default. @@ -237,0 +238,11 @@ Disable automatically prompt for CLI input parameters. +nextToken -> (string) + +> The token for the next set of results. This is null if there are no more results to return. +> +> Constraints: +> +> * min: `0` +> * max: `9000` +> + + @@ -262,0 +274,31 @@ auditEvents -> (list) +>> +>> type -> (string) [required] +>> +>>> The Type of an audit history event. +>>> +>>> Possible values: +>>> +>>> * `Case.Created` +>>> * `Case.Updated` +>>> * `RelatedItem.Created` +>>> + +>> +>> relatedItemType -> (string) +>> +>>> The Type of the related item. +>>> +>>> Possible values: +>>> +>>> * `Contact` +>>> * `Comment` +>>> * `File` +>>> * `Sla` +>>> * `ConnectCase` +>>> * `Custom` +>>> + +>> +>> performedTime -> (timestamp) [required] +>> +>>> Time at which an Audit History event took place. @@ -283 +325 @@ auditEvents -> (list) ->>>> newValue -> (tagged union structure) [required] +>>>> oldValue -> (tagged union structure) @@ -289 +331 @@ auditEvents -> (list) ->>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `booleanValue`, `doubleValue`, `emptyValue`, `stringValue`, `userArnValue`. +>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `stringValue`, `doubleValue`, `booleanValue`, `emptyValue`, `userArnValue`. @@ -291 +333 @@ auditEvents -> (list) ->>>>> booleanValue -> (boolean) +>>>>> stringValue -> (string) @@ -293 +335,8 @@ auditEvents -> (list) ->>>>>> Can be either null, or have a Boolean value type. Only one value can be provided. +>>>>>> Can be either null, or have a String value type. Only one value can be provided. +>>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `0` +>>>>>> * max: `500` +>>>>>> + @@ -298,0 +348,4 @@ auditEvents -> (list) +>>>>> booleanValue -> (boolean) +>>>>> +>>>>>> Can be either null, or have a Boolean value type. Only one value can be provided. +>>>>> @@ -304,0 +358,12 @@ auditEvents -> (list) +>>>>> userArnValue -> (string) +>>>>> +>>>>>> Can be either null, or have a String value type formatted as an ARN. Only one value can be provided. +>>>> +>>>> newValue -> (tagged union structure) [required] +>>>> +>>>>> Union of potential field value types. +>>>>> +>>>>> ### Note +>>>>> +>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `stringValue`, `doubleValue`, `booleanValue`, `emptyValue`, `userArnValue`. +>>>>> @@ -316,9 +381 @@ auditEvents -> (list) ->>>>> userArnValue -> (string) ->>>>> ->>>>>> Can be either null, or have a String value type formatted as an ARN. Only one value can be provided. ->>>> ->>>> oldValue -> (tagged union structure) ->>>> ->>>>> Union of potential field value types. ->>>>> ->>>>> ### Note +>>>>> doubleValue -> (double) @@ -326 +383 @@ auditEvents -> (list) ->>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `booleanValue`, `doubleValue`, `emptyValue`, `stringValue`, `userArnValue`. +>>>>>> Can be either null, or have a Double value type. Only one value can be provided. @@ -332,4 +388,0 @@ auditEvents -> (list) ->>>>> doubleValue -> (double) ->>>>> ->>>>>> Can be either null, or have a Double value type. Only one value can be provided. ->>>>> @@ -341,11 +393,0 @@ auditEvents -> (list) ->>>>> ->>>>> stringValue -> (string) ->>>>> ->>>>>> Can be either null, or have a String value type. Only one value can be provided. ->>>>>> ->>>>>> Constraints: ->>>>>> ->>>>>> * min: `0` ->>>>>> * max: `500` ->>>>>> - @@ -360,11 +401,0 @@ auditEvents -> (list) ->>> ->>> iamPrincipalArn -> (string) [required] ->>> ->>>> Unique identifier of an IAM role. ->>>> ->>>> Constraints: ->>>> ->>>> * min: `1` ->>>> * max: `500` ->>>> - @@ -378 +409 @@ auditEvents -> (list) ->>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `customEntity`, `userArn`. +>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `userArn`, `customEntity`. @@ -380 +411 @@ auditEvents -> (list) ->>>> customEntity -> (string) +>>>> userArn -> (string) @@ -382 +413 @@ auditEvents -> (list) ->>>>> Any provided entity. +>>>>> Represents the Amazon Connect ARN of the user. @@ -388 +418,0 @@ auditEvents -> (list) ->>>>> * pattern: `^[a-zA-Z0-9_\-\.@:/ ]*[a-zA-Z0-9_\-\.@:/]$` @@ -392 +422 @@ auditEvents -> (list) ->>>> userArn -> (string) +>>>> customEntity -> (string) @@ -394 +424 @@ auditEvents -> (list) ->>>>> Represents the Amazon Connect ARN of the user. +>>>>> Any provided entity. @@ -399,0 +430 @@ auditEvents -> (list) +>>>>> * pattern: `[a-zA-Z0-9_\-\.@:/ ]*[a-zA-Z0-9_\-\.@:/]` @@ -402,21 +432,0 @@ auditEvents -> (list) ->> ->> performedTime -> (timestamp) [required] ->> ->>> Time at which an Audit History event took place. ->> ->> relatedItemType -> (string) ->> ->>> The Type of the related item. ->>> ->>> Possible values: ->>> ->>> * `Contact` ->>> * `Comment` ->>> * `File` ->>> * `Sla` ->>> - ->> ->> type -> (string) [required] ->> ->>> The Type of an audit history event. @@ -424,5 +434 @@ auditEvents -> (list) ->>> Possible values: ->>> ->>> * `Case.Created` ->>> * `Case.Updated` ->>> * `RelatedItem.Created` +>>> iamPrincipalArn -> (string) [required] @@ -430,11 +436,7 @@ auditEvents -> (list) - - -nextToken -> (string) - -> The token for the next set of results. This is null if there are no more results to return. -> -> Constraints: -> -> * min: `0` -> * max: `9000` -> +>>>> Unique identifier of an IAM role. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `500`