|
43 | 43 | {"shape":"InvalidAccessException"},
|
44 | 44 | {"shape":"LimitExceededException"}
|
45 | 45 | ],
|
46 |
| - "documentation":"<p>Disables the standards specified by the provided <code>StandardsSubscriptionArns</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Compliance Standards</a> section of the <i>AWS Security Hub User Guide</i>.</p>" |
| 46 | + "documentation":"<p>Disables the standards specified by the provided <code>StandardsSubscriptionArns</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Security Standards</a> section of the <i>AWS Security Hub User Guide</i>.</p>" |
47 | 47 | },
|
48 | 48 | "BatchEnableStandards":{
|
49 | 49 | "name":"BatchEnableStandards",
|
|
59 | 59 | {"shape":"InvalidAccessException"},
|
60 | 60 | {"shape":"LimitExceededException"}
|
61 | 61 | ],
|
62 |
| - "documentation":"<p>Enables the standards specified by the provided <code>StandardsArn</code>. To obtain the ARN for a standard, use the <code> <a>DescribeStandards</a> </code> operation.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Compliance Standards</a> section of the <i>AWS Security Hub User Guide</i>.</p>" |
| 62 | + "documentation":"<p>Enables the standards specified by the provided <code>StandardsArn</code>. To obtain the ARN for a standard, use the <code> <a>DescribeStandards</a> </code> operation.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Security Standards</a> section of the <i>AWS Security Hub User Guide</i>.</p>" |
63 | 63 | },
|
64 | 64 | "BatchImportFindings":{
|
65 | 65 | "name":"BatchImportFindings",
|
|
289 | 289 | {"shape":"InvalidAccessException"},
|
290 | 290 | {"shape":"ResourceNotFoundException"}
|
291 | 291 | ],
|
292 |
| - "documentation":"<p>Returns a list of compliance standards controls.</p> <p>For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.</p>" |
| 292 | + "documentation":"<p>Returns a list of security standards controls.</p> <p>For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.</p>" |
293 | 293 | },
|
294 | 294 | "DisableImportFindingsForProduct":{
|
295 | 295 | "name":"DisableImportFindingsForProduct",
|
|
682 | 682 | {"shape":"InvalidAccessException"},
|
683 | 683 | {"shape":"ResourceNotFoundException"}
|
684 | 684 | ],
|
685 |
| - "documentation":"<p>Used to control whether an individual compliance standard control is enabled or disabled.</p>" |
| 685 | + "documentation":"<p>Used to control whether an individual security standard control is enabled or disabled.</p>" |
686 | 686 | }
|
687 | 687 | },
|
688 | 688 | "shapes":{
|
|
1694 | 1694 | },
|
1695 | 1695 | "CompatibleRuntimes":{
|
1696 | 1696 | "shape":"NonEmptyStringList",
|
1697 |
| - "documentation":"<p>The layer's compatible runtimes. Maximum number of 5 items.</p> <p>Valid values: <code>nodejs8.10</code> | <code>nodejs10.x</code> | <code>nodejs12.x</code> | <code>java8</code> | <code>java11</code> | <code>python2.7</code> | <code>python3.6</code> | <code>python3.7</code> | <code>python3.8</code> | <code>dotnetcore1.0</code> | <code>dotnetcore2.1</code> | <code>go1.x</code> | <code>ruby2.5</code> | <code>provided</code> </p>" |
| 1697 | + "documentation":"<p>The layer's compatible runtimes. Maximum number of 5 items.</p> <p>Valid values: <code>nodejs10.x</code> | <code>nodejs12.x</code> | <code>java8</code> | <code>java11</code> | <code>python2.7</code> | <code>python3.6</code> | <code>python3.7</code> | <code>python3.8</code> | <code>dotnetcore1.0</code> | <code>dotnetcore2.1</code> | <code>go1.x</code> | <code>ruby2.5</code> | <code>provided</code> </p>" |
1698 | 1698 | },
|
1699 | 1699 | "CreatedDate":{
|
1700 | 1700 | "shape":"NonEmptyString",
|
|
1973 | 1973 | },
|
1974 | 1974 | "Compliance":{
|
1975 | 1975 | "shape":"Compliance",
|
1976 |
| - "documentation":"<p>This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS AWS Foundations. Contains compliance-related finding details.</p>" |
| 1976 | + "documentation":"<p>This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS AWS Foundations. Contains security standard-related finding details.</p>" |
1977 | 1977 | },
|
1978 | 1978 | "VerificationState":{
|
1979 | 1979 | "shape":"VerificationState",
|
|
1996 | 1996 | "documentation":"<p>A user-defined note added to a finding.</p>"
|
1997 | 1997 | }
|
1998 | 1998 | },
|
1999 |
| - "documentation":"<p>Provides consistent format for the contents of the Security Hub-aggregated findings. <code>AwsSecurityFinding</code> format enables you to share findings between AWS security services and third-party solutions, and compliance checks.</p> <note> <p>A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and compliance checks.</p> </note>" |
| 1999 | + "documentation":"<p>Provides consistent format for the contents of the Security Hub-aggregated findings. <code>AwsSecurityFinding</code> format enables you to share findings between AWS security services and third-party solutions, and security standards checks.</p> <note> <p>A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and standards checks.</p> </note>" |
2000 | 2000 | },
|
2001 | 2001 | "AwsSecurityFindingFilters":{
|
2002 | 2002 | "type":"structure",
|
|
2295 | 2295 | },
|
2296 | 2296 | "ComplianceStatus":{
|
2297 | 2297 | "shape":"StringFilterList",
|
2298 |
| - "documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS AWS Foundations. Contains compliance-related finding details.</p>" |
| 2298 | + "documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS AWS Foundations. Contains security standard-related finding details.</p>" |
2299 | 2299 | },
|
2300 | 2300 | "VerificationState":{
|
2301 | 2301 | "shape":"StringFilterList",
|
|
2483 | 2483 | "members":{
|
2484 | 2484 | "StandardsSubscriptionRequests":{
|
2485 | 2485 | "shape":"StandardsSubscriptionRequests",
|
2486 |
| - "documentation":"<p>The list of standards compliance checks to enable.</p>" |
| 2486 | + "documentation":"<p>The list of standards checks to enable.</p>" |
2487 | 2487 | }
|
2488 | 2488 | }
|
2489 | 2489 | },
|
|
2537 | 2537 | "members":{
|
2538 | 2538 | "Status":{
|
2539 | 2539 | "shape":"ComplianceStatus",
|
2540 |
| - "documentation":"<p>The result of a compliance check.</p>" |
| 2540 | + "documentation":"<p>The result of a standards check.</p>" |
2541 | 2541 | },
|
2542 | 2542 | "RelatedRequirements":{
|
2543 | 2543 | "shape":"RelatedRequirementsList",
|
2544 | 2544 | "documentation":"<p>List of requirements that are related to a standards control.</p>"
|
2545 | 2545 | }
|
2546 | 2546 | },
|
2547 |
| - "documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS AWS Foundations. Contains compliance-related finding details.</p> <p>Values include the following:</p> <ul> <li> <p>Allowed values are the following:</p> <ul> <li> <p> <code>PASSED</code> - Compliance check passed for all evaluated resources.</p> </li> <li> <p> <code>WARNING</code> - Some information is missing or this check is not supported given your configuration.</p> </li> <li> <p> <code>FAILED</code> - Compliance check failed for at least one evaluated resource.</p> </li> <li> <p> <code>NOT_AVAILABLE</code> - Check could not be performed due to a service outage, API error, or because the result of the AWS Config evaluation was <code>NOT_APPLICABLE</code>. If the AWS Config evaluation result was <code> NOT_APPLICABLE</code>, then after 3 days, Security Hub automatically archives the finding.</p> </li> </ul> </li> </ul>" |
| 2547 | + "documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS AWS Foundations. Contains security standard-related finding details.</p> <p>Values include the following:</p> <ul> <li> <p>Allowed values are the following:</p> <ul> <li> <p> <code>PASSED</code> - Standards check passed for all evaluated resources.</p> </li> <li> <p> <code>WARNING</code> - Some information is missing or this check is not supported given your configuration.</p> </li> <li> <p> <code>FAILED</code> - Standards check failed for at least one evaluated resource.</p> </li> <li> <p> <code>NOT_AVAILABLE</code> - Check could not be performed due to a service outage, API error, or because the result of the AWS Config evaluation was <code>NOT_APPLICABLE</code>. If the AWS Config evaluation result was <code> NOT_APPLICABLE</code>, then after 3 days, Security Hub automatically archives the finding.</p> </li> </ul> </li> </ul>" |
2548 | 2548 | },
|
2549 | 2549 | "ComplianceStatus":{
|
2550 | 2550 | "type":"string",
|
|
2910 | 2910 | },
|
2911 | 2911 | "MaxResults":{
|
2912 | 2912 | "shape":"MaxResults",
|
2913 |
| - "documentation":"<p>The maximum number of compliance standard controls to return.</p>", |
| 2913 | + "documentation":"<p>The maximum number of security standard controls to return.</p>", |
2914 | 2914 | "location":"querystring",
|
2915 | 2915 | "locationName":"MaxResults"
|
2916 | 2916 | }
|
|
2921 | 2921 | "members":{
|
2922 | 2922 | "Controls":{
|
2923 | 2923 | "shape":"StandardsControls",
|
2924 |
| - "documentation":"<p>A list of compliance standards controls.</p>" |
| 2924 | + "documentation":"<p>A list of security standards controls.</p>" |
2925 | 2925 | },
|
2926 | 2926 | "NextToken":{
|
2927 | 2927 | "shape":"NextToken",
|
|
3323 | 3323 | "documentation":"<p>The insight results returned by the <code>GetInsightResults</code> operation.</p>"
|
3324 | 3324 | },
|
3325 | 3325 | "Integer":{"type":"integer"},
|
| 3326 | + "IntegrationType":{ |
| 3327 | + "type":"string", |
| 3328 | + "enum":[ |
| 3329 | + "SEND_FINDINGS_TO_SECURITY_HUB", |
| 3330 | + "RECEIVE_FINDINGS_FROM_SECURITY_HUB" |
| 3331 | + ] |
| 3332 | + }, |
| 3333 | + "IntegrationTypeList":{ |
| 3334 | + "type":"list", |
| 3335 | + "member":{"shape":"IntegrationType"} |
| 3336 | + }, |
3326 | 3337 | "InternalException":{
|
3327 | 3338 | "type":"structure",
|
3328 | 3339 | "members":{
|
|
3877 | 3888 | "shape":"CategoryList",
|
3878 | 3889 | "documentation":"<p>The categories assigned to the product.</p>"
|
3879 | 3890 | },
|
| 3891 | + "IntegrationTypes":{ |
| 3892 | + "shape":"IntegrationTypeList", |
| 3893 | + "documentation":"<p>The types of integration that the product supports. Available values are the following.</p> <ul> <li> <p> <code>SEND_FINDINGS_TO_SECURITY_HUB</code> - Indicates that the integration sends findings to Security Hub.</p> </li> <li> <p> <code>RECEIVE_FINDINGS_FROM_SECURITY_HUB</code> - Indicates that the integration receives findings from Security Hub.</p> </li> </ul>" |
| 3894 | + }, |
3880 | 3895 | "MarketplaceUrl":{
|
3881 | 3896 | "shape":"NonEmptyString",
|
3882 | 3897 | "documentation":"<p>The URL for the page that contains more information about the product.</p>"
|
|
4199 | 4214 | "members":{
|
4200 | 4215 | "StandardsControlArn":{
|
4201 | 4216 | "shape":"NonEmptyString",
|
4202 |
| - "documentation":"<p>The ARN of the compliance standard control.</p>" |
| 4217 | + "documentation":"<p>The ARN of the security standard control.</p>" |
4203 | 4218 | },
|
4204 | 4219 | "ControlStatus":{
|
4205 | 4220 | "shape":"ControlStatus",
|
4206 |
| - "documentation":"<p>The current status of the compliance standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.</p>" |
| 4221 | + "documentation":"<p>The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.</p>" |
4207 | 4222 | },
|
4208 | 4223 | "DisabledReason":{
|
4209 | 4224 | "shape":"NonEmptyString",
|
4210 | 4225 | "documentation":"<p>The reason provided for the most recent change in status for the control.</p>"
|
4211 | 4226 | },
|
4212 | 4227 | "ControlStatusUpdatedAt":{
|
4213 | 4228 | "shape":"Timestamp",
|
4214 |
| - "documentation":"<p>The date and time that the status of the compliance standard control was most recently updated.</p>" |
| 4229 | + "documentation":"<p>The date and time that the status of the security standard control was most recently updated.</p>" |
4215 | 4230 | },
|
4216 | 4231 | "ControlId":{
|
4217 | 4232 | "shape":"NonEmptyString",
|
4218 |
| - "documentation":"<p>The identifier of the compliance standard control.</p>" |
| 4233 | + "documentation":"<p>The identifier of the security standard control.</p>" |
4219 | 4234 | },
|
4220 | 4235 | "Title":{
|
4221 | 4236 | "shape":"NonEmptyString",
|
4222 |
| - "documentation":"<p>The title of the compliance standard control.</p>" |
| 4237 | + "documentation":"<p>The title of the security standard control.</p>" |
4223 | 4238 | },
|
4224 | 4239 | "Description":{
|
4225 | 4240 | "shape":"NonEmptyString",
|
4226 |
| - "documentation":"<p>The longer description of the compliance standard control. Provides information about what the control is checking for.</p>" |
| 4241 | + "documentation":"<p>The longer description of the security standard control. Provides information about what the control is checking for.</p>" |
4227 | 4242 | },
|
4228 | 4243 | "RemediationUrl":{
|
4229 | 4244 | "shape":"NonEmptyString",
|
4230 | 4245 | "documentation":"<p>A link to remediation information for the control in the Security Hub user documentation.</p>"
|
4231 | 4246 | },
|
4232 | 4247 | "SeverityRating":{
|
4233 | 4248 | "shape":"SeverityRating",
|
4234 |
| - "documentation":"<p>The severity of findings generated from this compliance standard control.</p> <p>The finding severity is based on an assessment of how easy it would be to compromise AWS resources if the compliance issue is detected.</p>" |
| 4249 | + "documentation":"<p>The severity of findings generated from this security standard control.</p> <p>The finding severity is based on an assessment of how easy it would be to compromise AWS resources if the issue is detected.</p>" |
4235 | 4250 | },
|
4236 | 4251 | "RelatedRequirements":{
|
4237 | 4252 | "shape":"RelatedRequirementsList",
|
4238 | 4253 | "documentation":"<p>The list of requirements that are related to this control.</p>"
|
4239 | 4254 | }
|
4240 | 4255 | },
|
4241 |
| - "documentation":"<p>Details for an individual compliance standard control.</p>" |
| 4256 | + "documentation":"<p>Details for an individual security standard control.</p>" |
4242 | 4257 | },
|
4243 | 4258 | "StandardsControls":{
|
4244 | 4259 | "type":"list",
|
|
4572 | 4587 | "members":{
|
4573 | 4588 | "StandardsControlArn":{
|
4574 | 4589 | "shape":"NonEmptyString",
|
4575 |
| - "documentation":"<p>The ARN of the compliance standard control to enable or disable.</p>", |
| 4590 | + "documentation":"<p>The ARN of the security standard control to enable or disable.</p>", |
4576 | 4591 | "location":"uri",
|
4577 | 4592 | "locationName":"StandardsControlArn"
|
4578 | 4593 | },
|
4579 | 4594 | "ControlStatus":{
|
4580 | 4595 | "shape":"ControlStatus",
|
4581 |
| - "documentation":"<p>The updated status of the compliance standard control.</p>" |
| 4596 | + "documentation":"<p>The updated status of the security standard control.</p>" |
4582 | 4597 | },
|
4583 | 4598 | "DisabledReason":{
|
4584 | 4599 | "shape":"NonEmptyString",
|
4585 |
| - "documentation":"<p>A description of the reason why you are disabling a compliance standard control.</p>" |
| 4600 | + "documentation":"<p>A description of the reason why you are disabling a security standard control.</p>" |
4586 | 4601 | }
|
4587 | 4602 | }
|
4588 | 4603 | },
|
|
4645 | 4660 | ]
|
4646 | 4661 | }
|
4647 | 4662 | },
|
4648 |
| - "documentation":"<p>Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the compliance status of your environment based on controls from supported standards. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the <i> <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html\">AWS Security Hub User Guide</a> </i>.</p> <p>When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to.</p> <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code> <a>CreateMembers</a> </code> to add a member account to Security Hub, the association of the member account with the master account is created only in the <code>us-west-2</code> Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.</p> <p>The following throttling limits apply to using Security Hub API operations.</p> <ul> <li> <p> <code> <a>GetFindings</a> </code> - <code>RateLimit</code> of 3 requests per second. <code>BurstLimit</code> of 6 requests per second.</p> </li> <li> <p> <code> <a>UpdateFindings</a> </code> - <code>RateLimit</code> of 1 request per second. <code>BurstLimit</code> of 5 requests per second.</p> </li> <li> <p>All other operations - <code>RateLimit</code> of 10 requests per second. <code>BurstLimit</code> of 30 requests per second.</p> </li> </ul>" |
| 4663 | + "documentation":"<p>Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the <i> <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html\">AWS Security Hub User Guide</a> </i>.</p> <p>When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to.</p> <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code> <a>CreateMembers</a> </code> to add a member account to Security Hub, the association of the member account with the master account is created only in the <code>us-west-2</code> Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.</p> <p>The following throttling limits apply to using Security Hub API operations.</p> <ul> <li> <p> <code> <a>GetFindings</a> </code> - <code>RateLimit</code> of 3 requests per second. <code>BurstLimit</code> of 6 requests per second.</p> </li> <li> <p> <code> <a>UpdateFindings</a> </code> - <code>RateLimit</code> of 1 request per second. <code>BurstLimit</code> of 5 requests per second.</p> </li> <li> <p>All other operations - <code>RateLimit</code> of 10 requests per second. <code>BurstLimit</code> of 30 requests per second.</p> </li> </ul>" |
4649 | 4664 | }
|
0 commit comments