AWS cli documentation change
Summary
Updated documentation to reference Security Hub CSPM instead of generic Security Hub, added --cli-error-format parameter, and updated API response syntax descriptions
Security assessment
The changes primarily update references from Security Hub to Security Hub CSPM (Cloud Security Posture Management), indicating a product-specific documentation refinement rather than addressing a security vulnerability. The added --cli-error-format parameter is a general CLI usability improvement. No evidence of security vulnerability fixes or new security features being documented.
Diff
diff --git a/cli/latest/reference/securityhub/get-finding-history.md b/cli/latest/reference/securityhub/get-finding-history.md index 28cb3bbc4..bb8baeab3 100644 --- a//cli/latest/reference/securityhub/get-finding-history.md +++ b//cli/latest/reference/securityhub/get-finding-history.md @@ -15 +15 @@ - * [AWS CLI 2.33.29 Command Reference](../../index.html) » + * [AWS CLI 2.34.0 Command Reference](../../index.html) » @@ -60 +60 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -Returns the history of a Security Hub finding. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF) except top-level timestamp fields, such as the `CreatedAt` and `UpdatedAt` fields. +Returns the history of a Security Hub CSPM finding. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF) except top-level timestamp fields, such as the `CreatedAt` and `UpdatedAt` fields. @@ -97,0 +98 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/securi + [--cli-error-format <value>] @@ -118 +119 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/securi ->> The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration. +>> The ARN generated by Security Hub CSPM that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub CSPM, or the ARN for a custom integration. @@ -145 +146 @@ JSON Syntax: -> If you provide values for both `StartTime` and `EndTime` , Security Hub returns finding history for the specified time period. If you provide a value for `StartTime` but not for `EndTime` , Security Hub returns finding history from the `StartTime` to the time at which the API is called. If you provide a value for `EndTime` but not for `StartTime` , Security Hub returns finding history from the [CreatedAt](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt) timestamp of the finding to the `EndTime` . If you provide neither `StartTime` nor `EndTime` , Security Hub returns finding history from the `CreatedAt` timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results. +> If you provide values for both `StartTime` and `EndTime` , Security Hub CSPM returns finding history for the specified time period. If you provide a value for `StartTime` but not for `EndTime` , Security Hub CSPM returns finding history from the `StartTime` to the time at which the API is called. If you provide a value for `EndTime` but not for `StartTime` , Security Hub CSPM returns finding history from the [CreatedAt](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt) timestamp of the finding to the `EndTime` . If you provide neither `StartTime` nor `EndTime` , Security Hub CSPM returns finding history from the `CreatedAt` timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results. @@ -147 +148 @@ JSON Syntax: -> For more information about the validation and formatting of timestamp fields in Security Hub, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . +> For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . @@ -153 +154 @@ JSON Syntax: -> If you provide values for both `StartTime` and `EndTime` , Security Hub returns finding history for the specified time period. If you provide a value for `StartTime` but not for `EndTime` , Security Hub returns finding history from the `StartTime` to the time at which the API is called. If you provide a value for `EndTime` but not for `StartTime` , Security Hub returns finding history from the [CreatedAt](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt) timestamp of the finding to the `EndTime` . If you provide neither `StartTime` nor `EndTime` , Security Hub returns finding history from the `CreatedAt` timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results. +> If you provide values for both `StartTime` and `EndTime` , Security Hub CSPM returns finding history for the specified time period. If you provide a value for `StartTime` but not for `EndTime` , Security Hub CSPM returns finding history from the `StartTime` to the time at which the API is called. If you provide a value for `EndTime` but not for `StartTime` , Security Hub CSPM returns finding history from the [CreatedAt](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt) timestamp of the finding to the `EndTime` . If you provide neither `StartTime` nor `EndTime` , Security Hub CSPM returns finding history from the `CreatedAt` timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results. @@ -155 +156 @@ JSON Syntax: -> For more information about the validation and formatting of timestamp fields in Security Hub, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . +> For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . @@ -205,0 +207 @@ The formatting style for command output. + * off @@ -271,0 +274,13 @@ Disable automatically prompt for CLI input parameters. +`--cli-error-format` (string) + +The formatting style for error output. By default, errors are displayed in enhanced format. + + * legacy + * json + * yaml + * text + * table + * enhanced + + + @@ -373 +388 @@ Records -> (list) ->>>> The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration. +>>>> The ARN generated by Security Hub CSPM that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub CSPM, or the ARN for a custom integration. @@ -383 +398 @@ Records -> (list) ->>> A timestamp that indicates when Security Hub processed the updated finding record. +>>> A timestamp that indicates when Security Hub CSPM processed the updated finding record. @@ -385 +400 @@ Records -> (list) ->>> For more information about the validation and formatting of timestamp fields in Security Hub, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . +>>> For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps) . @@ -393 +408 @@ Records -> (list) ->>> Identifies the source of the event that changed the finding. For example, an integrated Amazon Web Services service or third-party partner integration may call ` `BatchImportFindings` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings>.html`__ , or an Security Hub customer may call ` `BatchUpdateFindings` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings>.html`__ . +>>> Identifies the source of the event that changed the finding. For example, an integrated Amazon Web Services service or third-party partner integration may call ` `BatchImportFindings` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings>.html`__ , or an Security Hub CSPM customer may call ` `BatchUpdateFindings` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings>.html`__ . @@ -397 +412 @@ Records -> (list) ->>>> Describes the type of finding change event, such as a call to ` `BatchImportFindings` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings>.html`__ (by an integrated Amazon Web Services service or third party partner integration) or ` `BatchUpdateFindings` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings>.html`__ (by a Security Hub customer). +>>>> Describes the type of finding change event, such as a call to ` `BatchImportFindings` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings>.html`__ (by an integrated Amazon Web Services service or third party partner integration) or ` `BatchUpdateFindings` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings>.html`__ (by a Security Hub CSPM customer). @@ -446 +461 @@ Records -> (list) ->>>>> The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub omits this value if ` `FindingHistoryRecord` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_FindingHistoryRecord>.html`__ exceeds database limits. +>>>>> The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub CSPM omits this value if ` `FindingHistoryRecord` <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_FindingHistoryRecord>.html`__ exceeds database limits. @@ -472 +487 @@ NextToken -> (string) - * [AWS CLI 2.33.29 Command Reference](../../index.html) » + * [AWS CLI 2.34.0 Command Reference](../../index.html) »