diff --git a/clients/client-securityhub/src/models/models_0.ts b/clients/client-securityhub/src/models/models_0.ts index a30f7219c80b..34ea9928a7bd 100644 --- a/clients/client-securityhub/src/models/models_0.ts +++ b/clients/client-securityhub/src/models/models_0.ts @@ -370,7 +370,7 @@ export interface AwsApiCallAction { CallerType?: string; /** - *
Provided if CallerType
is remoteIp
. Provides information about
+ *
Provided if CallerType
is remoteip
. Provides information about
* the remote IP address that the API call originated from.
Contains finding details that are specific to control-based findings. Only returned for - * findings generated from controls.
+ *This object typically provides details about a control finding, such as applicable standards and the status of
+ * control checks. While finding providers can add custom content in Compliance
object fields, they are
+ * typically used to review details of Security Hub control findings.
The result of a standards check.
- *The valid values for Status
are as follows.
Typically summarizes the result of a control check.
+ *For Security Hub controls, valid values for Status
are as follows.
For a control, the industry or regulatory framework requirements that are related to the + *
Typically provides the industry or regulatory framework requirements that are related to a * control. The check for that control is aligned with these requirements.
*Array Members: Maximum number of 32 items.
* @public @@ -10035,24 +10036,22 @@ export interface Compliance { RelatedRequirements?: string[]; /** - *For findings generated from controls, a list of reasons behind the value of
- * Status
. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the
- * Security Hub User Guide.
Typically used to provide a list of reasons for the value of Status
.
- * The unique identifier of a control across standards. Values for this field typically consist of an
- * Amazon Web Servicesservice and a number, such as APIGateway.5.
+ * Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an
+ * Amazon Web Servicesservice and a unique number, such as APIGateway.5
.
*
The enabled security standards in which a security control is currently enabled. + *
Typically provides an array of enabled security standards in which a security control is currently enabled. *
* @public */ @@ -10060,7 +10059,7 @@ export interface Compliance { /** *- * An object that includes security control parameter names and values. + * Typically an object that includes security control parameter names and values. *
* @public */ diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index 1beb307ca6bb..7d23dec5b1b9 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -1512,7 +1512,7 @@ "RemoteIpDetails": { "target": "com.amazonaws.securityhub#ActionRemoteIpDetails", "traits": { - "smithy.api#documentation": "Provided if CallerType
is remoteIp
. Provides information about\n the remote IP address that the API call originated from.
Provided if CallerType
is remoteip
. Provides information about\n the remote IP address that the API call originated from.
The result of a standards check.
\nThe valid values for Status
are as follows.
\n PASSED
- Standards check passed for all evaluated\n resources.
\n WARNING
- Some information is missing or this check is not\n supported for your configuration.
\n FAILED
- Standards check failed for at least one evaluated\n resource.
\n NOT_AVAILABLE
- Check could not be performed due to a service\n outage, API error, or because the result of the Config evaluation was\n NOT_APPLICABLE
. If the Config evaluation result was\n NOT_APPLICABLE
for a Security Hub control, Security Hub automatically archives\n the finding after 3 days.
Typically summarizes the result of a control check.
\nFor Security Hub controls, valid values for Status
are as follows.
\n PASSED
- Standards check passed for all evaluated\n resources.
\n WARNING
- Some information is missing or this check is not\n supported for your configuration.
\n FAILED
- Standards check failed for at least one evaluated\n resource.
\n NOT_AVAILABLE
- Check could not be performed due to a service\n outage, API error, or because the result of the Config evaluation was\n NOT_APPLICABLE
. If the Config evaluation result was\n NOT_APPLICABLE
for a Security Hub control, Security Hub automatically archives\n the finding after 3 days.
For a control, the industry or regulatory framework requirements that are related to the\n control. The check for that control is aligned with these requirements.
\nArray Members: Maximum number of 32 items.
" + "smithy.api#documentation": "Typically provides the industry or regulatory framework requirements that are related to a\n control. The check for that control is aligned with these requirements.
\nArray Members: Maximum number of 32 items.
" } }, "StatusReasons": { "target": "com.amazonaws.securityhub#StatusReasonsList", "traits": { - "smithy.api#documentation": "For findings generated from controls, a list of reasons behind the value of\n Status
. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the\n Security Hub User Guide.
Typically used to provide a list of reasons for the value of Status
.
\n The unique identifier of a control across standards. Values for this field typically consist of an \n Amazon Web Servicesservice and a number, such as APIGateway.5.\n
" + "smithy.api#documentation": "\n Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an \n Amazon Web Servicesservice and a unique number, such as APIGateway.5
.\n
The enabled security standards in which a security control is currently enabled.\n
" + "smithy.api#documentation": "Typically provides an array of enabled security standards in which a security control is currently enabled.\n
" } }, "SecurityControlParameters": { "target": "com.amazonaws.securityhub#SecurityControlParametersList", "traits": { - "smithy.api#documentation": "\n An object that includes security control parameter names and values.\n
" + "smithy.api#documentation": "\n Typically an object that includes security control parameter names and values.\n
" } } }, "traits": { - "smithy.api#documentation": "Contains finding details that are specific to control-based findings. Only returned for\n findings generated from controls.
" + "smithy.api#documentation": "This object typically provides details about a control finding, such as applicable standards and the status of \n control checks. While finding providers can add custom content in Compliance
object fields, they are \n typically used to review details of Security Hub control findings.