Skip to content

Commit

Permalink
docs(client-securityhub): Documentation update for Security Hub
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Sep 10, 2024
1 parent 28a1dee commit 968260e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 21 deletions.
2 changes: 1 addition & 1 deletion clients/client-securityhub/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ export interface AwsApiCallAction {
CallerType?: string;

/**
* <p>Provided if <code>CallerType</code> is <code>remoteIp</code>. Provides information about
* <p>Provided if <code>CallerType</code> is <code>remoteip</code>. Provides information about
* the remote IP address that the API call originated from.</p>
* @public
*/
Expand Down
23 changes: 11 additions & 12 deletions clients/client-securityhub/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9985,14 +9985,15 @@ export interface StatusReason {
}

/**
* <p>Contains finding details that are specific to control-based findings. Only returned for
* findings generated from controls.</p>
* <p>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 <code>Compliance</code> object fields, they are
* typically used to review details of Security Hub control findings.</p>
* @public
*/
export interface Compliance {
/**
* <p>The result of a standards check.</p>
* <p>The valid values for <code>Status</code> are as follows.</p>
* <p>Typically summarizes the result of a control check.</p>
* <p>For Security Hub controls, valid values for <code>Status</code> are as follows.</p>
* <ul>
* <li>
* <ul>
Expand Down Expand Up @@ -10027,40 +10028,38 @@ export interface Compliance {
Status?: ComplianceStatus;

/**
* <p>For a control, the industry or regulatory framework requirements that are related to the
* <p>Typically provides the industry or regulatory framework requirements that are related to a
* control. The check for that control is aligned with these requirements.</p>
* <p>Array Members: Maximum number of 32 items.</p>
* @public
*/
RelatedRequirements?: string[];

/**
* <p>For findings generated from controls, a list of reasons behind the value of
* <code>Status</code>. For the list of status reason codes and their meanings, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff">Standards-related information in the ASFF</a> in the
* <i>Security Hub User Guide</i>. </p>
* <p>Typically used to provide a list of reasons for the value of <code>Status</code>.</p>
* @public
*/
StatusReasons?: StatusReason[];

/**
* <p>
* 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 <code>APIGateway.5</code>.
* </p>
* @public
*/
SecurityControlId?: string;

/**
* <p>The enabled security standards in which a security control is currently enabled.
* <p>Typically provides an array of enabled security standards in which a security control is currently enabled.
* </p>
* @public
*/
AssociatedStandards?: AssociatedStandard[];

/**
* <p>
* An object that includes security control parameter names and values.
* Typically an object that includes security control parameter names and values.
* </p>
* @public
*/
Expand Down
16 changes: 8 additions & 8 deletions codegen/sdk-codegen/aws-models/securityhub.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1512,7 +1512,7 @@
"RemoteIpDetails": {
"target": "com.amazonaws.securityhub#ActionRemoteIpDetails",
"traits": {
"smithy.api#documentation": "<p>Provided if <code>CallerType</code> is <code>remoteIp</code>. Provides information about\n the remote IP address that the API call originated from.</p>"
"smithy.api#documentation": "<p>Provided if <code>CallerType</code> is <code>remoteip</code>. Provides information about\n the remote IP address that the API call originated from.</p>"
}
},
"DomainDetails": {
Expand Down Expand Up @@ -22171,42 +22171,42 @@
"Status": {
"target": "com.amazonaws.securityhub#ComplianceStatus",
"traits": {
"smithy.api#documentation": "<p>The result of a standards check.</p>\n <p>The valid values for <code>Status</code> are as follows.</p>\n <ul>\n <li>\n <ul>\n <li>\n <p>\n <code>PASSED</code> - Standards check passed for all evaluated\n resources.</p>\n </li>\n <li>\n <p>\n <code>WARNING</code> - Some information is missing or this check is not\n supported for your configuration.</p>\n </li>\n <li>\n <p>\n <code>FAILED</code> - Standards check failed for at least one evaluated\n resource.</p>\n </li>\n <li>\n <p>\n <code>NOT_AVAILABLE</code> - Check could not be performed due to a service\n outage, API error, or because the result of the Config evaluation was\n <code>NOT_APPLICABLE</code>. If the Config evaluation result was\n <code>NOT_APPLICABLE</code> for a Security Hub control, Security Hub automatically archives\n the finding after 3 days.</p>\n </li>\n </ul>\n </li>\n </ul>"
"smithy.api#documentation": "<p>Typically summarizes the result of a control check.</p>\n <p>For Security Hub controls, valid values for <code>Status</code> are as follows.</p>\n <ul>\n <li>\n <ul>\n <li>\n <p>\n <code>PASSED</code> - Standards check passed for all evaluated\n resources.</p>\n </li>\n <li>\n <p>\n <code>WARNING</code> - Some information is missing or this check is not\n supported for your configuration.</p>\n </li>\n <li>\n <p>\n <code>FAILED</code> - Standards check failed for at least one evaluated\n resource.</p>\n </li>\n <li>\n <p>\n <code>NOT_AVAILABLE</code> - Check could not be performed due to a service\n outage, API error, or because the result of the Config evaluation was\n <code>NOT_APPLICABLE</code>. If the Config evaluation result was\n <code>NOT_APPLICABLE</code> for a Security Hub control, Security Hub automatically archives\n the finding after 3 days.</p>\n </li>\n </ul>\n </li>\n </ul>"
}
},
"RelatedRequirements": {
"target": "com.amazonaws.securityhub#RelatedRequirementsList",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n <p>Array Members: Maximum number of 32 items.</p>"
"smithy.api#documentation": "<p>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.</p>\n <p>Array Members: Maximum number of 32 items.</p>"
}
},
"StatusReasons": {
"target": "com.amazonaws.securityhub#StatusReasonsList",
"traits": {
"smithy.api#documentation": "<p>For findings generated from controls, a list of reasons behind the value of\n <code>Status</code>. For the list of status reason codes and their meanings, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff\">Standards-related information in the ASFF</a> in the\n <i>Security Hub User Guide</i>. </p>"
"smithy.api#documentation": "<p>Typically used to provide a list of reasons for the value of <code>Status</code>.</p>"
}
},
"SecurityControlId": {
"target": "com.amazonaws.securityhub#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>\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 </p>"
"smithy.api#documentation": "<p>\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 <code>APIGateway.5</code>.\n </p>"
}
},
"AssociatedStandards": {
"target": "com.amazonaws.securityhub#AssociatedStandardsList",
"traits": {
"smithy.api#documentation": "<p>The enabled security standards in which a security control is currently enabled.\n </p>"
"smithy.api#documentation": "<p>Typically provides an array of enabled security standards in which a security control is currently enabled.\n </p>"
}
},
"SecurityControlParameters": {
"target": "com.amazonaws.securityhub#SecurityControlParametersList",
"traits": {
"smithy.api#documentation": "<p>\n An object that includes security control parameter names and values.\n </p>"
"smithy.api#documentation": "<p>\n Typically an object that includes security control parameter names and values.\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains finding details that are specific to control-based findings. Only returned for\n findings generated from controls.</p>"
"smithy.api#documentation": "<p>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 <code>Compliance</code> object fields, they are \n typically used to review details of Security Hub control findings.</p>"
}
},
"com.amazonaws.securityhub#ComplianceStatus": {
Expand Down

0 comments on commit 968260e

Please sign in to comment.