# Actions
The following actions are supported:
+ [AcceptAdministratorInvitation](API_AcceptAdministratorInvitation.md)
+ [AcceptInvitation](API_AcceptInvitation.md)
+ [BatchDeleteAutomationRules](API_BatchDeleteAutomationRules.md)
+ [BatchDisableStandards](API_BatchDisableStandards.md)
+ [BatchEnableStandards](API_BatchEnableStandards.md)
+ [BatchGetAutomationRules](API_BatchGetAutomationRules.md)
+ [BatchGetConfigurationPolicyAssociations](API_BatchGetConfigurationPolicyAssociations.md)
+ [BatchGetSecurityControls](API_BatchGetSecurityControls.md)
+ [BatchGetStandardsControlAssociations](API_BatchGetStandardsControlAssociations.md)
+ [BatchImportFindings](API_BatchImportFindings.md)
+ [BatchUpdateAutomationRules](API_BatchUpdateAutomationRules.md)
+ [BatchUpdateFindings](API_BatchUpdateFindings.md)
+ [BatchUpdateFindingsV2](API_BatchUpdateFindingsV2.md)
+ [BatchUpdateStandardsControlAssociations](API_BatchUpdateStandardsControlAssociations.md)
+ [CreateActionTarget](API_CreateActionTarget.md)
+ [CreateAggregatorV2](API_CreateAggregatorV2.md)
+ [CreateAutomationRule](API_CreateAutomationRule.md)
+ [CreateAutomationRuleV2](API_CreateAutomationRuleV2.md)
+ [CreateConfigurationPolicy](API_CreateConfigurationPolicy.md)
+ [CreateConnectorV2](API_CreateConnectorV2.md)
+ [CreateFindingAggregator](API_CreateFindingAggregator.md)
+ [CreateInsight](API_CreateInsight.md)
+ [CreateMembers](API_CreateMembers.md)
+ [CreateTicketV2](API_CreateTicketV2.md)
+ [DeclineInvitations](API_DeclineInvitations.md)
+ [DeleteActionTarget](API_DeleteActionTarget.md)
+ [DeleteAggregatorV2](API_DeleteAggregatorV2.md)
+ [DeleteAutomationRuleV2](API_DeleteAutomationRuleV2.md)
+ [DeleteConfigurationPolicy](API_DeleteConfigurationPolicy.md)
+ [DeleteConnectorV2](API_DeleteConnectorV2.md)
+ [DeleteFindingAggregator](API_DeleteFindingAggregator.md)
+ [DeleteInsight](API_DeleteInsight.md)
+ [DeleteInvitations](API_DeleteInvitations.md)
+ [DeleteMembers](API_DeleteMembers.md)
+ [DescribeActionTargets](API_DescribeActionTargets.md)
+ [DescribeHub](API_DescribeHub.md)
+ [DescribeOrganizationConfiguration](API_DescribeOrganizationConfiguration.md)
+ [DescribeProducts](API_DescribeProducts.md)
+ [DescribeProductsV2](API_DescribeProductsV2.md)
+ [DescribeSecurityHubV2](API_DescribeSecurityHubV2.md)
+ [DescribeStandards](API_DescribeStandards.md)
+ [DescribeStandardsControls](API_DescribeStandardsControls.md)
+ [DisableImportFindingsForProduct](API_DisableImportFindingsForProduct.md)
+ [DisableOrganizationAdminAccount](API_DisableOrganizationAdminAccount.md)
+ [DisableSecurityHub](API_DisableSecurityHub.md)
+ [DisableSecurityHubV2](API_DisableSecurityHubV2.md)
+ [DisassociateFromAdministratorAccount](API_DisassociateFromAdministratorAccount.md)
+ [DisassociateFromMasterAccount](API_DisassociateFromMasterAccount.md)
+ [DisassociateMembers](API_DisassociateMembers.md)
+ [EnableImportFindingsForProduct](API_EnableImportFindingsForProduct.md)
+ [EnableOrganizationAdminAccount](API_EnableOrganizationAdminAccount.md)
+ [EnableSecurityHub](API_EnableSecurityHub.md)
+ [EnableSecurityHubV2](API_EnableSecurityHubV2.md)
+ [GetAdministratorAccount](API_GetAdministratorAccount.md)
+ [GetAggregatorV2](API_GetAggregatorV2.md)
+ [GetAutomationRuleV2](API_GetAutomationRuleV2.md)
+ [GetConfigurationPolicy](API_GetConfigurationPolicy.md)
+ [GetConfigurationPolicyAssociation](API_GetConfigurationPolicyAssociation.md)
+ [GetConnectorV2](API_GetConnectorV2.md)
+ [GetEnabledStandards](API_GetEnabledStandards.md)
+ [GetFindingAggregator](API_GetFindingAggregator.md)
+ [GetFindingHistory](API_GetFindingHistory.md)
+ [GetFindings](API_GetFindings.md)
+ [GetFindingStatisticsV2](API_GetFindingStatisticsV2.md)
+ [GetFindingsTrendsV2](API_GetFindingsTrendsV2.md)
+ [GetFindingsV2](API_GetFindingsV2.md)
+ [GetInsightResults](API_GetInsightResults.md)
+ [GetInsights](API_GetInsights.md)
+ [GetInvitationsCount](API_GetInvitationsCount.md)
+ [GetMasterAccount](API_GetMasterAccount.md)
+ [GetMembers](API_GetMembers.md)
+ [GetResourcesStatisticsV2](API_GetResourcesStatisticsV2.md)
+ [GetResourcesTrendsV2](API_GetResourcesTrendsV2.md)
+ [GetResourcesV2](API_GetResourcesV2.md)
+ [GetSecurityControlDefinition](API_GetSecurityControlDefinition.md)
+ [InviteMembers](API_InviteMembers.md)
+ [ListAggregatorsV2](API_ListAggregatorsV2.md)
+ [ListAutomationRules](API_ListAutomationRules.md)
+ [ListAutomationRulesV2](API_ListAutomationRulesV2.md)
+ [ListConfigurationPolicies](API_ListConfigurationPolicies.md)
+ [ListConfigurationPolicyAssociations](API_ListConfigurationPolicyAssociations.md)
+ [ListConnectorsV2](API_ListConnectorsV2.md)
+ [ListEnabledProductsForImport](API_ListEnabledProductsForImport.md)
+ [ListFindingAggregators](API_ListFindingAggregators.md)
+ [ListInvitations](API_ListInvitations.md)
+ [ListMembers](API_ListMembers.md)
+ [ListOrganizationAdminAccounts](API_ListOrganizationAdminAccounts.md)
+ [ListSecurityControlDefinitions](API_ListSecurityControlDefinitions.md)
+ [ListStandardsControlAssociations](API_ListStandardsControlAssociations.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [RegisterConnectorV2](API_RegisterConnectorV2.md)
+ [StartConfigurationPolicyAssociation](API_StartConfigurationPolicyAssociation.md)
+ [StartConfigurationPolicyDisassociation](API_StartConfigurationPolicyDisassociation.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateActionTarget](API_UpdateActionTarget.md)
+ [UpdateAggregatorV2](API_UpdateAggregatorV2.md)
+ [UpdateAutomationRuleV2](API_UpdateAutomationRuleV2.md)
+ [UpdateConfigurationPolicy](API_UpdateConfigurationPolicy.md)
+ [UpdateConnectorV2](API_UpdateConnectorV2.md)
+ [UpdateFindingAggregator](API_UpdateFindingAggregator.md)
+ [UpdateFindings](API_UpdateFindings.md)
+ [UpdateInsight](API_UpdateInsight.md)
+ [UpdateOrganizationConfiguration](API_UpdateOrganizationConfiguration.md)
+ [UpdateSecurityControl](API_UpdateSecurityControl.md)
+ [UpdateSecurityHubConfiguration](API_UpdateSecurityHubConfiguration.md)
+ [UpdateStandardsControl](API_UpdateStandardsControl.md)
# AcceptAdministratorInvitation
**Note**
We recommend using AWS Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see [Managing Security Hub CSPM administrator and member accounts with Organizations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html) in the * AWS Security Hub CSPM User Guide*.
Accepts the invitation to be a member account and be monitored by the Security Hub CSPM administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
## Request Syntax
```
POST /administrator HTTP/1.1
Content-type: application/json
{
"AdministratorId": "string",
"InvitationId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AdministratorId](#API_AcceptAdministratorInvitation_RequestSyntax) **
The account ID of the Security Hub CSPM administrator account that sent the invitation.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [InvitationId](#API_AcceptAdministratorInvitation_RequestSyntax) **
The identifier of the invitation sent from the Security Hub CSPM administrator account.
Type: String
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/AcceptAdministratorInvitation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/AcceptAdministratorInvitation)
# AcceptInvitation
This method is deprecated. Instead, use `AcceptAdministratorInvitation`.
The Security Hub CSPM console continues to use `AcceptInvitation`. It will eventually change to use `AcceptAdministratorInvitation`. Any IAM policies that specifically control access to this function must continue to use `AcceptInvitation`. You should also add `AcceptAdministratorInvitation` to your policies to ensure that the correct permissions are in place after the console begins to use `AcceptAdministratorInvitation`.
Accepts the invitation to be a member account and be monitored by the Security Hub CSPM administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
## Request Syntax
```
POST /master HTTP/1.1
Content-type: application/json
{
"InvitationId": "string",
"MasterId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [InvitationId](#API_AcceptInvitation_RequestSyntax) **
The identifier of the invitation sent from the Security Hub CSPM administrator account.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [MasterId](#API_AcceptInvitation_RequestSyntax) **
The account ID of the Security Hub CSPM administrator account that sent the invitation.
Type: String
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/AcceptInvitation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/AcceptInvitation)
# BatchDeleteAutomationRules
Deletes one or more automation rules.
## Request Syntax
```
POST /automationrules/delete HTTP/1.1
Content-type: application/json
{
"AutomationRulesArns": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AutomationRulesArns](#API_BatchDeleteAutomationRules_RequestSyntax) **
A list of Amazon Resource Names (ARNs) for the rules that are to be deleted.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ProcessedAutomationRules": [ "string" ],
"UnprocessedAutomationRules": [
{
"ErrorCode": number,
"ErrorMessage": "string",
"RuleArn": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ProcessedAutomationRules](#API_BatchDeleteAutomationRules_ResponseSyntax) **
A list of properly processed rule ARNs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern: `.*\S.*`
** [UnprocessedAutomationRules](#API_BatchDeleteAutomationRules_ResponseSyntax) **
A list of objects containing `RuleArn`, `ErrorCode`, and `ErrorMessage`. This parameter tells you which automation rules the request didn't delete and why.
Type: Array of [UnprocessedAutomationRule](API_UnprocessedAutomationRule.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchDeleteAutomationRules)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchDeleteAutomationRules)
# BatchDisableStandards
Disables the standards specified by the provided `StandardsSubscriptionArns`.
For more information, see [Security Standards](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) section of the * AWS Security Hub CSPM User Guide*.
## Request Syntax
```
POST /standards/deregister HTTP/1.1
Content-type: application/json
{
"StandardsSubscriptionArns": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [StandardsSubscriptionArns](#API_BatchDisableStandards_RequestSyntax) **
The ARNs of the standards subscriptions to disable.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"StandardsSubscriptions": [
{
"StandardsArn": "string",
"StandardsControlsUpdatable": "string",
"StandardsInput": {
"string" : "string"
},
"StandardsStatus": "string",
"StandardsStatusReason": {
"StatusReasonCode": "string"
},
"StandardsSubscriptionArn": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [StandardsSubscriptions](#API_BatchDisableStandards_ResponseSyntax) **
The details of the standards subscriptions that were disabled.
Type: Array of [StandardsSubscription](API_StandardsSubscription.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchDisableStandards)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchDisableStandards)
# BatchEnableStandards
Enables the standards specified by the provided `StandardsArn`. To obtain the ARN for a standard, use the `DescribeStandards` operation.
For more information, see the [Security Standards](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) section of the * AWS Security Hub CSPM User Guide*.
## Request Syntax
```
POST /standards/register HTTP/1.1
Content-type: application/json
{
"StandardsSubscriptionRequests": [
{
"StandardsArn": "string",
"StandardsInput": {
"string" : "string"
}
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [StandardsSubscriptionRequests](#API_BatchEnableStandards_RequestSyntax) **
The list of standards checks to enable.
Type: Array of [StandardsSubscriptionRequest](API_StandardsSubscriptionRequest.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"StandardsSubscriptions": [
{
"StandardsArn": "string",
"StandardsControlsUpdatable": "string",
"StandardsInput": {
"string" : "string"
},
"StandardsStatus": "string",
"StandardsStatusReason": {
"StatusReasonCode": "string"
},
"StandardsSubscriptionArn": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [StandardsSubscriptions](#API_BatchEnableStandards_ResponseSyntax) **
The details of the standards subscriptions that were enabled.
Type: Array of [StandardsSubscription](API_StandardsSubscription.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchEnableStandards)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchEnableStandards)
# BatchGetAutomationRules
Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
## Request Syntax
```
POST /automationrules/get HTTP/1.1
Content-type: application/json
{
"AutomationRulesArns": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AutomationRulesArns](#API_BatchGetAutomationRules_RequestSyntax) **
A list of rule ARNs to get details for.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Rules": [
{
"Actions": [
{
"FindingFieldsUpdate": {
"Confidence": number,
"Criticality": number,
"Note": {
"Text": "string",
"UpdatedBy": "string"
},
"RelatedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Severity": {
"Label": "string",
"Normalized": number,
"Product": number
},
"Types": [ "string" ],
"UserDefinedFields": {
"string" : "string"
},
"VerificationState": "string",
"Workflow": {
"Status": "string"
}
},
"Type": "string"
}
],
"CreatedAt": "string",
"CreatedBy": "string",
"Criteria": {
"AwsAccountId": [
{
"Comparison": "string",
"Value": "string"
}
],
"AwsAccountName": [
{
"Comparison": "string",
"Value": "string"
}
],
"CompanyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceAssociatedStandardsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"Confidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"CreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"Criticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"Description": [
{
"Comparison": "string",
"Value": "string"
}
],
"FirstObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"GeneratorId": [
{
"Comparison": "string",
"Value": "string"
}
],
"Id": [
{
"Comparison": "string",
"Value": "string"
}
],
"LastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteText": [
{
"Comparison": "string",
"Value": "string"
}
],
"NoteUpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteUpdatedBy": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductName": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecordState": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceDetailsOther": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourcePartition": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceRegion": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceTags": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"SeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"SourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"Title": [
{
"Comparison": "string",
"Value": "string"
}
],
"Type": [
{
"Comparison": "string",
"Value": "string"
}
],
"UpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"UserDefinedFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"VerificationState": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowStatus": [
{
"Comparison": "string",
"Value": "string"
}
]
},
"Description": "string",
"IsTerminal": boolean,
"RuleArn": "string",
"RuleName": "string",
"RuleOrder": number,
"RuleStatus": "string",
"UpdatedAt": "string"
}
],
"UnprocessedAutomationRules": [
{
"ErrorCode": number,
"ErrorMessage": "string",
"RuleArn": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Rules](#API_BatchGetAutomationRules_ResponseSyntax) **
A list of rule details for the provided rule ARNs.
Type: Array of [AutomationRulesConfig](API_AutomationRulesConfig.md) objects
** [UnprocessedAutomationRules](#API_BatchGetAutomationRules_ResponseSyntax) **
A list of objects containing `RuleArn`, `ErrorCode`, and `ErrorMessage`. This parameter tells you which automation rules the request didn't retrieve and why.
Type: Array of [UnprocessedAutomationRule](API_UnprocessedAutomationRule.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchGetAutomationRules)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchGetAutomationRules)
# BatchGetConfigurationPolicyAssociations
Returns associations between an AWS Security Hub CSPM configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub CSPM delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.
## Request Syntax
```
POST /configurationPolicyAssociation/batchget HTTP/1.1
Content-type: application/json
{
"ConfigurationPolicyAssociationIdentifiers": [
{
"Target": { ... }
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ConfigurationPolicyAssociationIdentifiers](#API_BatchGetConfigurationPolicyAssociations_RequestSyntax) **
Specifies one or more target account IDs, organizational unit (OU) IDs, or the root ID to retrieve associations for.
Type: Array of [ConfigurationPolicyAssociation](API_ConfigurationPolicyAssociation.md) objects
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ConfigurationPolicyAssociations": [
{
"AssociationStatus": "string",
"AssociationStatusMessage": "string",
"AssociationType": "string",
"ConfigurationPolicyId": "string",
"TargetId": "string",
"TargetType": "string",
"UpdatedAt": "string"
}
],
"UnprocessedConfigurationPolicyAssociations": [
{
"ConfigurationPolicyAssociationIdentifiers": {
"Target": { ... }
},
"ErrorCode": "string",
"ErrorReason": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConfigurationPolicyAssociations](#API_BatchGetConfigurationPolicyAssociations_ResponseSyntax) **
Describes associations for the target accounts, OUs, or the root.
Type: Array of [ConfigurationPolicyAssociationSummary](API_ConfigurationPolicyAssociationSummary.md) objects
** [UnprocessedConfigurationPolicyAssociations](#API_BatchGetConfigurationPolicyAssociations_ResponseSyntax) **
An array of configuration policy associations, one for each configuration policy association identifier, that was specified in the request but couldn’t be processed due to an error.
Type: Array of [UnprocessedConfigurationPolicyAssociation](API_UnprocessedConfigurationPolicyAssociation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchGetConfigurationPolicyAssociations)
# BatchGetSecurityControls
Provides details about a batch of security controls for the current AWS account and AWS Region.
## Request Syntax
```
POST /securityControls/batchGet HTTP/1.1
Content-type: application/json
{
"SecurityControlIds": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [SecurityControlIds](#API_BatchGetSecurityControls_RequestSyntax) **
A list of security controls (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters). The security control ID or Amazon Resource Name (ARN) is the same across standards.
Type: Array of strings
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"SecurityControls": [
{
"Description": "string",
"LastUpdateReason": "string",
"Parameters": {
"string" : {
"Value": { ... },
"ValueType": "string"
}
},
"RemediationUrl": "string",
"SecurityControlArn": "string",
"SecurityControlId": "string",
"SecurityControlStatus": "string",
"SeverityRating": "string",
"Title": "string",
"UpdateStatus": "string"
}
],
"UnprocessedIds": [
{
"ErrorCode": "string",
"ErrorReason": "string",
"SecurityControlId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [SecurityControls](#API_BatchGetSecurityControls_ResponseSyntax) **
An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control. The same information is returned whether the request includes `SecurityControlId` or `SecurityControlArn`.
Type: Array of [SecurityControl](API_SecurityControl.md) objects
** [UnprocessedIds](#API_BatchGetSecurityControls_ResponseSyntax) **
A security control (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters) for which details cannot be returned.
Type: Array of [UnprocessedSecurityControl](API_UnprocessedSecurityControl.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchGetSecurityControls)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchGetSecurityControls)
# BatchGetStandardsControlAssociations
For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
Calls to this operation return a `RESOURCE_NOT_FOUND_EXCEPTION` error when the standard subscription for the association has a `NOT_READY_FOR_UPDATES` value for `StandardsControlsUpdatable`.
## Request Syntax
```
POST /associations/batchGet HTTP/1.1
Content-type: application/json
{
"StandardsControlAssociationIds": [
{
"SecurityControlId": "string",
"StandardsArn": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [StandardsControlAssociationIds](#API_BatchGetStandardsControlAssociations_RequestSyntax) **
An array with one or more objects that includes a security control (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard. This field is used to query the enablement status of a control in a specified standard. The security control ID or ARN is the same across standards.
Type: Array of [StandardsControlAssociationId](API_StandardsControlAssociationId.md) objects
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"StandardsControlAssociationDetails": [
{
"AssociationStatus": "string",
"RelatedRequirements": [ "string" ],
"SecurityControlArn": "string",
"SecurityControlId": "string",
"StandardsArn": "string",
"StandardsControlArns": [ "string" ],
"StandardsControlDescription": "string",
"StandardsControlTitle": "string",
"UpdatedAt": "string",
"UpdatedReason": "string"
}
],
"UnprocessedAssociations": [
{
"ErrorCode": "string",
"ErrorReason": "string",
"StandardsControlAssociationId": {
"SecurityControlId": "string",
"StandardsArn": "string"
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [StandardsControlAssociationDetails](#API_BatchGetStandardsControlAssociations_ResponseSyntax) **
Provides the enablement status of a security control in a specified standard and other details for the control in relation to the specified standard.
Type: Array of [StandardsControlAssociationDetail](API_StandardsControlAssociationDetail.md) objects
** [UnprocessedAssociations](#API_BatchGetStandardsControlAssociations_ResponseSyntax) **
A security control (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters) whose enablement status in a specified standard cannot be returned.
Type: Array of [UnprocessedStandardsControlAssociation](API_UnprocessedStandardsControlAssociation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchGetStandardsControlAssociations)
# BatchImportFindings
Imports security findings generated by a finding provider into Security Hub CSPM. This action is requested by the finding provider to import its findings into Security Hub CSPM.
`BatchImportFindings` must be called by one of the following:
+ The AWS account that is associated with a finding if you are using the [default product ARN](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-custom-providers.html#securityhub-custom-providers-bfi-reqs) or are a partner sending findings from within a customer's AWS account. In these cases, the identifier of the account that you are calling `BatchImportFindings` from needs to be the same as the `AwsAccountId` attribute for the finding.
+ An AWS account that Security Hub CSPM has allow-listed for an official partner integration. In this case, you can call `BatchImportFindings` from the allow-listed account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created, `BatchImportFindings` cannot be used to update the following finding fields and objects, which Security Hub CSPM customers use to manage their investigation workflow.
+ `Note`
+ `UserDefinedFields`
+ `VerificationState`
+ `Workflow`
Finding providers also should not use `BatchImportFindings` to update the following attributes.
+ `Confidence`
+ `Criticality`
+ `RelatedFindings`
+ `Severity`
+ `Types`
Instead, finding providers use `FindingProviderFields` to provide values for these attributes.
## Request Syntax
```
POST /findings/import HTTP/1.1
Content-type: application/json
{
"Findings": [
{
"Action": {
"ActionType": "string",
"AwsApiCallAction": {
"AffectedResources": {
"string" : "string"
},
"Api": "string",
"CallerType": "string",
"DomainDetails": {
"Domain": "string"
},
"FirstSeen": "string",
"LastSeen": "string",
"RemoteIpDetails": {
"City": {
"CityName": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"GeoLocation": {
"Lat": number,
"Lon": number
},
"IpAddressV4": "string",
"Organization": {
"Asn": number,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
}
},
"ServiceName": "string"
},
"DnsRequestAction": {
"Blocked": boolean,
"Domain": "string",
"Protocol": "string"
},
"NetworkConnectionAction": {
"Blocked": boolean,
"ConnectionDirection": "string",
"LocalPortDetails": {
"Port": number,
"PortName": "string"
},
"Protocol": "string",
"RemoteIpDetails": {
"City": {
"CityName": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"GeoLocation": {
"Lat": number,
"Lon": number
},
"IpAddressV4": "string",
"Organization": {
"Asn": number,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
}
},
"RemotePortDetails": {
"Port": number,
"PortName": "string"
}
},
"PortProbeAction": {
"Blocked": boolean,
"PortProbeDetails": [
{
"LocalIpDetails": {
"IpAddressV4": "string"
},
"LocalPortDetails": {
"Port": number,
"PortName": "string"
},
"RemoteIpDetails": {
"City": {
"CityName": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"GeoLocation": {
"Lat": number,
"Lon": number
},
"IpAddressV4": "string",
"Organization": {
"Asn": number,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
}
}
}
]
}
},
"AwsAccountId": "string",
"AwsAccountName": "string",
"CompanyName": "string",
"Compliance": {
"AssociatedStandards": [
{
"StandardsId": "string"
}
],
"RelatedRequirements": [ "string" ],
"SecurityControlId": "string",
"SecurityControlParameters": [
{
"Name": "string",
"Value": [ "string" ]
}
],
"Status": "string",
"StatusReasons": [
{
"Description": "string",
"ReasonCode": "string"
}
]
},
"Confidence": number,
"CreatedAt": "string",
"Criticality": number,
"Description": "string",
"Detection": {
"Sequence": {
"Actors": [
{
"Id": "string",
"Session": {
"CreatedTime": number,
"Issuer": "string",
"MfaStatus": "string",
"Uid": "string"
},
"User": {
"Account": {
"Name": "string",
"Uid": "string"
},
"CredentialUid": "string",
"Name": "string",
"Type": "string",
"Uid": "string"
}
}
],
"Endpoints": [
{
"AutonomousSystem": {
"Name": "string",
"Number": number
},
"Connection": {
"Direction": "string"
},
"Domain": "string",
"Id": "string",
"Ip": "string",
"Location": {
"City": "string",
"Country": "string",
"Lat": number,
"Lon": number
},
"Port": number
}
],
"SequenceIndicators": [
{
"Key": "string",
"Title": "string",
"Type": "string",
"Values": [ "string" ]
}
],
"Signals": [
{
"ActorIds": [ "string" ],
"Count": number,
"CreatedAt": number,
"EndpointIds": [ "string" ],
"FirstSeenAt": number,
"Id": "string",
"LastSeenAt": number,
"Name": "string",
"ProductArn": "string",
"ResourceIds": [ "string" ],
"Severity": number,
"SignalIndicators": [
{
"Key": "string",
"Title": "string",
"Type": "string",
"Values": [ "string" ]
}
],
"Title": "string",
"Type": "string",
"UpdatedAt": number
}
],
"Uid": "string"
}
},
"FindingProviderFields": {
"Confidence": number,
"Criticality": number,
"RelatedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Severity": {
"Label": "string",
"Original": "string"
},
"Types": [ "string" ]
},
"FirstObservedAt": "string",
"GeneratorDetails": {
"Description": "string",
"Labels": [ "string" ],
"Name": "string"
},
"GeneratorId": "string",
"Id": "string",
"LastObservedAt": "string",
"Malware": [
{
"Name": "string",
"Path": "string",
"State": "string",
"Type": "string"
}
],
"Network": {
"DestinationDomain": "string",
"DestinationIpV4": "string",
"DestinationIpV6": "string",
"DestinationPort": number,
"Direction": "string",
"OpenPortRange": {
"Begin": number,
"End": number
},
"Protocol": "string",
"SourceDomain": "string",
"SourceIpV4": "string",
"SourceIpV6": "string",
"SourceMac": "string",
"SourcePort": number
},
"NetworkPath": [
{
"ComponentId": "string",
"ComponentType": "string",
"Egress": {
"Destination": {
"Address": [ "string" ],
"PortRanges": [
{
"Begin": number,
"End": number
}
]
},
"Protocol": "string",
"Source": {
"Address": [ "string" ],
"PortRanges": [
{
"Begin": number,
"End": number
}
]
}
},
"Ingress": {
"Destination": {
"Address": [ "string" ],
"PortRanges": [
{
"Begin": number,
"End": number
}
]
},
"Protocol": "string",
"Source": {
"Address": [ "string" ],
"PortRanges": [
{
"Begin": number,
"End": number
}
]
}
}
}
],
"Note": {
"Text": "string",
"UpdatedAt": "string",
"UpdatedBy": "string"
},
"PatchSummary": {
"FailedCount": number,
"Id": "string",
"InstalledCount": number,
"InstalledOtherCount": number,
"InstalledPendingReboot": number,
"InstalledRejectedCount": number,
"MissingCount": number,
"Operation": "string",
"OperationEndTime": "string",
"OperationStartTime": "string",
"RebootOption": "string"
},
"Process": {
"LaunchedAt": "string",
"Name": "string",
"ParentPid": number,
"Path": "string",
"Pid": number,
"TerminatedAt": "string"
},
"ProcessedAt": "string",
"ProductArn": "string",
"ProductFields": {
"string" : "string"
},
"ProductName": "string",
"RecordState": "string",
"Region": "string",
"RelatedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Remediation": {
"Recommendation": {
"Text": "string",
"Url": "string"
}
},
"Resources": [
{
"ApplicationArn": "string",
"ApplicationName": "string",
"DataClassification": {
"DetailedResultsLocation": "string",
"Result": {
"AdditionalOccurrences": boolean,
"CustomDataIdentifiers": {
"Detections": [
{
"Arn": "string",
"Count": number,
"Name": "string",
"Occurrences": {
"Cells": [
{
"CellReference": "string",
"Column": number,
"ColumnName": "string",
"Row": number
}
],
"LineRanges": [
{
"End": number,
"Start": number,
"StartColumn": number
}
],
"OffsetRanges": [
{
"End": number,
"Start": number,
"StartColumn": number
}
],
"Pages": [
{
"LineRange": {
"End": number,
"Start": number,
"StartColumn": number
},
"OffsetRange": {
"End": number,
"Start": number,
"StartColumn": number
},
"PageNumber": number
}
],
"Records": [
{
"JsonPath": "string",
"RecordIndex": number
}
]
}
}
],
"TotalCount": number
},
"MimeType": "string",
"SensitiveData": [
{
"Category": "string",
"Detections": [
{
"Count": number,
"Occurrences": {
"Cells": [
{
"CellReference": "string",
"Column": number,
"ColumnName": "string",
"Row": number
}
],
"LineRanges": [
{
"End": number,
"Start": number,
"StartColumn": number
}
],
"OffsetRanges": [
{
"End": number,
"Start": number,
"StartColumn": number
}
],
"Pages": [
{
"LineRange": {
"End": number,
"Start": number,
"StartColumn": number
},
"OffsetRange": {
"End": number,
"Start": number,
"StartColumn": number
},
"PageNumber": number
}
],
"Records": [
{
"JsonPath": "string",
"RecordIndex": number
}
]
},
"Type": "string"
}
],
"TotalCount": number
}
],
"SizeClassified": number,
"Status": {
"Code": "string",
"Reason": "string"
}
}
},
"Details": {
"AwsAmazonMqBroker": {
"AuthenticationStrategy": "string",
"AutoMinorVersionUpgrade": boolean,
"BrokerArn": "string",
"BrokerId": "string",
"BrokerName": "string",
"DeploymentMode": "string",
"EncryptionOptions": {
"KmsKeyId": "string",
"UseAwsOwnedKey": boolean
},
"EngineType": "string",
"EngineVersion": "string",
"HostInstanceType": "string",
"LdapServerMetadata": {
"Hosts": [ "string" ],
"RoleBase": "string",
"RoleName": "string",
"RoleSearchMatching": "string",
"RoleSearchSubtree": boolean,
"ServiceAccountUsername": "string",
"UserBase": "string",
"UserRoleName": "string",
"UserSearchMatching": "string",
"UserSearchSubtree": boolean
},
"Logs": {
"Audit": boolean,
"AuditLogGroup": "string",
"General": boolean,
"GeneralLogGroup": "string",
"Pending": {
"Audit": boolean,
"General": boolean
}
},
"MaintenanceWindowStartTime": {
"DayOfWeek": "string",
"TimeOfDay": "string",
"TimeZone": "string"
},
"PubliclyAccessible": boolean,
"SecurityGroups": [ "string" ],
"StorageType": "string",
"SubnetIds": [ "string" ],
"Users": [
{
"PendingChange": "string",
"Username": "string"
}
]
},
"AwsApiGatewayRestApi": {
"ApiKeySource": "string",
"BinaryMediaTypes": [ "string" ],
"CreatedDate": "string",
"Description": "string",
"EndpointConfiguration": {
"Types": [ "string" ]
},
"Id": "string",
"MinimumCompressionSize": number,
"Name": "string",
"Version": "string"
},
"AwsApiGatewayStage": {
"AccessLogSettings": {
"DestinationArn": "string",
"Format": "string"
},
"CacheClusterEnabled": boolean,
"CacheClusterSize": "string",
"CacheClusterStatus": "string",
"CanarySettings": {
"DeploymentId": "string",
"PercentTraffic": number,
"StageVariableOverrides": {
"string" : "string"
},
"UseStageCache": boolean
},
"ClientCertificateId": "string",
"CreatedDate": "string",
"DeploymentId": "string",
"Description": "string",
"DocumentationVersion": "string",
"LastUpdatedDate": "string",
"MethodSettings": [
{
"CacheDataEncrypted": boolean,
"CacheTtlInSeconds": number,
"CachingEnabled": boolean,
"DataTraceEnabled": boolean,
"HttpMethod": "string",
"LoggingLevel": "string",
"MetricsEnabled": boolean,
"RequireAuthorizationForCacheControl": boolean,
"ResourcePath": "string",
"ThrottlingBurstLimit": number,
"ThrottlingRateLimit": number,
"UnauthorizedCacheControlHeaderStrategy": "string"
}
],
"StageName": "string",
"TracingEnabled": boolean,
"Variables": {
"string" : "string"
},
"WebAclArn": "string"
},
"AwsApiGatewayV2Api": {
"ApiEndpoint": "string",
"ApiId": "string",
"ApiKeySelectionExpression": "string",
"CorsConfiguration": {
"AllowCredentials": boolean,
"AllowHeaders": [ "string" ],
"AllowMethods": [ "string" ],
"AllowOrigins": [ "string" ],
"ExposeHeaders": [ "string" ],
"MaxAge": number
},
"CreatedDate": "string",
"Description": "string",
"Name": "string",
"ProtocolType": "string",
"RouteSelectionExpression": "string",
"Version": "string"
},
"AwsApiGatewayV2Stage": {
"AccessLogSettings": {
"DestinationArn": "string",
"Format": "string"
},
"ApiGatewayManaged": boolean,
"AutoDeploy": boolean,
"ClientCertificateId": "string",
"CreatedDate": "string",
"DefaultRouteSettings": {
"DataTraceEnabled": boolean,
"DetailedMetricsEnabled": boolean,
"LoggingLevel": "string",
"ThrottlingBurstLimit": number,
"ThrottlingRateLimit": number
},
"DeploymentId": "string",
"Description": "string",
"LastDeploymentStatusMessage": "string",
"LastUpdatedDate": "string",
"RouteSettings": {
"DataTraceEnabled": boolean,
"DetailedMetricsEnabled": boolean,
"LoggingLevel": "string",
"ThrottlingBurstLimit": number,
"ThrottlingRateLimit": number
},
"StageName": "string",
"StageVariables": {
"string" : "string"
}
},
"AwsAppSyncGraphQlApi": {
"AdditionalAuthenticationProviders": [
{
"AuthenticationType": "string",
"LambdaAuthorizerConfig": {
"AuthorizerResultTtlInSeconds": number,
"AuthorizerUri": "string",
"IdentityValidationExpression": "string"
},
"OpenIdConnectConfig": {
"AuthTtL": number,
"ClientId": "string",
"IatTtL": number,
"Issuer": "string"
},
"UserPoolConfig": {
"AppIdClientRegex": "string",
"AwsRegion": "string",
"DefaultAction": "string",
"UserPoolId": "string"
}
}
],
"ApiId": "string",
"Arn": "string",
"AuthenticationType": "string",
"Id": "string",
"LambdaAuthorizerConfig": {
"AuthorizerResultTtlInSeconds": number,
"AuthorizerUri": "string",
"IdentityValidationExpression": "string"
},
"LogConfig": {
"CloudWatchLogsRoleArn": "string",
"ExcludeVerboseContent": boolean,
"FieldLogLevel": "string"
},
"Name": "string",
"OpenIdConnectConfig": {
"AuthTtL": number,
"ClientId": "string",
"IatTtL": number,
"Issuer": "string"
},
"UserPoolConfig": {
"AppIdClientRegex": "string",
"AwsRegion": "string",
"DefaultAction": "string",
"UserPoolId": "string"
},
"WafWebAclArn": "string",
"XrayEnabled": boolean
},
"AwsAthenaWorkGroup": {
"Configuration": {
"ResultConfiguration": {
"EncryptionConfiguration": {
"EncryptionOption": "string",
"KmsKey": "string"
}
}
},
"Description": "string",
"Name": "string",
"State": "string"
},
"AwsAutoScalingAutoScalingGroup": {
"AvailabilityZones": [
{
"Value": "string"
}
],
"CapacityRebalance": boolean,
"CreatedTime": "string",
"HealthCheckGracePeriod": number,
"HealthCheckType": "string",
"LaunchConfigurationName": "string",
"LaunchTemplate": {
"LaunchTemplateId": "string",
"LaunchTemplateName": "string",
"Version": "string"
},
"LoadBalancerNames": [ "string" ],
"MixedInstancesPolicy": {
"InstancesDistribution": {
"OnDemandAllocationStrategy": "string",
"OnDemandBaseCapacity": number,
"OnDemandPercentageAboveBaseCapacity": number,
"SpotAllocationStrategy": "string",
"SpotInstancePools": number,
"SpotMaxPrice": "string"
},
"LaunchTemplate": {
"LaunchTemplateSpecification": {
"LaunchTemplateId": "string",
"LaunchTemplateName": "string",
"Version": "string"
},
"Overrides": [
{
"InstanceType": "string",
"WeightedCapacity": "string"
}
]
}
}
},
"AwsAutoScalingLaunchConfiguration": {
"AssociatePublicIpAddress": boolean,
"BlockDeviceMappings": [
{
"DeviceName": "string",
"Ebs": {
"DeleteOnTermination": boolean,
"Encrypted": boolean,
"Iops": number,
"SnapshotId": "string",
"VolumeSize": number,
"VolumeType": "string"
},
"NoDevice": boolean,
"VirtualName": "string"
}
],
"ClassicLinkVpcId": "string",
"ClassicLinkVpcSecurityGroups": [ "string" ],
"CreatedTime": "string",
"EbsOptimized": boolean,
"IamInstanceProfile": "string",
"ImageId": "string",
"InstanceMonitoring": {
"Enabled": boolean
},
"InstanceType": "string",
"KernelId": "string",
"KeyName": "string",
"LaunchConfigurationName": "string",
"MetadataOptions": {
"HttpEndpoint": "string",
"HttpPutResponseHopLimit": number,
"HttpTokens": "string"
},
"PlacementTenancy": "string",
"RamdiskId": "string",
"SecurityGroups": [ "string" ],
"SpotPrice": "string",
"UserData": "string"
},
"AwsBackupBackupPlan": {
"BackupPlan": {
"AdvancedBackupSettings": [
{
"BackupOptions": {
"string" : "string"
},
"ResourceType": "string"
}
],
"BackupPlanName": "string",
"BackupPlanRule": [
{
"CompletionWindowMinutes": number,
"CopyActions": [
{
"DestinationBackupVaultArn": "string",
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number
}
}
],
"EnableContinuousBackup": boolean,
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number
},
"RuleId": "string",
"RuleName": "string",
"ScheduleExpression": "string",
"StartWindowMinutes": number,
"TargetBackupVault": "string"
}
]
},
"BackupPlanArn": "string",
"BackupPlanId": "string",
"VersionId": "string"
},
"AwsBackupBackupVault": {
"AccessPolicy": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"EncryptionKeyArn": "string",
"Notifications": {
"BackupVaultEvents": [ "string" ],
"SnsTopicArn": "string"
}
},
"AwsBackupRecoveryPoint": {
"BackupSizeInBytes": number,
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CalculatedLifecycle": {
"DeleteAt": "string",
"MoveToColdStorageAt": "string"
},
"CompletionDate": "string",
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": "string",
"EncryptionKeyArn": "string",
"IamRoleArn": "string",
"IsEncrypted": boolean,
"LastRestoreTime": "string",
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number
},
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceType": "string",
"SourceBackupVaultArn": "string",
"Status": "string",
"StatusMessage": "string",
"StorageClass": "string"
},
"AwsCertificateManagerCertificate": {
"CertificateAuthorityArn": "string",
"CreatedAt": "string",
"DomainName": "string",
"DomainValidationOptions": [
{
"DomainName": "string",
"ResourceRecord": {
"Name": "string",
"Type": "string",
"Value": "string"
},
"ValidationDomain": "string",
"ValidationEmails": [ "string" ],
"ValidationMethod": "string",
"ValidationStatus": "string"
}
],
"ExtendedKeyUsages": [
{
"Name": "string",
"OId": "string"
}
],
"FailureReason": "string",
"ImportedAt": "string",
"InUseBy": [ "string" ],
"IssuedAt": "string",
"Issuer": "string",
"KeyAlgorithm": "string",
"KeyUsages": [
{
"Name": "string"
}
],
"NotAfter": "string",
"NotBefore": "string",
"Options": {
"CertificateTransparencyLoggingPreference": "string"
},
"RenewalEligibility": "string",
"RenewalSummary": {
"DomainValidationOptions": [
{
"DomainName": "string",
"ResourceRecord": {
"Name": "string",
"Type": "string",
"Value": "string"
},
"ValidationDomain": "string",
"ValidationEmails": [ "string" ],
"ValidationMethod": "string",
"ValidationStatus": "string"
}
],
"RenewalStatus": "string",
"RenewalStatusReason": "string",
"UpdatedAt": "string"
},
"Serial": "string",
"SignatureAlgorithm": "string",
"Status": "string",
"Subject": "string",
"SubjectAlternativeNames": [ "string" ],
"Type": "string"
},
"AwsCloudFormationStack": {
"Capabilities": [ "string" ],
"CreationTime": "string",
"Description": "string",
"DisableRollback": boolean,
"DriftInformation": {
"StackDriftStatus": "string"
},
"EnableTerminationProtection": boolean,
"LastUpdatedTime": "string",
"NotificationArns": [ "string" ],
"Outputs": [
{
"Description": "string",
"OutputKey": "string",
"OutputValue": "string"
}
],
"RoleArn": "string",
"StackId": "string",
"StackName": "string",
"StackStatus": "string",
"StackStatusReason": "string",
"TimeoutInMinutes": number
},
"AwsCloudFrontDistribution": {
"CacheBehaviors": {
"Items": [
{
"ViewerProtocolPolicy": "string"
}
]
},
"DefaultCacheBehavior": {
"ViewerProtocolPolicy": "string"
},
"DefaultRootObject": "string",
"DomainName": "string",
"ETag": "string",
"LastModifiedTime": "string",
"Logging": {
"Bucket": "string",
"Enabled": boolean,
"IncludeCookies": boolean,
"Prefix": "string"
},
"OriginGroups": {
"Items": [
{
"FailoverCriteria": {
"StatusCodes": {
"Items": [ number ],
"Quantity": number
}
}
}
]
},
"Origins": {
"Items": [
{
"CustomOriginConfig": {
"HttpPort": number,
"HttpsPort": number,
"OriginKeepaliveTimeout": number,
"OriginProtocolPolicy": "string",
"OriginReadTimeout": number,
"OriginSslProtocols": {
"Items": [ "string" ],
"Quantity": number
}
},
"DomainName": "string",
"Id": "string",
"OriginPath": "string",
"S3OriginConfig": {
"OriginAccessIdentity": "string"
}
}
]
},
"Status": "string",
"ViewerCertificate": {
"AcmCertificateArn": "string",
"Certificate": "string",
"CertificateSource": "string",
"CloudFrontDefaultCertificate": boolean,
"IamCertificateId": "string",
"MinimumProtocolVersion": "string",
"SslSupportMethod": "string"
},
"WebAclId": "string"
},
"AwsCloudTrailTrail": {
"CloudWatchLogsLogGroupArn": "string",
"CloudWatchLogsRoleArn": "string",
"HasCustomEventSelectors": boolean,
"HomeRegion": "string",
"IncludeGlobalServiceEvents": boolean,
"IsMultiRegionTrail": boolean,
"IsOrganizationTrail": boolean,
"KmsKeyId": "string",
"LogFileValidationEnabled": boolean,
"Name": "string",
"S3BucketName": "string",
"S3KeyPrefix": "string",
"SnsTopicArn": "string",
"SnsTopicName": "string",
"TrailArn": "string"
},
"AwsCloudWatchAlarm": {
"ActionsEnabled": boolean,
"AlarmActions": [ "string" ],
"AlarmArn": "string",
"AlarmConfigurationUpdatedTimestamp": "string",
"AlarmDescription": "string",
"AlarmName": "string",
"ComparisonOperator": "string",
"DatapointsToAlarm": number,
"Dimensions": [
{
"Name": "string",
"Value": "string"
}
],
"EvaluateLowSampleCountPercentile": "string",
"EvaluationPeriods": number,
"ExtendedStatistic": "string",
"InsufficientDataActions": [ "string" ],
"MetricName": "string",
"Namespace": "string",
"OkActions": [ "string" ],
"Period": number,
"Statistic": "string",
"Threshold": number,
"ThresholdMetricId": "string",
"TreatMissingData": "string",
"Unit": "string"
},
"AwsCodeBuildProject": {
"Artifacts": [
{
"ArtifactIdentifier": "string",
"EncryptionDisabled": boolean,
"Location": "string",
"Name": "string",
"NamespaceType": "string",
"OverrideArtifactName": boolean,
"Packaging": "string",
"Path": "string",
"Type": "string"
}
],
"EncryptionKey": "string",
"Environment": {
"Certificate": "string",
"EnvironmentVariables": [
{
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"ImagePullCredentialsType": "string",
"PrivilegedMode": boolean,
"RegistryCredential": {
"Credential": "string",
"CredentialProvider": "string"
},
"Type": "string"
},
"LogsConfig": {
"CloudWatchLogs": {
"GroupName": "string",
"Status": "string",
"StreamName": "string"
},
"S3Logs": {
"EncryptionDisabled": boolean,
"Location": "string",
"Status": "string"
}
},
"Name": "string",
"SecondaryArtifacts": [
{
"ArtifactIdentifier": "string",
"EncryptionDisabled": boolean,
"Location": "string",
"Name": "string",
"NamespaceType": "string",
"OverrideArtifactName": boolean,
"Packaging": "string",
"Path": "string",
"Type": "string"
}
],
"ServiceRole": "string",
"Source": {
"GitCloneDepth": number,
"InsecureSsl": boolean,
"Location": "string",
"Type": "string"
},
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ],
"VpcId": "string"
}
},
"AwsDmsEndpoint": {
"CertificateArn": "string",
"DatabaseName": "string",
"EndpointArn": "string",
"EndpointIdentifier": "string",
"EndpointType": "string",
"EngineName": "string",
"ExternalId": "string",
"ExtraConnectionAttributes": "string",
"KmsKeyId": "string",
"Port": number,
"ServerName": "string",
"SslMode": "string",
"Username": "string"
},
"AwsDmsReplicationInstance": {
"AllocatedStorage": number,
"AutoMinorVersionUpgrade": boolean,
"AvailabilityZone": "string",
"EngineVersion": "string",
"KmsKeyId": "string",
"MultiAZ": boolean,
"PreferredMaintenanceWindow": "string",
"PubliclyAccessible": boolean,
"ReplicationInstanceClass": "string",
"ReplicationInstanceIdentifier": "string",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupIdentifier": "string"
},
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "string"
}
]
},
"AwsDmsReplicationTask": {
"CdcStartPosition": "string",
"CdcStartTime": "string",
"CdcStopPosition": "string",
"Id": "string",
"MigrationType": "string",
"ReplicationInstanceArn": "string",
"ReplicationTaskIdentifier": "string",
"ReplicationTaskSettings": "string",
"ResourceIdentifier": "string",
"SourceEndpointArn": "string",
"TableMappings": "string",
"TargetEndpointArn": "string",
"TaskData": "string"
},
"AwsDynamoDbTable": {
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": "string"
},
"CreationDateTime": "string",
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": "string",
"LastIncreaseDateTime": "string",
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
}
],
"GlobalTableVersion": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"ProvisionedThroughput": {
"LastDecreaseDateTime": "string",
"LastIncreaseDateTime": "string",
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
}
}
],
"KmsMasterKeyId": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string"
}
],
"RestoreSummary": {
"RestoreDateTime": "string",
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SseDescription": {
"InaccessibleEncryptionDateTime": "string",
"KmsMasterKeyArn": "string",
"SseType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string"
},
"AwsEc2ClientVpnEndpoint": {
"AuthenticationOptions": [
{
"ActiveDirectory": {
"DirectoryId": "string"
},
"FederatedAuthentication": {
"SamlProviderArn": "string",
"SelfServiceSamlProviderArn": "string"
},
"MutualAuthentication": {
"ClientRootCertificateChain": "string"
},
"Type": "string"
}
],
"ClientCidrBlock": "string",
"ClientConnectOptions": {
"Enabled": boolean,
"LambdaFunctionArn": "string",
"Status": {
"Code": "string",
"Message": "string"
}
},
"ClientLoginBannerOptions": {
"BannerText": "string",
"Enabled": boolean
},
"ClientVpnEndpointId": "string",
"ConnectionLogOptions": {
"CloudwatchLogGroup": "string",
"CloudwatchLogStream": "string",
"Enabled": boolean
},
"Description": "string",
"DnsServer": [ "string" ],
"SecurityGroupIdSet": [ "string" ],
"SelfServicePortalUrl": "string",
"ServerCertificateArn": "string",
"SessionTimeoutHours": number,
"SplitTunnel": boolean,
"TransportProtocol": "string",
"VpcId": "string",
"VpnPort": number
},
"AwsEc2Eip": {
"AllocationId": "string",
"AssociationId": "string",
"Domain": "string",
"InstanceId": "string",
"NetworkBorderGroup": "string",
"NetworkInterfaceId": "string",
"NetworkInterfaceOwnerId": "string",
"PrivateIpAddress": "string",
"PublicIp": "string",
"PublicIpv4Pool": "string"
},
"AwsEc2Instance": {
"IamInstanceProfileArn": "string",
"ImageId": "string",
"IpV4Addresses": [ "string" ],
"IpV6Addresses": [ "string" ],
"KeyName": "string",
"LaunchedAt": "string",
"MetadataOptions": {
"HttpEndpoint": "string",
"HttpProtocolIpv6": "string",
"HttpPutResponseHopLimit": number,
"HttpTokens": "string",
"InstanceMetadataTags": "string"
},
"Monitoring": {
"State": "string"
},
"NetworkInterfaces": [
{
"NetworkInterfaceId": "string"
}
],
"SubnetId": "string",
"Type": "string",
"VirtualizationType": "string",
"VpcId": "string"
},
"AwsEc2LaunchTemplate": {
"DefaultVersionNumber": number,
"Id": "string",
"LatestVersionNumber": number,
"LaunchTemplateData": {
"BlockDeviceMappingSet": [
{
"DeviceName": "string",
"Ebs": {
"DeleteOnTermination": boolean,
"Encrypted": boolean,
"Iops": number,
"KmsKeyId": "string",
"SnapshotId": "string",
"Throughput": number,
"VolumeSize": number,
"VolumeType": "string"
},
"NoDevice": "string",
"VirtualName": "string"
}
],
"CapacityReservationSpecification": {
"CapacityReservationPreference": "string",
"CapacityReservationTarget": {
"CapacityReservationId": "string",
"CapacityReservationResourceGroupArn": "string"
}
},
"CpuOptions": {
"CoreCount": number,
"ThreadsPerCore": number
},
"CreditSpecification": {
"CpuCredits": "string"
},
"DisableApiStop": boolean,
"DisableApiTermination": boolean,
"EbsOptimized": boolean,
"ElasticGpuSpecificationSet": [
{
"Type": "string"
}
],
"ElasticInferenceAcceleratorSet": [
{
"Count": number,
"Type": "string"
}
],
"EnclaveOptions": {
"Enabled": boolean
},
"HibernationOptions": {
"Configured": boolean
},
"IamInstanceProfile": {
"Arn": "string",
"Name": "string"
},
"ImageId": "string",
"InstanceInitiatedShutdownBehavior": "string",
"InstanceMarketOptions": {
"MarketType": "string",
"SpotOptions": {
"BlockDurationMinutes": number,
"InstanceInterruptionBehavior": "string",
"MaxPrice": "string",
"SpotInstanceType": "string",
"ValidUntil": "string"
}
},
"InstanceRequirements": {
"AcceleratorCount": {
"Max": number,
"Min": number
},
"AcceleratorManufacturers": [ "string" ],
"AcceleratorNames": [ "string" ],
"AcceleratorTotalMemoryMiB": {
"Max": number,
"Min": number
},
"AcceleratorTypes": [ "string" ],
"BareMetal": "string",
"BaselineEbsBandwidthMbps": {
"Max": number,
"Min": number
},
"BurstablePerformance": "string",
"CpuManufacturers": [ "string" ],
"ExcludedInstanceTypes": [ "string" ],
"InstanceGenerations": [ "string" ],
"LocalStorage": "string",
"LocalStorageTypes": [ "string" ],
"MemoryGiBPerVCpu": {
"Max": number,
"Min": number
},
"MemoryMiB": {
"Max": number,
"Min": number
},
"NetworkInterfaceCount": {
"Max": number,
"Min": number
},
"OnDemandMaxPricePercentageOverLowestPrice": number,
"RequireHibernateSupport": boolean,
"SpotMaxPricePercentageOverLowestPrice": number,
"TotalLocalStorageGB": {
"Max": number,
"Min": number
},
"VCpuCount": {
"Max": number,
"Min": number
}
},
"InstanceType": "string",
"KernelId": "string",
"KeyName": "string",
"LicenseSet": [
{
"LicenseConfigurationArn": "string"
}
],
"MaintenanceOptions": {
"AutoRecovery": "string"
},
"MetadataOptions": {
"HttpEndpoint": "string",
"HttpProtocolIpv6": "string",
"HttpPutResponseHopLimit": number,
"HttpTokens": "string",
"InstanceMetadataTags": "string"
},
"Monitoring": {
"Enabled": boolean
},
"NetworkInterfaceSet": [
{
"AssociateCarrierIpAddress": boolean,
"AssociatePublicIpAddress": boolean,
"DeleteOnTermination": boolean,
"Description": "string",
"DeviceIndex": number,
"Groups": [ "string" ],
"InterfaceType": "string",
"Ipv4PrefixCount": number,
"Ipv4Prefixes": [
{
"Ipv4Prefix": "string"
}
],
"Ipv6AddressCount": number,
"Ipv6Addresses": [
{
"Ipv6Address": "string"
}
],
"Ipv6PrefixCount": number,
"Ipv6Prefixes": [
{
"Ipv6Prefix": "string"
}
],
"NetworkCardIndex": number,
"NetworkInterfaceId": "string",
"PrivateIpAddress": "string",
"PrivateIpAddresses": [
{
"Primary": boolean,
"PrivateIpAddress": "string"
}
],
"SecondaryPrivateIpAddressCount": number,
"SubnetId": "string"
}
],
"Placement": {
"Affinity": "string",
"AvailabilityZone": "string",
"GroupName": "string",
"HostId": "string",
"HostResourceGroupArn": "string",
"PartitionNumber": number,
"SpreadDomain": "string",
"Tenancy": "string"
},
"PrivateDnsNameOptions": {
"EnableResourceNameDnsAAAARecord": boolean,
"EnableResourceNameDnsARecord": boolean,
"HostnameType": "string"
},
"RamDiskId": "string",
"SecurityGroupIdSet": [ "string" ],
"SecurityGroupSet": [ "string" ],
"UserData": "string"
},
"LaunchTemplateName": "string"
},
"AwsEc2NetworkAcl": {
"Associations": [
{
"NetworkAclAssociationId": "string",
"NetworkAclId": "string",
"SubnetId": "string"
}
],
"Entries": [
{
"CidrBlock": "string",
"Egress": boolean,
"IcmpTypeCode": {
"Code": number,
"Type": number
},
"Ipv6CidrBlock": "string",
"PortRange": {
"From": number,
"To": number
},
"Protocol": "string",
"RuleAction": "string",
"RuleNumber": number
}
],
"IsDefault": boolean,
"NetworkAclId": "string",
"OwnerId": "string",
"VpcId": "string"
},
"AwsEc2NetworkInterface": {
"Attachment": {
"AttachmentId": "string",
"AttachTime": "string",
"DeleteOnTermination": boolean,
"DeviceIndex": number,
"InstanceId": "string",
"InstanceOwnerId": "string",
"Status": "string"
},
"IpV6Addresses": [
{
"IpV6Address": "string"
}
],
"NetworkInterfaceId": "string",
"PrivateIpAddresses": [
{
"PrivateDnsName": "string",
"PrivateIpAddress": "string"
}
],
"PublicDnsName": "string",
"PublicIp": "string",
"SecurityGroups": [
{
"GroupId": "string",
"GroupName": "string"
}
],
"SourceDestCheck": boolean
},
"AwsEc2RouteTable": {
"AssociationSet": [
{
"AssociationState": {
"State": "string",
"StatusMessage": "string"
},
"GatewayId": "string",
"Main": boolean,
"RouteTableAssociationId": "string",
"RouteTableId": "string",
"SubnetId": "string"
}
],
"OwnerId": "string",
"PropagatingVgwSet": [
{
"GatewayId": "string"
}
],
"RouteSet": [
{
"CarrierGatewayId": "string",
"CoreNetworkArn": "string",
"DestinationCidrBlock": "string",
"DestinationIpv6CidrBlock": "string",
"DestinationPrefixListId": "string",
"EgressOnlyInternetGatewayId": "string",
"GatewayId": "string",
"InstanceId": "string",
"InstanceOwnerId": "string",
"LocalGatewayId": "string",
"NatGatewayId": "string",
"NetworkInterfaceId": "string",
"Origin": "string",
"State": "string",
"TransitGatewayId": "string",
"VpcPeeringConnectionId": "string"
}
],
"RouteTableId": "string",
"VpcId": "string"
},
"AwsEc2SecurityGroup": {
"GroupId": "string",
"GroupName": "string",
"IpPermissions": [
{
"FromPort": number,
"IpProtocol": "string",
"IpRanges": [
{
"CidrIp": "string"
}
],
"Ipv6Ranges": [
{
"CidrIpv6": "string"
}
],
"PrefixListIds": [
{
"PrefixListId": "string"
}
],
"ToPort": number,
"UserIdGroupPairs": [
{
"GroupId": "string",
"GroupName": "string",
"PeeringStatus": "string",
"UserId": "string",
"VpcId": "string",
"VpcPeeringConnectionId": "string"
}
]
}
],
"IpPermissionsEgress": [
{
"FromPort": number,
"IpProtocol": "string",
"IpRanges": [
{
"CidrIp": "string"
}
],
"Ipv6Ranges": [
{
"CidrIpv6": "string"
}
],
"PrefixListIds": [
{
"PrefixListId": "string"
}
],
"ToPort": number,
"UserIdGroupPairs": [
{
"GroupId": "string",
"GroupName": "string",
"PeeringStatus": "string",
"UserId": "string",
"VpcId": "string",
"VpcPeeringConnectionId": "string"
}
]
}
],
"OwnerId": "string",
"VpcId": "string"
},
"AwsEc2Subnet": {
"AssignIpv6AddressOnCreation": boolean,
"AvailabilityZone": "string",
"AvailabilityZoneId": "string",
"AvailableIpAddressCount": number,
"CidrBlock": "string",
"DefaultForAz": boolean,
"Ipv6CidrBlockAssociationSet": [
{
"AssociationId": "string",
"CidrBlockState": "string",
"Ipv6CidrBlock": "string"
}
],
"MapPublicIpOnLaunch": boolean,
"OwnerId": "string",
"State": "string",
"SubnetArn": "string",
"SubnetId": "string",
"VpcId": "string"
},
"AwsEc2TransitGateway": {
"AmazonSideAsn": number,
"AssociationDefaultRouteTableId": "string",
"AutoAcceptSharedAttachments": "string",
"DefaultRouteTableAssociation": "string",
"DefaultRouteTablePropagation": "string",
"Description": "string",
"DnsSupport": "string",
"Id": "string",
"MulticastSupport": "string",
"PropagationDefaultRouteTableId": "string",
"TransitGatewayCidrBlocks": [ "string" ],
"VpnEcmpSupport": "string"
},
"AwsEc2Volume": {
"Attachments": [
{
"AttachTime": "string",
"DeleteOnTermination": boolean,
"InstanceId": "string",
"Status": "string"
}
],
"CreateTime": "string",
"DeviceName": "string",
"Encrypted": boolean,
"KmsKeyId": "string",
"Size": number,
"SnapshotId": "string",
"Status": "string",
"VolumeId": "string",
"VolumeScanStatus": "string",
"VolumeType": "string"
},
"AwsEc2Vpc": {
"CidrBlockAssociationSet": [
{
"AssociationId": "string",
"CidrBlock": "string",
"CidrBlockState": "string"
}
],
"DhcpOptionsId": "string",
"Ipv6CidrBlockAssociationSet": [
{
"AssociationId": "string",
"CidrBlockState": "string",
"Ipv6CidrBlock": "string"
}
],
"State": "string"
},
"AwsEc2VpcEndpointService": {
"AcceptanceRequired": boolean,
"AvailabilityZones": [ "string" ],
"BaseEndpointDnsNames": [ "string" ],
"GatewayLoadBalancerArns": [ "string" ],
"ManagesVpcEndpoints": boolean,
"NetworkLoadBalancerArns": [ "string" ],
"PrivateDnsName": "string",
"ServiceId": "string",
"ServiceName": "string",
"ServiceState": "string",
"ServiceType": [
{
"ServiceType": "string"
}
]
},
"AwsEc2VpcPeeringConnection": {
"AccepterVpcInfo": {
"CidrBlock": "string",
"CidrBlockSet": [
{
"CidrBlock": "string"
}
],
"Ipv6CidrBlockSet": [
{
"Ipv6CidrBlock": "string"
}
],
"OwnerId": "string",
"PeeringOptions": {
"AllowDnsResolutionFromRemoteVpc": boolean,
"AllowEgressFromLocalClassicLinkToRemoteVpc": boolean,
"AllowEgressFromLocalVpcToRemoteClassicLink": boolean
},
"Region": "string",
"VpcId": "string"
},
"ExpirationTime": "string",
"RequesterVpcInfo": {
"CidrBlock": "string",
"CidrBlockSet": [
{
"CidrBlock": "string"
}
],
"Ipv6CidrBlockSet": [
{
"Ipv6CidrBlock": "string"
}
],
"OwnerId": "string",
"PeeringOptions": {
"AllowDnsResolutionFromRemoteVpc": boolean,
"AllowEgressFromLocalClassicLinkToRemoteVpc": boolean,
"AllowEgressFromLocalVpcToRemoteClassicLink": boolean
},
"Region": "string",
"VpcId": "string"
},
"Status": {
"Code": "string",
"Message": "string"
},
"VpcPeeringConnectionId": "string"
},
"AwsEc2VpnConnection": {
"Category": "string",
"CustomerGatewayConfiguration": "string",
"CustomerGatewayId": "string",
"Options": {
"StaticRoutesOnly": boolean,
"TunnelOptions": [
{
"DpdTimeoutSeconds": number,
"IkeVersions": [ "string" ],
"OutsideIpAddress": "string",
"Phase1DhGroupNumbers": [ number ],
"Phase1EncryptionAlgorithms": [ "string" ],
"Phase1IntegrityAlgorithms": [ "string" ],
"Phase1LifetimeSeconds": number,
"Phase2DhGroupNumbers": [ number ],
"Phase2EncryptionAlgorithms": [ "string" ],
"Phase2IntegrityAlgorithms": [ "string" ],
"Phase2LifetimeSeconds": number,
"PreSharedKey": "string",
"RekeyFuzzPercentage": number,
"RekeyMarginTimeSeconds": number,
"ReplayWindowSize": number,
"TunnelInsideCidr": "string"
}
]
},
"Routes": [
{
"DestinationCidrBlock": "string",
"State": "string"
}
],
"State": "string",
"TransitGatewayId": "string",
"Type": "string",
"VgwTelemetry": [
{
"AcceptedRouteCount": number,
"CertificateArn": "string",
"LastStatusChange": "string",
"OutsideIpAddress": "string",
"Status": "string",
"StatusMessage": "string"
}
],
"VpnConnectionId": "string",
"VpnGatewayId": "string"
},
"AwsEcrContainerImage": {
"Architecture": "string",
"ImageDigest": "string",
"ImagePublishedAt": "string",
"ImageTags": [ "string" ],
"RegistryId": "string",
"RepositoryName": "string"
},
"AwsEcrRepository": {
"Arn": "string",
"ImageScanningConfiguration": {
"ScanOnPush": boolean
},
"ImageTagMutability": "string",
"LifecyclePolicy": {
"LifecyclePolicyText": "string",
"RegistryId": "string"
},
"RepositoryName": "string",
"RepositoryPolicyText": "string"
},
"AwsEcsCluster": {
"ActiveServicesCount": number,
"CapacityProviders": [ "string" ],
"ClusterArn": "string",
"ClusterName": "string",
"ClusterSettings": [
{
"Name": "string",
"Value": "string"
}
],
"Configuration": {
"ExecuteCommandConfiguration": {
"KmsKeyId": "string",
"LogConfiguration": {
"CloudWatchEncryptionEnabled": boolean,
"CloudWatchLogGroupName": "string",
"S3BucketName": "string",
"S3EncryptionEnabled": boolean,
"S3KeyPrefix": "string"
},
"Logging": "string"
}
},
"DefaultCapacityProviderStrategy": [
{
"Base": number,
"CapacityProvider": "string",
"Weight": number
}
],
"RegisteredContainerInstancesCount": number,
"RunningTasksCount": number,
"Status": "string"
},
"AwsEcsContainer": {
"Image": "string",
"MountPoints": [
{
"ContainerPath": "string",
"SourceVolume": "string"
}
],
"Name": "string",
"Privileged": boolean
},
"AwsEcsService": {
"CapacityProviderStrategy": [
{
"Base": number,
"CapacityProvider": "string",
"Weight": number
}
],
"Cluster": "string",
"DeploymentConfiguration": {
"DeploymentCircuitBreaker": {
"Enable": boolean,
"Rollback": boolean
},
"MaximumPercent": number,
"MinimumHealthyPercent": number
},
"DeploymentController": {
"Type": "string"
},
"DesiredCount": number,
"EnableEcsManagedTags": boolean,
"EnableExecuteCommand": boolean,
"HealthCheckGracePeriodSeconds": number,
"LaunchType": "string",
"LoadBalancers": [
{
"ContainerName": "string",
"ContainerPort": number,
"LoadBalancerName": "string",
"TargetGroupArn": "string"
}
],
"Name": "string",
"NetworkConfiguration": {
"AwsVpcConfiguration": {
"AssignPublicIp": "string",
"SecurityGroups": [ "string" ],
"Subnets": [ "string" ]
}
},
"PlacementConstraints": [
{
"Expression": "string",
"Type": "string"
}
],
"PlacementStrategies": [
{
"Field": "string",
"Type": "string"
}
],
"PlatformVersion": "string",
"PropagateTags": "string",
"Role": "string",
"SchedulingStrategy": "string",
"ServiceArn": "string",
"ServiceName": "string",
"ServiceRegistries": [
{
"ContainerName": "string",
"ContainerPort": number,
"Port": number,
"RegistryArn": "string"
}
],
"TaskDefinition": "string"
},
"AwsEcsTask": {
"ClusterArn": "string",
"Containers": [
{
"Image": "string",
"MountPoints": [
{
"ContainerPath": "string",
"SourceVolume": "string"
}
],
"Name": "string",
"Privileged": boolean
}
],
"CreatedAt": "string",
"Group": "string",
"StartedAt": "string",
"StartedBy": "string",
"TaskDefinitionArn": "string",
"Version": "string",
"Volumes": [
{
"Host": {
"SourcePath": "string"
},
"Name": "string"
}
]
},
"AwsEcsTaskDefinition": {
"ContainerDefinitions": [
{
"Command": [ "string" ],
"Cpu": number,
"DependsOn": [
{
"Condition": "string",
"ContainerName": "string"
}
],
"DisableNetworking": boolean,
"DnsSearchDomains": [ "string" ],
"DnsServers": [ "string" ],
"DockerLabels": {
"string" : "string"
},
"DockerSecurityOptions": [ "string" ],
"EntryPoint": [ "string" ],
"Environment": [
{
"Name": "string",
"Value": "string"
}
],
"EnvironmentFiles": [
{
"Type": "string",
"Value": "string"
}
],
"Essential": boolean,
"ExtraHosts": [
{
"Hostname": "string",
"IpAddress": "string"
}
],
"FirelensConfiguration": {
"Options": {
"string" : "string"
},
"Type": "string"
},
"HealthCheck": {
"Command": [ "string" ],
"Interval": number,
"Retries": number,
"StartPeriod": number,
"Timeout": number
},
"Hostname": "string",
"Image": "string",
"Interactive": boolean,
"Links": [ "string" ],
"LinuxParameters": {
"Capabilities": {
"Add": [ "string" ],
"Drop": [ "string" ]
},
"Devices": [
{
"ContainerPath": "string",
"HostPath": "string",
"Permissions": [ "string" ]
}
],
"InitProcessEnabled": boolean,
"MaxSwap": number,
"SharedMemorySize": number,
"Swappiness": number,
"Tmpfs": [
{
"ContainerPath": "string",
"MountOptions": [ "string" ],
"Size": number
}
]
},
"LogConfiguration": {
"LogDriver": "string",
"Options": {
"string" : "string"
},
"SecretOptions": [
{
"Name": "string",
"ValueFrom": "string"
}
]
},
"Memory": number,
"MemoryReservation": number,
"MountPoints": [
{
"ContainerPath": "string",
"ReadOnly": boolean,
"SourceVolume": "string"
}
],
"Name": "string",
"PortMappings": [
{
"ContainerPort": number,
"HostPort": number,
"Protocol": "string"
}
],
"Privileged": boolean,
"PseudoTerminal": boolean,
"ReadonlyRootFilesystem": boolean,
"RepositoryCredentials": {
"CredentialsParameter": "string"
},
"ResourceRequirements": [
{
"Type": "string",
"Value": "string"
}
],
"Secrets": [
{
"Name": "string",
"ValueFrom": "string"
}
],
"StartTimeout": number,
"StopTimeout": number,
"SystemControls": [
{
"Namespace": "string",
"Value": "string"
}
],
"Ulimits": [
{
"HardLimit": number,
"Name": "string",
"SoftLimit": number
}
],
"User": "string",
"VolumesFrom": [
{
"ReadOnly": boolean,
"SourceContainer": "string"
}
],
"WorkingDirectory": "string"
}
],
"Cpu": "string",
"ExecutionRoleArn": "string",
"Family": "string",
"InferenceAccelerators": [
{
"DeviceName": "string",
"DeviceType": "string"
}
],
"IpcMode": "string",
"Memory": "string",
"NetworkMode": "string",
"PidMode": "string",
"PlacementConstraints": [
{
"Expression": "string",
"Type": "string"
}
],
"ProxyConfiguration": {
"ContainerName": "string",
"ProxyConfigurationProperties": [
{
"Name": "string",
"Value": "string"
}
],
"Type": "string"
},
"RequiresCompatibilities": [ "string" ],
"Status": "string",
"TaskRoleArn": "string",
"Volumes": [
{
"DockerVolumeConfiguration": {
"Autoprovision": boolean,
"Driver": "string",
"DriverOpts": {
"string" : "string"
},
"Labels": {
"string" : "string"
},
"Scope": "string"
},
"EfsVolumeConfiguration": {
"AuthorizationConfig": {
"AccessPointId": "string",
"Iam": "string"
},
"FilesystemId": "string",
"RootDirectory": "string",
"TransitEncryption": "string",
"TransitEncryptionPort": number
},
"Host": {
"SourcePath": "string"
},
"Name": "string"
}
]
},
"AwsEfsAccessPoint": {
"AccessPointId": "string",
"Arn": "string",
"ClientToken": "string",
"FileSystemId": "string",
"PosixUser": {
"Gid": "string",
"SecondaryGids": [ "string" ],
"Uid": "string"
},
"RootDirectory": {
"CreationInfo": {
"OwnerGid": "string",
"OwnerUid": "string",
"Permissions": "string"
},
"Path": "string"
}
},
"AwsEksCluster": {
"Arn": "string",
"CertificateAuthorityData": "string",
"ClusterStatus": "string",
"Endpoint": "string",
"Logging": {
"ClusterLogging": [
{
"Enabled": boolean,
"Types": [ "string" ]
}
]
},
"Name": "string",
"ResourcesVpcConfig": {
"EndpointPublicAccess": boolean,
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"RoleArn": "string",
"Version": "string"
},
"AwsElasticBeanstalkEnvironment": {
"ApplicationName": "string",
"Cname": "string",
"DateCreated": "string",
"DateUpdated": "string",
"Description": "string",
"EndpointUrl": "string",
"EnvironmentArn": "string",
"EnvironmentId": "string",
"EnvironmentLinks": [
{
"EnvironmentName": "string",
"LinkName": "string"
}
],
"EnvironmentName": "string",
"OptionSettings": [
{
"Namespace": "string",
"OptionName": "string",
"ResourceName": "string",
"Value": "string"
}
],
"PlatformArn": "string",
"SolutionStackName": "string",
"Status": "string",
"Tier": {
"Name": "string",
"Type": "string",
"Version": "string"
},
"VersionLabel": "string"
},
"AwsElasticsearchDomain": {
"AccessPolicies": "string",
"DomainEndpointOptions": {
"EnforceHTTPS": boolean,
"TLSSecurityPolicy": "string"
},
"DomainId": "string",
"DomainName": "string",
"ElasticsearchClusterConfig": {
"DedicatedMasterCount": number,
"DedicatedMasterEnabled": boolean,
"DedicatedMasterType": "string",
"InstanceCount": number,
"InstanceType": "string",
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": number
},
"ZoneAwarenessEnabled": boolean
},
"ElasticsearchVersion": "string",
"EncryptionAtRestOptions": {
"Enabled": boolean,
"KmsKeyId": "string"
},
"Endpoint": "string",
"Endpoints": {
"string" : "string"
},
"LogPublishingOptions": {
"AuditLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
},
"IndexSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
},
"SearchSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
}
},
"NodeToNodeEncryptionOptions": {
"Enabled": boolean
},
"ServiceSoftwareOptions": {
"AutomatedUpdateDate": "string",
"Cancellable": boolean,
"CurrentVersion": "string",
"Description": "string",
"NewVersion": "string",
"UpdateAvailable": boolean,
"UpdateStatus": "string"
},
"VPCOptions": {
"AvailabilityZones": [ "string" ],
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VPCId": "string"
}
},
"AwsElbLoadBalancer": {
"AvailabilityZones": [ "string" ],
"BackendServerDescriptions": [
{
"InstancePort": number,
"PolicyNames": [ "string" ]
}
],
"CanonicalHostedZoneName": "string",
"CanonicalHostedZoneNameID": "string",
"CreatedTime": "string",
"DnsName": "string",
"HealthCheck": {
"HealthyThreshold": number,
"Interval": number,
"Target": "string",
"Timeout": number,
"UnhealthyThreshold": number
},
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerDescriptions": [
{
"Listener": {
"InstancePort": number,
"InstanceProtocol": "string",
"LoadBalancerPort": number,
"Protocol": "string",
"SslCertificateId": "string"
},
"PolicyNames": [ "string" ]
}
],
"LoadBalancerAttributes": {
"AccessLog": {
"EmitInterval": number,
"Enabled": boolean,
"S3BucketName": "string",
"S3BucketPrefix": "string"
},
"AdditionalAttributes": [
{
"Key": "string",
"Value": "string"
}
],
"ConnectionDraining": {
"Enabled": boolean,
"Timeout": number
},
"ConnectionSettings": {
"IdleTimeout": number
},
"CrossZoneLoadBalancing": {
"Enabled": boolean
}
},
"LoadBalancerName": "string",
"Policies": {
"AppCookieStickinessPolicies": [
{
"CookieName": "string",
"PolicyName": "string"
}
],
"LbCookieStickinessPolicies": [
{
"CookieExpirationPeriod": number,
"PolicyName": "string"
}
],
"OtherPolicies": [ "string" ]
},
"Scheme": "string",
"SecurityGroups": [ "string" ],
"SourceSecurityGroup": {
"GroupName": "string",
"OwnerAlias": "string"
},
"Subnets": [ "string" ],
"VpcId": "string"
},
"AwsElbv2LoadBalancer": {
"AvailabilityZones": [
{
"SubnetId": "string",
"ZoneName": "string"
}
],
"CanonicalHostedZoneId": "string",
"CreatedTime": "string",
"DNSName": "string",
"IpAddressType": "string",
"LoadBalancerAttributes": [
{
"Key": "string",
"Value": "string"
}
],
"Scheme": "string",
"SecurityGroups": [ "string" ],
"State": {
"Code": "string",
"Reason": "string"
},
"Type": "string",
"VpcId": "string"
},
"AwsEventSchemasRegistry": {
"Description": "string",
"RegistryArn": "string",
"RegistryName": "string"
},
"AwsEventsEndpoint": {
"Arn": "string",
"Description": "string",
"EndpointId": "string",
"EndpointUrl": "string",
"EventBuses": [
{
"EventBusArn": "string"
}
],
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {
"Route": "string"
}
}
},
"State": "string",
"StateReason": "string"
},
"AwsEventsEventbus": {
"Arn": "string",
"Name": "string",
"Policy": "string"
},
"AwsGuardDutyDetector": {
"DataSources": {
"CloudTrail": {
"Status": "string"
},
"DnsLogs": {
"Status": "string"
},
"FlowLogs": {
"Status": "string"
},
"Kubernetes": {
"AuditLogs": {
"Status": "string"
}
},
"MalwareProtection": {
"ScanEc2InstanceWithFindings": {
"EbsVolumes": {
"Reason": "string",
"Status": "string"
}
},
"ServiceRole": "string"
},
"S3Logs": {
"Status": "string"
}
},
"Features": [
{
"Name": "string",
"Status": "string"
}
],
"FindingPublishingFrequency": "string",
"ServiceRole": "string",
"Status": "string"
},
"AwsIamAccessKey": {
"AccessKeyId": "string",
"AccountId": "string",
"CreatedAt": "string",
"PrincipalId": "string",
"PrincipalName": "string",
"PrincipalType": "string",
"SessionContext": {
"Attributes": {
"CreationDate": "string",
"MfaAuthenticated": boolean
},
"SessionIssuer": {
"AccountId": "string",
"Arn": "string",
"PrincipalId": "string",
"Type": "string",
"UserName": "string"
}
},
"Status": "string",
"UserName": "string"
},
"AwsIamGroup": {
"AttachedManagedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"GroupPolicyList": [
{
"PolicyName": "string"
}
],
"Path": "string"
},
"AwsIamPolicy": {
"AttachmentCount": number,
"CreateDate": "string",
"DefaultVersionId": "string",
"Description": "string",
"IsAttachable": boolean,
"Path": "string",
"PermissionsBoundaryUsageCount": number,
"PolicyId": "string",
"PolicyName": "string",
"PolicyVersionList": [
{
"CreateDate": "string",
"IsDefaultVersion": boolean,
"VersionId": "string"
}
],
"UpdateDate": "string"
},
"AwsIamRole": {
"AssumeRolePolicyDocument": "string",
"AttachedManagedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"CreateDate": "string",
"InstanceProfileList": [
{
"Arn": "string",
"CreateDate": "string",
"InstanceProfileId": "string",
"InstanceProfileName": "string",
"Path": "string",
"Roles": [
{
"Arn": "string",
"AssumeRolePolicyDocument": "string",
"CreateDate": "string",
"Path": "string",
"RoleId": "string",
"RoleName": "string"
}
]
}
],
"MaxSessionDuration": number,
"Path": "string",
"PermissionsBoundary": {
"PermissionsBoundaryArn": "string",
"PermissionsBoundaryType": "string"
},
"RoleId": "string",
"RoleName": "string",
"RolePolicyList": [
{
"PolicyName": "string"
}
]
},
"AwsIamUser": {
"AttachedManagedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"CreateDate": "string",
"GroupList": [ "string" ],
"Path": "string",
"PermissionsBoundary": {
"PermissionsBoundaryArn": "string",
"PermissionsBoundaryType": "string"
},
"UserId": "string",
"UserName": "string",
"UserPolicyList": [
{
"PolicyName": "string"
}
]
},
"AwsKinesisStream": {
"Arn": "string",
"Name": "string",
"RetentionPeriodHours": number,
"ShardCount": number,
"StreamEncryption": {
"EncryptionType": "string",
"KeyId": "string"
}
},
"AwsKmsKey": {
"AWSAccountId": "string",
"CreationDate": number,
"Description": "string",
"KeyId": "string",
"KeyManager": "string",
"KeyRotationStatus": boolean,
"KeyState": "string",
"Origin": "string"
},
"AwsLambdaFunction": {
"Architectures": [ "string" ],
"Code": {
"S3Bucket": "string",
"S3Key": "string",
"S3ObjectVersion": "string",
"ZipFile": "string"
},
"CodeSha256": "string",
"DeadLetterConfig": {
"TargetArn": "string"
},
"Environment": {
"Error": {
"ErrorCode": "string",
"Message": "string"
},
"Variables": {
"string" : "string"
}
},
"FunctionName": "string",
"Handler": "string",
"KmsKeyArn": "string",
"LastModified": "string",
"Layers": [
{
"Arn": "string",
"CodeSize": number
}
],
"MasterArn": "string",
"MemorySize": number,
"PackageType": "string",
"RevisionId": "string",
"Role": "string",
"Runtime": "string",
"Timeout": number,
"TracingConfig": {
"Mode": "string"
},
"Version": "string",
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VpcId": "string"
}
},
"AwsLambdaLayerVersion": {
"CompatibleRuntimes": [ "string" ],
"CreatedDate": "string",
"Version": number
},
"AwsMskCluster": {
"ClusterInfo": {
"ClientAuthentication": {
"Sasl": {
"Iam": {
"Enabled": boolean
},
"Scram": {
"Enabled": boolean
}
},
"Tls": {
"CertificateAuthorityArnList": [ "string" ],
"Enabled": boolean
},
"Unauthenticated": {
"Enabled": boolean
}
},
"ClusterName": "string",
"CurrentVersion": "string",
"EncryptionInfo": {
"EncryptionAtRest": {
"DataVolumeKMSKeyId": "string"
},
"EncryptionInTransit": {
"ClientBroker": "string",
"InCluster": boolean
}
},
"EnhancedMonitoring": "string",
"NumberOfBrokerNodes": number
}
},
"AwsNetworkFirewallFirewall": {
"DeleteProtection": boolean,
"Description": "string",
"FirewallArn": "string",
"FirewallId": "string",
"FirewallName": "string",
"FirewallPolicyArn": "string",
"FirewallPolicyChangeProtection": boolean,
"SubnetChangeProtection": boolean,
"SubnetMappings": [
{
"SubnetId": "string"
}
],
"VpcId": "string"
},
"AwsNetworkFirewallFirewallPolicy": {
"Description": "string",
"FirewallPolicy": {
"StatefulRuleGroupReferences": [
{
"ResourceArn": "string"
}
],
"StatelessCustomActions": [
{
"ActionDefinition": {
"PublishMetricAction": {
"Dimensions": [
{
"Value": "string"
}
]
}
},
"ActionName": "string"
}
],
"StatelessDefaultActions": [ "string" ],
"StatelessFragmentDefaultActions": [ "string" ],
"StatelessRuleGroupReferences": [
{
"Priority": number,
"ResourceArn": "string"
}
]
},
"FirewallPolicyArn": "string",
"FirewallPolicyId": "string",
"FirewallPolicyName": "string"
},
"AwsNetworkFirewallRuleGroup": {
"Capacity": number,
"Description": "string",
"RuleGroup": {
"RulesSource": {
"RulesSourceList": {
"GeneratedRulesType": "string",
"Targets": [ "string" ],
"TargetTypes": [ "string" ]
},
"RulesString": "string",
"StatefulRules": [
{
"Action": "string",
"Header": {
"Destination": "string",
"DestinationPort": "string",
"Direction": "string",
"Protocol": "string",
"Source": "string",
"SourcePort": "string"
},
"RuleOptions": [
{
"Keyword": "string",
"Settings": [ "string" ]
}
]
}
],
"StatelessRulesAndCustomActions": {
"CustomActions": [
{
"ActionDefinition": {
"PublishMetricAction": {
"Dimensions": [
{
"Value": "string"
}
]
}
},
"ActionName": "string"
}
],
"StatelessRules": [
{
"Priority": number,
"RuleDefinition": {
"Actions": [ "string" ],
"MatchAttributes": {
"DestinationPorts": [
{
"FromPort": number,
"ToPort": number
}
],
"Destinations": [
{
"AddressDefinition": "string"
}
],
"Protocols": [ number ],
"SourcePorts": [
{
"FromPort": number,
"ToPort": number
}
],
"Sources": [
{
"AddressDefinition": "string"
}
],
"TcpFlags": [
{
"Flags": [ "string" ],
"Masks": [ "string" ]
}
]
}
}
}
]
}
},
"RuleVariables": {
"IpSets": {
"Definition": [ "string" ]
},
"PortSets": {
"Definition": [ "string" ]
}
}
},
"RuleGroupArn": "string",
"RuleGroupId": "string",
"RuleGroupName": "string",
"Type": "string"
},
"AwsOpenSearchServiceDomain": {
"AccessPolicies": "string",
"AdvancedSecurityOptions": {
"Enabled": boolean,
"InternalUserDatabaseEnabled": boolean,
"MasterUserOptions": {
"MasterUserArn": "string",
"MasterUserName": "string",
"MasterUserPassword": "string"
}
},
"Arn": "string",
"ClusterConfig": {
"DedicatedMasterCount": number,
"DedicatedMasterEnabled": boolean,
"DedicatedMasterType": "string",
"InstanceCount": number,
"InstanceType": "string",
"WarmCount": number,
"WarmEnabled": boolean,
"WarmType": "string",
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": number
},
"ZoneAwarenessEnabled": boolean
},
"DomainEndpoint": "string",
"DomainEndpointOptions": {
"CustomEndpoint": "string",
"CustomEndpointCertificateArn": "string",
"CustomEndpointEnabled": boolean,
"EnforceHTTPS": boolean,
"TLSSecurityPolicy": "string"
},
"DomainEndpoints": {
"string" : "string"
},
"DomainName": "string",
"EncryptionAtRestOptions": {
"Enabled": boolean,
"KmsKeyId": "string"
},
"EngineVersion": "string",
"Id": "string",
"LogPublishingOptions": {
"AuditLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
},
"IndexSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
},
"SearchSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
}
},
"NodeToNodeEncryptionOptions": {
"Enabled": boolean
},
"ServiceSoftwareOptions": {
"AutomatedUpdateDate": "string",
"Cancellable": boolean,
"CurrentVersion": "string",
"Description": "string",
"NewVersion": "string",
"OptionalDeployment": boolean,
"UpdateAvailable": boolean,
"UpdateStatus": "string"
},
"VpcOptions": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"AwsRdsDbCluster": {
"ActivityStreamStatus": "string",
"AllocatedStorage": number,
"AssociatedRoles": [
{
"RoleArn": "string",
"Status": "string"
}
],
"AutoMinorVersionUpgrade": boolean,
"AvailabilityZones": [ "string" ],
"BackupRetentionPeriod": number,
"ClusterCreateTime": "string",
"CopyTagsToSnapshot": boolean,
"CrossAccountClone": boolean,
"CustomEndpoints": [ "string" ],
"DatabaseName": "string",
"DbClusterIdentifier": "string",
"DbClusterMembers": [
{
"DbClusterParameterGroupStatus": "string",
"DbInstanceIdentifier": "string",
"IsClusterWriter": boolean,
"PromotionTier": number
}
],
"DbClusterOptionGroupMemberships": [
{
"DbClusterOptionGroupName": "string",
"Status": "string"
}
],
"DbClusterParameterGroup": "string",
"DbClusterResourceId": "string",
"DbSubnetGroup": "string",
"DeletionProtection": boolean,
"DomainMemberships": [
{
"Domain": "string",
"Fqdn": "string",
"IamRoleName": "string",
"Status": "string"
}
],
"EnabledCloudWatchLogsExports": [ "string" ],
"Endpoint": "string",
"Engine": "string",
"EngineMode": "string",
"EngineVersion": "string",
"HostedZoneId": "string",
"HttpEndpointEnabled": boolean,
"IamDatabaseAuthenticationEnabled": boolean,
"KmsKeyId": "string",
"MasterUsername": "string",
"MultiAz": boolean,
"Port": number,
"PreferredBackupWindow": "string",
"PreferredMaintenanceWindow": "string",
"ReaderEndpoint": "string",
"ReadReplicaIdentifiers": [ "string" ],
"Status": "string",
"StorageEncrypted": boolean,
"VpcSecurityGroups": [
{
"Status": "string",
"VpcSecurityGroupId": "string"
}
]
},
"AwsRdsDbClusterSnapshot": {
"AllocatedStorage": number,
"AvailabilityZones": [ "string" ],
"ClusterCreateTime": "string",
"DbClusterIdentifier": "string",
"DbClusterSnapshotAttributes": [
{
"AttributeName": "string",
"AttributeValues": [ "string" ]
}
],
"DbClusterSnapshotIdentifier": "string",
"Engine": "string",
"EngineVersion": "string",
"IamDatabaseAuthenticationEnabled": boolean,
"KmsKeyId": "string",
"LicenseModel": "string",
"MasterUsername": "string",
"PercentProgress": number,
"Port": number,
"SnapshotCreateTime": "string",
"SnapshotType": "string",
"Status": "string",
"StorageEncrypted": boolean,
"VpcId": "string"
},
"AwsRdsDbInstance": {
"AllocatedStorage": number,
"AssociatedRoles": [
{
"FeatureName": "string",
"RoleArn": "string",
"Status": "string"
}
],
"AutoMinorVersionUpgrade": boolean,
"AvailabilityZone": "string",
"BackupRetentionPeriod": number,
"CACertificateIdentifier": "string",
"CharacterSetName": "string",
"CopyTagsToSnapshot": boolean,
"DBClusterIdentifier": "string",
"DBInstanceClass": "string",
"DBInstanceIdentifier": "string",
"DbInstancePort": number,
"DbInstanceStatus": "string",
"DbiResourceId": "string",
"DBName": "string",
"DbParameterGroups": [
{
"DbParameterGroupName": "string",
"ParameterApplyStatus": "string"
}
],
"DbSecurityGroups": [ "string" ],
"DbSubnetGroup": {
"DbSubnetGroupArn": "string",
"DbSubnetGroupDescription": "string",
"DbSubnetGroupName": "string",
"SubnetGroupStatus": "string",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "string"
},
"SubnetIdentifier": "string",
"SubnetStatus": "string"
}
],
"VpcId": "string"
},
"DeletionProtection": boolean,
"DomainMemberships": [
{
"Domain": "string",
"Fqdn": "string",
"IamRoleName": "string",
"Status": "string"
}
],
"EnabledCloudWatchLogsExports": [ "string" ],
"Endpoint": {
"Address": "string",
"HostedZoneId": "string",
"Port": number
},
"Engine": "string",
"EngineVersion": "string",
"EnhancedMonitoringResourceArn": "string",
"IAMDatabaseAuthenticationEnabled": boolean,
"InstanceCreateTime": "string",
"Iops": number,
"KmsKeyId": "string",
"LatestRestorableTime": "string",
"LicenseModel": "string",
"ListenerEndpoint": {
"Address": "string",
"HostedZoneId": "string",
"Port": number
},
"MasterUsername": "string",
"MaxAllocatedStorage": number,
"MonitoringInterval": number,
"MonitoringRoleArn": "string",
"MultiAz": boolean,
"OptionGroupMemberships": [
{
"OptionGroupName": "string",
"Status": "string"
}
],
"PendingModifiedValues": {
"AllocatedStorage": number,
"BackupRetentionPeriod": number,
"CaCertificateIdentifier": "string",
"DbInstanceClass": "string",
"DbInstanceIdentifier": "string",
"DbSubnetGroupName": "string",
"EngineVersion": "string",
"Iops": number,
"LicenseModel": "string",
"MasterUserPassword": "string",
"MultiAZ": boolean,
"PendingCloudWatchLogsExports": {
"LogTypesToDisable": [ "string" ],
"LogTypesToEnable": [ "string" ]
},
"Port": number,
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
],
"StorageType": "string"
},
"PerformanceInsightsEnabled": boolean,
"PerformanceInsightsKmsKeyId": "string",
"PerformanceInsightsRetentionPeriod": number,
"PreferredBackupWindow": "string",
"PreferredMaintenanceWindow": "string",
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
],
"PromotionTier": number,
"PubliclyAccessible": boolean,
"ReadReplicaDBClusterIdentifiers": [ "string" ],
"ReadReplicaDBInstanceIdentifiers": [ "string" ],
"ReadReplicaSourceDBInstanceIdentifier": "string",
"SecondaryAvailabilityZone": "string",
"StatusInfos": [
{
"Message": "string",
"Normal": boolean,
"Status": "string",
"StatusType": "string"
}
],
"StorageEncrypted": boolean,
"StorageType": "string",
"TdeCredentialArn": "string",
"Timezone": "string",
"VpcSecurityGroups": [
{
"Status": "string",
"VpcSecurityGroupId": "string"
}
]
},
"AwsRdsDbSecurityGroup": {
"DbSecurityGroupArn": "string",
"DbSecurityGroupDescription": "string",
"DbSecurityGroupName": "string",
"Ec2SecurityGroups": [
{
"Ec2SecurityGroupId": "string",
"Ec2SecurityGroupName": "string",
"Ec2SecurityGroupOwnerId": "string",
"Status": "string"
}
],
"IpRanges": [
{
"CidrIp": "string",
"Status": "string"
}
],
"OwnerId": "string",
"VpcId": "string"
},
"AwsRdsDbSnapshot": {
"AllocatedStorage": number,
"AvailabilityZone": "string",
"DbInstanceIdentifier": "string",
"DbiResourceId": "string",
"DbSnapshotIdentifier": "string",
"Encrypted": boolean,
"Engine": "string",
"EngineVersion": "string",
"IamDatabaseAuthenticationEnabled": boolean,
"InstanceCreateTime": "string",
"Iops": number,
"KmsKeyId": "string",
"LicenseModel": "string",
"MasterUsername": "string",
"OptionGroupName": "string",
"PercentProgress": number,
"Port": number,
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
],
"SnapshotCreateTime": "string",
"SnapshotType": "string",
"SourceDbSnapshotIdentifier": "string",
"SourceRegion": "string",
"Status": "string",
"StorageType": "string",
"TdeCredentialArn": "string",
"Timezone": "string",
"VpcId": "string"
},
"AwsRdsEventSubscription": {
"CustomerAwsId": "string",
"CustSubscriptionId": "string",
"Enabled": boolean,
"EventCategoriesList": [ "string" ],
"EventSubscriptionArn": "string",
"SnsTopicArn": "string",
"SourceIdsList": [ "string" ],
"SourceType": "string",
"Status": "string",
"SubscriptionCreationTime": "string"
},
"AwsRedshiftCluster": {
"AllowVersionUpgrade": boolean,
"AutomatedSnapshotRetentionPeriod": number,
"AvailabilityZone": "string",
"ClusterAvailabilityStatus": "string",
"ClusterCreateTime": "string",
"ClusterIdentifier": "string",
"ClusterNodes": [
{
"NodeRole": "string",
"PrivateIpAddress": "string",
"PublicIpAddress": "string"
}
],
"ClusterParameterGroups": [
{
"ClusterParameterStatusList": [
{
"ParameterApplyErrorDescription": "string",
"ParameterApplyStatus": "string",
"ParameterName": "string"
}
],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
}
],
"ClusterPublicKey": "string",
"ClusterRevisionNumber": "string",
"ClusterSecurityGroups": [
{
"ClusterSecurityGroupName": "string",
"Status": "string"
}
],
"ClusterSnapshotCopyStatus": {
"DestinationRegion": "string",
"ManualSnapshotRetentionPeriod": number,
"RetentionPeriod": number,
"SnapshotCopyGrantName": "string"
},
"ClusterStatus": "string",
"ClusterSubnetGroupName": "string",
"ClusterVersion": "string",
"DBName": "string",
"DeferredMaintenanceWindows": [
{
"DeferMaintenanceEndTime": "string",
"DeferMaintenanceIdentifier": "string",
"DeferMaintenanceStartTime": "string"
}
],
"ElasticIpStatus": {
"ElasticIp": "string",
"Status": "string"
},
"ElasticResizeNumberOfNodeOptions": "string",
"Encrypted": boolean,
"Endpoint": {
"Address": "string",
"Port": number
},
"EnhancedVpcRouting": boolean,
"ExpectedNextSnapshotScheduleTime": "string",
"ExpectedNextSnapshotScheduleTimeStatus": "string",
"HsmStatus": {
"HsmClientCertificateIdentifier": "string",
"HsmConfigurationIdentifier": "string",
"Status": "string"
},
"IamRoles": [
{
"ApplyStatus": "string",
"IamRoleArn": "string"
}
],
"KmsKeyId": "string",
"LoggingStatus": {
"BucketName": "string",
"LastFailureMessage": "string",
"LastFailureTime": "string",
"LastSuccessfulDeliveryTime": "string",
"LoggingEnabled": boolean,
"S3KeyPrefix": "string"
},
"MaintenanceTrackName": "string",
"ManualSnapshotRetentionPeriod": number,
"MasterUsername": "string",
"NextMaintenanceWindowStartTime": "string",
"NodeType": "string",
"NumberOfNodes": number,
"PendingActions": [ "string" ],
"PendingModifiedValues": {
"AutomatedSnapshotRetentionPeriod": number,
"ClusterIdentifier": "string",
"ClusterType": "string",
"ClusterVersion": "string",
"EncryptionType": "string",
"EnhancedVpcRouting": boolean,
"MaintenanceTrackName": "string",
"MasterUserPassword": "string",
"NodeType": "string",
"NumberOfNodes": number,
"PubliclyAccessible": boolean
},
"PreferredMaintenanceWindow": "string",
"PubliclyAccessible": boolean,
"ResizeInfo": {
"AllowCancelResize": boolean,
"ResizeType": "string"
},
"RestoreStatus": {
"CurrentRestoreRateInMegaBytesPerSecond": number,
"ElapsedTimeInSeconds": number,
"EstimatedTimeToCompletionInSeconds": number,
"ProgressInMegaBytes": number,
"SnapshotSizeInMegaBytes": number,
"Status": "string"
},
"SnapshotScheduleIdentifier": "string",
"SnapshotScheduleState": "string",
"VpcId": "string",
"VpcSecurityGroups": [
{
"Status": "string",
"VpcSecurityGroupId": "string"
}
]
},
"AwsRoute53HostedZone": {
"HostedZone": {
"Config": {
"Comment": "string"
},
"Id": "string",
"Name": "string"
},
"NameServers": [ "string" ],
"QueryLoggingConfig": {
"CloudWatchLogsLogGroupArn": {
"CloudWatchLogsLogGroupArn": "string",
"HostedZoneId": "string",
"Id": "string"
}
},
"Vpcs": [
{
"Id": "string",
"Region": "string"
}
]
},
"AwsS3AccessPoint": {
"AccessPointArn": "string",
"Alias": "string",
"Bucket": "string",
"BucketAccountId": "string",
"Name": "string",
"NetworkOrigin": "string",
"PublicAccessBlockConfiguration": {
"BlockPublicAcls": boolean,
"BlockPublicPolicy": boolean,
"IgnorePublicAcls": boolean,
"RestrictPublicBuckets": boolean
},
"VpcConfiguration": {
"VpcId": "string"
}
},
"AwsS3AccountPublicAccessBlock": {
"BlockPublicAcls": boolean,
"BlockPublicPolicy": boolean,
"IgnorePublicAcls": boolean,
"RestrictPublicBuckets": boolean
},
"AwsS3Bucket": {
"AccessControlList": "string",
"BucketLifecycleConfiguration": {
"Rules": [
{
"AbortIncompleteMultipartUpload": {
"DaysAfterInitiation": number
},
"ExpirationDate": "string",
"ExpirationInDays": number,
"ExpiredObjectDeleteMarker": boolean,
"Filter": {
"Predicate": {
"Operands": [
{
"Prefix": "string",
"Tag": {
"Key": "string",
"Value": "string"
},
"Type": "string"
}
],
"Prefix": "string",
"Tag": {
"Key": "string",
"Value": "string"
},
"Type": "string"
}
},
"ID": "string",
"NoncurrentVersionExpirationInDays": number,
"NoncurrentVersionTransitions": [
{
"Days": number,
"StorageClass": "string"
}
],
"Prefix": "string",
"Status": "string",
"Transitions": [
{
"Date": "string",
"Days": number,
"StorageClass": "string"
}
]
}
]
},
"BucketLoggingConfiguration": {
"DestinationBucketName": "string",
"LogFilePrefix": "string"
},
"BucketNotificationConfiguration": {
"Configurations": [
{
"Destination": "string",
"Events": [ "string" ],
"Filter": {
"S3KeyFilter": {
"FilterRules": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Type": "string"
}
]
},
"BucketVersioningConfiguration": {
"IsMfaDeleteEnabled": boolean,
"Status": "string"
},
"BucketWebsiteConfiguration": {
"ErrorDocument": "string",
"IndexDocumentSuffix": "string",
"RedirectAllRequestsTo": {
"Hostname": "string",
"Protocol": "string"
},
"RoutingRules": [
{
"Condition": {
"HttpErrorCodeReturnedEquals": "string",
"KeyPrefixEquals": "string"
},
"Redirect": {
"Hostname": "string",
"HttpRedirectCode": "string",
"Protocol": "string",
"ReplaceKeyPrefixWith": "string",
"ReplaceKeyWith": "string"
}
}
]
},
"CreatedAt": "string",
"Name": "string",
"ObjectLockConfiguration": {
"ObjectLockEnabled": "string",
"Rule": {
"DefaultRetention": {
"Days": number,
"Mode": "string",
"Years": number
}
}
},
"OwnerAccountId": "string",
"OwnerId": "string",
"OwnerName": "string",
"PublicAccessBlockConfiguration": {
"BlockPublicAcls": boolean,
"BlockPublicPolicy": boolean,
"IgnorePublicAcls": boolean,
"RestrictPublicBuckets": boolean
},
"ServerSideEncryptionConfiguration": {
"Rules": [
{
"ApplyServerSideEncryptionByDefault": {
"KMSMasterKeyID": "string",
"SSEAlgorithm": "string"
}
}
]
}
},
"AwsS3Object": {
"ContentType": "string",
"ETag": "string",
"LastModified": "string",
"ServerSideEncryption": "string",
"SSEKMSKeyId": "string",
"VersionId": "string"
},
"AwsSageMakerNotebookInstance": {
"AcceleratorTypes": [ "string" ],
"AdditionalCodeRepositories": [ "string" ],
"DefaultCodeRepository": "string",
"DirectInternetAccess": "string",
"FailureReason": "string",
"InstanceMetadataServiceConfiguration": {
"MinimumInstanceMetadataServiceVersion": "string"
},
"InstanceType": "string",
"KmsKeyId": "string",
"NetworkInterfaceId": "string",
"NotebookInstanceArn": "string",
"NotebookInstanceLifecycleConfigName": "string",
"NotebookInstanceName": "string",
"NotebookInstanceStatus": "string",
"PlatformIdentifier": "string",
"RoleArn": "string",
"RootAccess": "string",
"SecurityGroups": [ "string" ],
"SubnetId": "string",
"Url": "string",
"VolumeSizeInGB": number
},
"AwsSecretsManagerSecret": {
"Deleted": boolean,
"Description": "string",
"KmsKeyId": "string",
"Name": "string",
"RotationEnabled": boolean,
"RotationLambdaArn": "string",
"RotationOccurredWithinFrequency": boolean,
"RotationRules": {
"AutomaticallyAfterDays": number
}
},
"AwsSnsTopic": {
"ApplicationSuccessFeedbackRoleArn": "string",
"FirehoseFailureFeedbackRoleArn": "string",
"FirehoseSuccessFeedbackRoleArn": "string",
"HttpFailureFeedbackRoleArn": "string",
"HttpSuccessFeedbackRoleArn": "string",
"KmsMasterKeyId": "string",
"Owner": "string",
"SqsFailureFeedbackRoleArn": "string",
"SqsSuccessFeedbackRoleArn": "string",
"Subscription": [
{
"Endpoint": "string",
"Protocol": "string"
}
],
"TopicName": "string"
},
"AwsSqsQueue": {
"DeadLetterTargetArn": "string",
"KmsDataKeyReusePeriodSeconds": number,
"KmsMasterKeyId": "string",
"QueueName": "string"
},
"AwsSsmPatchCompliance": {
"Patch": {
"ComplianceSummary": {
"ComplianceType": "string",
"CompliantCriticalCount": number,
"CompliantHighCount": number,
"CompliantInformationalCount": number,
"CompliantLowCount": number,
"CompliantMediumCount": number,
"CompliantUnspecifiedCount": number,
"ExecutionType": "string",
"NonCompliantCriticalCount": number,
"NonCompliantHighCount": number,
"NonCompliantInformationalCount": number,
"NonCompliantLowCount": number,
"NonCompliantMediumCount": number,
"NonCompliantUnspecifiedCount": number,
"OverallSeverity": "string",
"PatchBaselineId": "string",
"PatchGroup": "string",
"Status": "string"
}
}
},
"AwsStepFunctionStateMachine": {
"Label": "string",
"LoggingConfiguration": {
"Destinations": [
{
"CloudWatchLogsLogGroup": {
"LogGroupArn": "string"
}
}
],
"IncludeExecutionData": boolean,
"Level": "string"
},
"Name": "string",
"RoleArn": "string",
"StateMachineArn": "string",
"Status": "string",
"TracingConfiguration": {
"Enabled": boolean
},
"Type": "string"
},
"AwsWafRateBasedRule": {
"MatchPredicates": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": number,
"RuleId": "string"
},
"AwsWafRegionalRateBasedRule": {
"MatchPredicates": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": number,
"RuleId": "string"
},
"AwsWafRegionalRule": {
"MetricName": "string",
"Name": "string",
"PredicateList": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"RuleId": "string"
},
"AwsWafRegionalRuleGroup": {
"MetricName": "string",
"Name": "string",
"RuleGroupId": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
]
},
"AwsWafRegionalWebAcl": {
"DefaultAction": "string",
"MetricName": "string",
"Name": "string",
"RulesList": [
{
"Action": {
"Type": "string"
},
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
],
"WebAclId": "string"
},
"AwsWafRule": {
"MetricName": "string",
"Name": "string",
"PredicateList": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"RuleId": "string"
},
"AwsWafRuleGroup": {
"MetricName": "string",
"Name": "string",
"RuleGroupId": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
]
},
"AwsWafv2RuleGroup": {
"Arn": "string",
"Capacity": number,
"Description": "string",
"Id": "string",
"Name": "string",
"Rules": [
{
"Action": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string",
"OverrideAction": "string",
"Priority": number,
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
],
"Scope": "string",
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
},
"AwsWafv2WebAcl": {
"Arn": "string",
"Capacity": number,
"CaptchaConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"DefaultAction": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Description": "string",
"Id": "string",
"ManagedbyFirewallManager": boolean,
"Name": "string",
"Rules": [
{
"Action": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string",
"OverrideAction": "string",
"Priority": number,
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
],
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
},
"AwsWafWebAcl": {
"DefaultAction": "string",
"Name": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
],
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
],
"WebAclId": "string"
},
"AwsXrayEncryptionConfig": {
"KeyId": "string",
"Status": "string",
"Type": "string"
},
"CodeRepository": {
"CodeSecurityIntegrationArn": "string",
"ProjectName": "string",
"ProviderType": "string"
},
"Container": {
"ContainerRuntime": "string",
"ImageId": "string",
"ImageName": "string",
"LaunchedAt": "string",
"Name": "string",
"Privileged": boolean,
"VolumeMounts": [
{
"MountPath": "string",
"Name": "string"
}
]
},
"Other": {
"string" : "string"
}
},
"Id": "string",
"Partition": "string",
"Region": "string",
"ResourceRole": "string",
"Tags": {
"string" : "string"
},
"Type": "string"
}
],
"Sample": boolean,
"SchemaVersion": "string",
"Severity": {
"Label": "string",
"Normalized": number,
"Original": "string",
"Product": number
},
"SourceUrl": "string",
"ThreatIntelIndicators": [
{
"Category": "string",
"LastObservedAt": "string",
"Source": "string",
"SourceUrl": "string",
"Type": "string",
"Value": "string"
}
],
"Threats": [
{
"FilePaths": [
{
"FileName": "string",
"FilePath": "string",
"Hash": "string",
"ResourceId": "string"
}
],
"ItemCount": number,
"Name": "string",
"Severity": "string"
}
],
"Title": "string",
"Types": [ "string" ],
"UpdatedAt": "string",
"UserDefinedFields": {
"string" : "string"
},
"VerificationState": "string",
"Vulnerabilities": [
{
"CodeVulnerabilities": [
{
"Cwes": [ "string" ],
"FilePath": {
"EndLine": number,
"FileName": "string",
"FilePath": "string",
"StartLine": number
},
"SourceArn": "string"
}
],
"Cvss": [
{
"Adjustments": [
{
"Metric": "string",
"Reason": "string"
}
],
"BaseScore": number,
"BaseVector": "string",
"Source": "string",
"Version": "string"
}
],
"EpssScore": number,
"ExploitAvailable": "string",
"FixAvailable": "string",
"Id": "string",
"LastKnownExploitAt": "string",
"ReferenceUrls": [ "string" ],
"RelatedVulnerabilities": [ "string" ],
"Vendor": {
"Name": "string",
"Url": "string",
"VendorCreatedAt": "string",
"VendorSeverity": "string",
"VendorUpdatedAt": "string"
},
"VulnerablePackages": [
{
"Architecture": "string",
"Epoch": "string",
"FilePath": "string",
"FixedInVersion": "string",
"Name": "string",
"PackageManager": "string",
"Release": "string",
"Remediation": "string",
"SourceLayerArn": "string",
"SourceLayerHash": "string",
"Version": "string"
}
]
}
],
"Workflow": {
"Status": "string"
},
"WorkflowState": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Findings](#API_BatchImportFindings_RequestSyntax) **
A list of findings to import. To successfully import a finding, it must follow the [AWS Security Finding Format](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html). Maximum of 100 findings per request.
Type: Array of [AwsSecurityFinding](API_AwsSecurityFinding.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"FailedCount": number,
"FailedFindings": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"Id": "string"
}
],
"SuccessCount": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [FailedCount](#API_BatchImportFindings_ResponseSyntax) **
The number of findings that failed to import.
Type: Integer
** [FailedFindings](#API_BatchImportFindings_ResponseSyntax) **
The list of findings that failed to import.
Type: Array of [ImportFindingsError](API_ImportFindingsError.md) objects
** [SuccessCount](#API_BatchImportFindings_ResponseSyntax) **
The number of findings that were successfully imported.
Type: Integer
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchImportFindings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchImportFindings)
# BatchUpdateAutomationRules
Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
## Request Syntax
```
PATCH /automationrules/update HTTP/1.1
Content-type: application/json
{
"UpdateAutomationRulesRequestItems": [
{
"Actions": [
{
"FindingFieldsUpdate": {
"Confidence": number,
"Criticality": number,
"Note": {
"Text": "string",
"UpdatedBy": "string"
},
"RelatedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Severity": {
"Label": "string",
"Normalized": number,
"Product": number
},
"Types": [ "string" ],
"UserDefinedFields": {
"string" : "string"
},
"VerificationState": "string",
"Workflow": {
"Status": "string"
}
},
"Type": "string"
}
],
"Criteria": {
"AwsAccountId": [
{
"Comparison": "string",
"Value": "string"
}
],
"AwsAccountName": [
{
"Comparison": "string",
"Value": "string"
}
],
"CompanyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceAssociatedStandardsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"Confidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"CreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"Criticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"Description": [
{
"Comparison": "string",
"Value": "string"
}
],
"FirstObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"GeneratorId": [
{
"Comparison": "string",
"Value": "string"
}
],
"Id": [
{
"Comparison": "string",
"Value": "string"
}
],
"LastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteText": [
{
"Comparison": "string",
"Value": "string"
}
],
"NoteUpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteUpdatedBy": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductName": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecordState": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceDetailsOther": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourcePartition": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceRegion": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceTags": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"SeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"SourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"Title": [
{
"Comparison": "string",
"Value": "string"
}
],
"Type": [
{
"Comparison": "string",
"Value": "string"
}
],
"UpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"UserDefinedFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"VerificationState": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowStatus": [
{
"Comparison": "string",
"Value": "string"
}
]
},
"Description": "string",
"IsTerminal": boolean,
"RuleArn": "string",
"RuleName": "string",
"RuleOrder": number,
"RuleStatus": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [UpdateAutomationRulesRequestItems](#API_BatchUpdateAutomationRules_RequestSyntax) **
An array of ARNs for the rules that are to be updated. Optionally, you can also include `RuleStatus` and `RuleOrder`.
Type: Array of [UpdateAutomationRulesRequestItem](API_UpdateAutomationRulesRequestItem.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ProcessedAutomationRules": [ "string" ],
"UnprocessedAutomationRules": [
{
"ErrorCode": number,
"ErrorMessage": "string",
"RuleArn": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ProcessedAutomationRules](#API_BatchUpdateAutomationRules_ResponseSyntax) **
A list of properly processed rule ARNs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern: `.*\S.*`
** [UnprocessedAutomationRules](#API_BatchUpdateAutomationRules_ResponseSyntax) **
A list of objects containing `RuleArn`, `ErrorCode`, and `ErrorMessage`. This parameter tells you which automation rules the request didn't update and why.
Type: Array of [UnprocessedAutomationRule](API_UnprocessedAutomationRule.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchUpdateAutomationRules)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchUpdateAutomationRules)
# BatchUpdateFindings
Used by Security Hub CSPM customers to update information about their investigation into one or more findings. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. A member account can update findings only for their own account. Administrator and member accounts can use this operation to update the following fields and objects for one or more findings:
+ `Confidence`
+ `Criticality`
+ `Note`
+ `RelatedFindings`
+ `Severity`
+ `Types`
+ `UserDefinedFields`
+ `VerificationState`
+ `Workflow`
If you use this operation to update a finding, your updates don’t affect the value for the `UpdatedAt` field of the finding. Also note that it can take several minutes for Security Hub CSPM to process your request and update each finding specified in the request.
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. For more information see [Configuring access to BatchUpdateFindings](https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access) in the * AWS Security Hub CSPM User Guide*.
## Request Syntax
```
PATCH /findings/batchupdate HTTP/1.1
Content-type: application/json
{
"Confidence": number,
"Criticality": number,
"FindingIdentifiers": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Note": {
"Text": "string",
"UpdatedBy": "string"
},
"RelatedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Severity": {
"Label": "string",
"Normalized": number,
"Product": number
},
"Types": [ "string" ],
"UserDefinedFields": {
"string" : "string"
},
"VerificationState": "string",
"Workflow": {
"Status": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Confidence](#API_BatchUpdateFindings_RequestSyntax) **
The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.
Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [Criticality](#API_BatchUpdateFindings_RequestSyntax) **
The updated value for the level of importance assigned to the resources associated with the findings.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** [FindingIdentifiers](#API_BatchUpdateFindings_RequestSyntax) **
The list of findings to update. `BatchUpdateFindings` can be used to update up to 100 findings at a time.
For each finding, the list provides the finding identifier and the ARN of the finding provider.
Type: Array of [AwsSecurityFindingIdentifier](API_AwsSecurityFindingIdentifier.md) objects
Required: Yes
** [Note](#API_BatchUpdateFindings_RequestSyntax) **
The updated note.
Type: [NoteUpdate](API_NoteUpdate.md) object
Required: No
** [RelatedFindings](#API_BatchUpdateFindings_RequestSyntax) **
A list of findings that are related to the updated findings.
Type: Array of [RelatedFinding](API_RelatedFinding.md) objects
Required: No
** [Severity](#API_BatchUpdateFindings_RequestSyntax) **
Used to update the finding severity.
Type: [SeverityUpdate](API_SeverityUpdate.md) object
Required: No
** [Types](#API_BatchUpdateFindings_RequestSyntax) **
One or more finding types in the format of namespace/category/classifier that classify a finding.
Valid namespace values are as follows.
+ Software and Configuration Checks
+ TTPs
+ Effects
+ Unusual Behaviors
+ Sensitive Data Identifications
Type: Array of strings
Pattern: `.*\S.*`
Required: No
** [UserDefinedFields](#API_BatchUpdateFindings_RequestSyntax) **
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
Type: String to string map
Key Pattern: `.*\S.*`
Value Pattern: `.*\S.*`
Required: No
** [VerificationState](#API_BatchUpdateFindings_RequestSyntax) **
Indicates the veracity of a finding.
The available values for `VerificationState` are as follows.
+ `UNKNOWN` – The default disposition of a security finding
+ `TRUE_POSITIVE` – The security finding is confirmed
+ `FALSE_POSITIVE` – The security finding was determined to be a false alarm
+ `BENIGN_POSITIVE` – A special case of `TRUE_POSITIVE` where the finding doesn't pose any threat, is expected, or both
Type: String
Valid Values: `UNKNOWN | TRUE_POSITIVE | FALSE_POSITIVE | BENIGN_POSITIVE`
Required: No
** [Workflow](#API_BatchUpdateFindings_RequestSyntax) **
Used to update the workflow status of a finding.
The workflow status indicates the progress of the investigation into the finding.
Type: [WorkflowUpdate](API_WorkflowUpdate.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ProcessedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"UnprocessedFindings": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"FindingIdentifier": {
"Id": "string",
"ProductArn": "string"
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ProcessedFindings](#API_BatchUpdateFindings_ResponseSyntax) **
The list of findings that were updated successfully.
Type: Array of [AwsSecurityFindingIdentifier](API_AwsSecurityFindingIdentifier.md) objects
** [UnprocessedFindings](#API_BatchUpdateFindings_ResponseSyntax) **
The list of findings that were not updated.
Type: Array of [BatchUpdateFindingsUnprocessedFinding](API_BatchUpdateFindingsUnprocessedFinding.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchUpdateFindings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchUpdateFindings)
# BatchUpdateFindingsV2
Updates information about a customer's investigation into a finding. Delegated administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their own account.
`BatchUpdateFindings` and `BatchUpdateFindingsV2` both use `securityhub:BatchUpdateFindings` in the `Action` element of an IAM policy statement. You must have permission to perform the `securityhub:BatchUpdateFindings` action. You can configure IAM policies to restrict access to specific finding fields or field values by using the `securityhub:OCSFSyntaxPath/` condition key, where `` is one of the following supported fields: `SeverityId`, `StatusId`, or `Comment`.
To prevent a user from updating a specific field, use a `Null` condition with `securityhub:OCSFSyntaxPath/` set to `"false"`. To prevent a user from setting a field to a specific value, use a `StringEquals` condition with `securityhub:OCSFSyntaxPath/` set to the disallowed value or list of values.
Updates from `BatchUpdateFindingsV2` don't affect the value of `finding_info.modified_time`, `finding_info.modified_time_dt`, `time`, or `time_dt` for a finding.
## Request Syntax
```
PATCH /findingsv2/batchupdatev2 HTTP/1.1
Content-type: application/json
{
"Comment": "string",
"FindingIdentifiers": [
{
"CloudAccountUid": "string",
"FindingInfoUid": "string",
"MetadataProductUid": "string"
}
],
"MetadataUids": [ "string" ],
"SeverityId": number,
"StatusId": number
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Comment](#API_BatchUpdateFindingsV2_RequestSyntax) **
The updated value for a user provided comment about the finding. Minimum character length 1. Maximum character length 512.
Type: String
Pattern: `.*\S.*`
Required: No
** [FindingIdentifiers](#API_BatchUpdateFindingsV2_RequestSyntax) **
Provides information to identify a specific V2 finding.
Type: Array of [OcsfFindingIdentifier](API_OcsfFindingIdentifier.md) objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
** [MetadataUids](#API_BatchUpdateFindingsV2_RequestSyntax) **
The list of finding `metadata.uid` to indicate findings to update. Finding `metadata.uid` is a globally unique identifier associated with the finding. Customers cannot use `MetadataUids` together with `FindingIdentifiers`.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Pattern: `.*\S.*`
Required: No
** [SeverityId](#API_BatchUpdateFindingsV2_RequestSyntax) **
The updated value for the normalized severity identifier. The severity ID is an integer with the allowed enum values [0, 1, 2, 3, 4, 5, 6, 99]. When customer provides the updated severity ID, the string sibling severity will automatically be updated in the finding.
Type: Integer
Required: No
** [StatusId](#API_BatchUpdateFindingsV2_RequestSyntax) **
The updated value for the normalized status identifier. The status ID is an integer with the allowed enum values [0, 1, 2, 3, 4, 5, 99]. When customer provides the updated status ID, the string sibling status will automatically be updated in the finding.
Type: Integer
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ProcessedFindings": [
{
"FindingIdentifier": {
"CloudAccountUid": "string",
"FindingInfoUid": "string",
"MetadataProductUid": "string"
},
"MetadataUid": "string"
}
],
"UnprocessedFindings": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"FindingIdentifier": {
"CloudAccountUid": "string",
"FindingInfoUid": "string",
"MetadataProductUid": "string"
},
"MetadataUid": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ProcessedFindings](#API_BatchUpdateFindingsV2_ResponseSyntax) **
The list of findings that were updated successfully.
Type: Array of [BatchUpdateFindingsV2ProcessedFinding](API_BatchUpdateFindingsV2ProcessedFinding.md) objects
** [UnprocessedFindings](#API_BatchUpdateFindingsV2_ResponseSyntax) **
The list of V2 findings that were not updated.
Type: Array of [BatchUpdateFindingsV2UnprocessedFinding](API_BatchUpdateFindingsV2UnprocessedFinding.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchUpdateFindingsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchUpdateFindingsV2)
# BatchUpdateStandardsControlAssociations
For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
## Request Syntax
```
PATCH /associations HTTP/1.1
Content-type: application/json
{
"StandardsControlAssociationUpdates": [
{
"AssociationStatus": "string",
"SecurityControlId": "string",
"StandardsArn": "string",
"UpdatedReason": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [StandardsControlAssociationUpdates](#API_BatchUpdateStandardsControlAssociations_RequestSyntax) **
Updates the enablement status of a security control in a specified standard.
Calls to this operation return a `RESOURCE_NOT_FOUND_EXCEPTION` error when the standard subscription for the control has `StandardsControlsUpdatable` value `NOT_READY_FOR_UPDATES`.
Type: Array of [StandardsControlAssociationUpdate](API_StandardsControlAssociationUpdate.md) objects
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"UnprocessedAssociationUpdates": [
{
"ErrorCode": "string",
"ErrorReason": "string",
"StandardsControlAssociationUpdate": {
"AssociationStatus": "string",
"SecurityControlId": "string",
"StandardsArn": "string",
"UpdatedReason": "string"
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [UnprocessedAssociationUpdates](#API_BatchUpdateStandardsControlAssociations_ResponseSyntax) **
A security control (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters) whose enablement status in a specified standard couldn't be updated.
Type: Array of [UnprocessedStandardsControlAssociationUpdate](API_UnprocessedStandardsControlAssociationUpdate.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations)
# CreateActionTarget
Creates a custom action target in Security Hub CSPM.
You can use custom actions on findings and insights in Security Hub CSPM to trigger target actions in Amazon CloudWatch Events.
## Request Syntax
```
POST /actionTargets HTTP/1.1
Content-type: application/json
{
"Description": "string",
"Id": "string",
"Name": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Description](#API_CreateActionTarget_RequestSyntax) **
The description for the custom action target.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Id](#API_CreateActionTarget_RequestSyntax) **
The ID for the custom action target. Can contain up to 20 alphanumeric characters.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_CreateActionTarget_RequestSyntax) **
The name of the custom action target. Can contain up to 20 characters.
Type: String
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ActionTargetArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ActionTargetArn](#API_CreateActionTarget_ResponseSyntax) **
The Amazon Resource Name (ARN) for the custom action target.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateActionTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateActionTarget)
# CreateAggregatorV2
Enables aggregation across AWS Regions.
## Request Syntax
```
POST /aggregatorv2/create HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"LinkedRegions": [ "string" ],
"RegionLinkingMode": "string",
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ClientToken](#API_CreateAggregatorV2_RequestSyntax) **
A unique identifier used to ensure idempotency.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[\x21-\x7E]{1,64}$`
Required: No
** [LinkedRegions](#API_CreateAggregatorV2_RequestSyntax) **
The list of Regions that are linked to the aggregation Region.
Type: Array of strings
Pattern: `.*\S.*`
Required: No
** [RegionLinkingMode](#API_CreateAggregatorV2_RequestSyntax) **
Determines how Regions are linked to an Aggregator V2.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Tags](#API_CreateAggregatorV2_RequestSyntax) **
A list of key-value pairs to be applied to the AggregatorV2.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AggregationRegion": "string",
"AggregatorV2Arn": "string",
"LinkedRegions": [ "string" ],
"RegionLinkingMode": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AggregationRegion](#API_CreateAggregatorV2_ResponseSyntax) **
The AWS Region where data is aggregated.
Type: String
Pattern: `.*\S.*`
** [AggregatorV2Arn](#API_CreateAggregatorV2_ResponseSyntax) **
The ARN of the AggregatorV2.
Type: String
Pattern: `.*\S.*`
** [LinkedRegions](#API_CreateAggregatorV2_ResponseSyntax) **
The list of Regions that are linked to the aggregation Region.
Type: Array of strings
Pattern: `.*\S.*`
** [RegionLinkingMode](#API_CreateAggregatorV2_ResponseSyntax) **
Determines how Regions are linked to an Aggregator V2.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request was rejected because it would exceed the service quota limit.
HTTP Status Code: 402
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateAggregatorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateAggregatorV2)
# CreateAutomationRule
Creates an automation rule based on input parameters.
## Request Syntax
```
POST /automationrules/create HTTP/1.1
Content-type: application/json
{
"Actions": [
{
"FindingFieldsUpdate": {
"Confidence": number,
"Criticality": number,
"Note": {
"Text": "string",
"UpdatedBy": "string"
},
"RelatedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Severity": {
"Label": "string",
"Normalized": number,
"Product": number
},
"Types": [ "string" ],
"UserDefinedFields": {
"string" : "string"
},
"VerificationState": "string",
"Workflow": {
"Status": "string"
}
},
"Type": "string"
}
],
"Criteria": {
"AwsAccountId": [
{
"Comparison": "string",
"Value": "string"
}
],
"AwsAccountName": [
{
"Comparison": "string",
"Value": "string"
}
],
"CompanyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceAssociatedStandardsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"Confidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"CreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"Criticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"Description": [
{
"Comparison": "string",
"Value": "string"
}
],
"FirstObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"GeneratorId": [
{
"Comparison": "string",
"Value": "string"
}
],
"Id": [
{
"Comparison": "string",
"Value": "string"
}
],
"LastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteText": [
{
"Comparison": "string",
"Value": "string"
}
],
"NoteUpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteUpdatedBy": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductName": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecordState": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceDetailsOther": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourcePartition": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceRegion": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceTags": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"SeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"SourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"Title": [
{
"Comparison": "string",
"Value": "string"
}
],
"Type": [
{
"Comparison": "string",
"Value": "string"
}
],
"UpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"UserDefinedFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"VerificationState": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowStatus": [
{
"Comparison": "string",
"Value": "string"
}
]
},
"Description": "string",
"IsTerminal": boolean,
"RuleName": "string",
"RuleOrder": number,
"RuleStatus": "string",
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Actions](#API_CreateAutomationRule_RequestSyntax) **
One or more actions to update finding fields if a finding matches the conditions specified in `Criteria`.
Type: Array of [AutomationRulesAction](API_AutomationRulesAction.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** [Criteria](#API_CreateAutomationRule_RequestSyntax) **
A set of ASFF finding field attributes and corresponding expected values that Security Hub CSPM uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub CSPM applies the rule action to the finding.
Type: [AutomationRulesFindingFilters](API_AutomationRulesFindingFilters.md) object
Required: Yes
** [Description](#API_CreateAutomationRule_RequestSyntax) **
A description of the rule.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [IsTerminal](#API_CreateAutomationRule_RequestSyntax) **
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub CSPM applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
Type: Boolean
Required: No
** [RuleName](#API_CreateAutomationRule_RequestSyntax) **
The name of the rule.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [RuleOrder](#API_CreateAutomationRule_RequestSyntax) **
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub CSPM applies rules with lower values for this parameter first.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: Yes
** [RuleStatus](#API_CreateAutomationRule_RequestSyntax) **
Whether the rule is active after it is created. If this parameter is equal to `ENABLED`, Security Hub CSPM starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use [https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html).
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
** [Tags](#API_CreateAutomationRule_RequestSyntax) **
User-defined tags associated with an automation rule.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"RuleArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RuleArn](#API_CreateAutomationRule_ResponseSyntax) **
The Amazon Resource Name (ARN) of the automation rule that you created.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateAutomationRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateAutomationRule)
# CreateAutomationRuleV2
Creates a V2 automation rule.
## Request Syntax
```
POST /automationrulesv2/create HTTP/1.1
Content-type: application/json
{
"Actions": [
{
"ExternalIntegrationConfiguration": {
"ConnectorArn": "string"
},
"FindingFieldsUpdate": {
"Comment": "string",
"SeverityId": number,
"StatusId": number
},
"Type": "string"
}
],
"ClientToken": "string",
"Criteria": { ... },
"Description": "string",
"RuleName": "string",
"RuleOrder": number,
"RuleStatus": "string",
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Actions](#API_CreateAutomationRuleV2_RequestSyntax) **
A list of actions to be performed when the rule criteria is met.
Type: Array of [AutomationRulesActionV2](API_AutomationRulesActionV2.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** [ClientToken](#API_CreateAutomationRuleV2_RequestSyntax) **
A unique identifier used to ensure idempotency.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[\x21-\x7E]{1,64}$`
Required: No
** [Criteria](#API_CreateAutomationRuleV2_RequestSyntax) **
The filtering type and configuration of the automation rule.
Type: [Criteria](API_Criteria.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [Description](#API_CreateAutomationRuleV2_RequestSyntax) **
A description of the V2 automation rule.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [RuleName](#API_CreateAutomationRuleV2_RequestSyntax) **
The name of the V2 automation rule.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [RuleOrder](#API_CreateAutomationRuleV2_RequestSyntax) **
The value for the rule priority.
Type: Float
Valid Range: Minimum value of 1.0. Maximum value of 1000.0.
Required: Yes
** [RuleStatus](#API_CreateAutomationRuleV2_RequestSyntax) **
The status of the V2 automation rule.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
** [Tags](#API_CreateAutomationRuleV2_RequestSyntax) **
A list of key-value pairs associated with the V2 automation rule.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"RuleArn": "string",
"RuleId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RuleArn](#API_CreateAutomationRuleV2_ResponseSyntax) **
The ARN of the V2 automation rule.
Type: String
Pattern: `.*\S.*`
** [RuleId](#API_CreateAutomationRuleV2_ResponseSyntax) **
The ID of the V2 automation rule.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ServiceQuotaExceededException **
The request was rejected because it would exceed the service quota limit.
HTTP Status Code: 402
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateAutomationRuleV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateAutomationRuleV2)
# CreateConfigurationPolicy
Creates a configuration policy with the defined configuration. Only the AWS Security Hub CSPM delegated administrator can invoke this operation from the home Region.
## Request Syntax
```
POST /configurationPolicy/create HTTP/1.1
Content-type: application/json
{
"ConfigurationPolicy": { ... },
"Description": "string",
"Name": "string",
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ConfigurationPolicy](#API_CreateConfigurationPolicy_RequestSyntax) **
An object that defines how Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls).
Type: [Policy](API_Policy.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [Description](#API_CreateConfigurationPolicy_RequestSyntax) **
The description of the configuration policy.
Type: String
Pattern: `.*\S.*`
Required: No
** [Name](#API_CreateConfigurationPolicy_RequestSyntax) **
The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted: `-, ., !, *, /`.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Tags](#API_CreateConfigurationPolicy_RequestSyntax) **
User-defined tags associated with a configuration policy. For more information, see [Tagging AWS Security Hub CSPM resources](https://docs.aws.amazon.com/securityhub/latest/userguide/tagging-resources.html) in the *Security Hub CSPM user guide*.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"ConfigurationPolicy": { ... },
"CreatedAt": "string",
"Description": "string",
"Id": "string",
"Name": "string",
"UpdatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Arn](#API_CreateConfigurationPolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [ConfigurationPolicy](#API_CreateConfigurationPolicy_ResponseSyntax) **
An object that defines how Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the request included a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If the request included a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls).
Type: [Policy](API_Policy.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [CreatedAt](#API_CreateConfigurationPolicy_ResponseSyntax) **
The date and time, in UTC and ISO 8601 format, that the configuration policy was created.
Type: Timestamp
** [Description](#API_CreateConfigurationPolicy_ResponseSyntax) **
The description of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [Id](#API_CreateConfigurationPolicy_ResponseSyntax) **
The universally unique identifier (UUID) of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [Name](#API_CreateConfigurationPolicy_ResponseSyntax) **
The name of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [UpdatedAt](#API_CreateConfigurationPolicy_ResponseSyntax) **
The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateConfigurationPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateConfigurationPolicy)
# CreateConnectorV2
Grants permission to create a connectorV2 based on input parameters.
## Request Syntax
```
POST /connectorsv2 HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"Description": "string",
"KmsKeyArn": "string",
"Name": "string",
"Provider": { ... },
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ClientToken](#API_CreateConnectorV2_RequestSyntax) **
A unique identifier used to ensure idempotency.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[\x21-\x7E]{1,64}$`
Required: No
** [Description](#API_CreateConnectorV2_RequestSyntax) **
The description of the connectorV2.
Type: String
Pattern: `.*\S.*`
Required: No
** [KmsKeyArn](#API_CreateConnectorV2_RequestSyntax) **
The Amazon Resource Name (ARN) of KMS key used to encrypt secrets for the connectorV2.
Type: String
Pattern: `.*\S.*`
Required: No
** [Name](#API_CreateConnectorV2_RequestSyntax) **
The unique name of the connectorV2.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Provider](#API_CreateConnectorV2_RequestSyntax) **
The third-party provider’s service configuration.
Type: [ProviderConfiguration](API_ProviderConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [Tags](#API_CreateConnectorV2_RequestSyntax) **
The tags to add to the connectorV2 when you create.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AuthUrl": "string",
"ConnectorArn": "string",
"ConnectorId": "string",
"ConnectorStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AuthUrl](#API_CreateConnectorV2_ResponseSyntax) **
The Url provide to customers for OAuth auth code flow.
Type: String
Pattern: `.*\S.*`
** [ConnectorArn](#API_CreateConnectorV2_ResponseSyntax) **
The Amazon Resource Name (ARN) of the connectorV2.
Type: String
Pattern: `.*\S.*`
** [ConnectorId](#API_CreateConnectorV2_ResponseSyntax) **
The UUID of the connectorV2 to identify connectorV2 resource.
Type: String
Pattern: `.*\S.*`
** [ConnectorStatus](#API_CreateConnectorV2_ResponseSyntax) **
The current status of the connectorV2.
Type: String
Valid Values: `CONNECTED | FAILED_TO_CONNECT | PENDING_CONFIGURATION | PENDING_AUTHORIZATION`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request was rejected because it would exceed the service quota limit.
HTTP Status Code: 402
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateConnectorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateConnectorV2)
# CreateFindingAggregator
**Note**
The *aggregation Region* is now called the *home Region*.
Used to enable cross-Region aggregation. This operation can be invoked from the home Region only.
For information about how cross-Region aggregation works, see [Understanding cross-Region aggregation in Security Hub CSPM](https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html) in the * AWS Security Hub CSPM User Guide*.
## Request Syntax
```
POST /findingAggregator/create HTTP/1.1
Content-type: application/json
{
"RegionLinkingMode": "string",
"Regions": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [RegionLinkingMode](#API_CreateFindingAggregator_RequestSyntax) **
Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub CSPM supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
+ `ALL_REGIONS` - Aggregates findings from all of the Regions where Security Hub CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.
+ `ALL_REGIONS_EXCEPT_SPECIFIED` - Aggregates findings from all of the Regions where Security Hub CSPM is enabled, except for the Regions listed in the `Regions` parameter. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.
+ `SPECIFIED_REGIONS` - Aggregates findings only from the Regions listed in the `Regions` parameter. Security Hub CSPM does not automatically aggregate findings from new Regions.
+ `NO_REGIONS` - Aggregates no data because no Regions are selected as linked Regions.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Regions](#API_CreateFindingAggregator_RequestSyntax) **
If `RegionLinkingMode` is `ALL_REGIONS_EXCEPT_SPECIFIED`, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.
If `RegionLinkingMode` is `SPECIFIED_REGIONS`, then this is a space-separated list of Regions that do replicate and send findings to the home Region.
An `InvalidInputException` error results if you populate this field while `RegionLinkingMode` is `NO_REGIONS`.
Type: Array of strings
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"FindingAggregationRegion": "string",
"FindingAggregatorArn": "string",
"RegionLinkingMode": "string",
"Regions": [ "string" ]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [FindingAggregationRegion](#API_CreateFindingAggregator_ResponseSyntax) **
The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
Type: String
Pattern: `.*\S.*`
** [FindingAggregatorArn](#API_CreateFindingAggregator_ResponseSyntax) **
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop cross-Region aggregation.
Type: String
Pattern: `.*\S.*`
** [RegionLinkingMode](#API_CreateFindingAggregator_ResponseSyntax) **
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
Type: String
Pattern: `.*\S.*`
** [Regions](#API_CreateFindingAggregator_ResponseSyntax) **
The list of excluded Regions or included Regions.
Type: Array of strings
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateFindingAggregator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateFindingAggregator)
# CreateInsight
Creates a custom insight in Security Hub CSPM. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.
To group the related findings in the insight, use the `GroupByAttribute`.
## Request Syntax
```
POST /insights HTTP/1.1
Content-type: application/json
{
"Filters": {
"AwsAccountId": [
{
"Comparison": "string",
"Value": "string"
}
],
"AwsAccountName": [
{
"Comparison": "string",
"Value": "string"
}
],
"CompanyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceAssociatedStandardsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"Confidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"CreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"Criticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"Description": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsConfidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsCriticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsRelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsRelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityOriginal": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsTypes": [
{
"Comparison": "string",
"Value": "string"
}
],
"FirstObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"GeneratorId": [
{
"Comparison": "string",
"Value": "string"
}
],
"Id": [
{
"Comparison": "string",
"Value": "string"
}
],
"Keyword": [
{
"Value": "string"
}
],
"LastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"MalwareName": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwarePath": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareState": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareType": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationIpV4": [
{
"Cidr": "string"
}
],
"NetworkDestinationIpV6": [
{
"Cidr": "string"
}
],
"NetworkDestinationPort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NetworkDirection": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkProtocol": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceIpV4": [
{
"Cidr": "string"
}
],
"NetworkSourceIpV6": [
{
"Cidr": "string"
}
],
"NetworkSourceMac": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourcePort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NoteText": [
{
"Comparison": "string",
"Value": "string"
}
],
"NoteUpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteUpdatedBy": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProcessName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessParentPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessPath": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessTerminatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ProductName": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecommendationText": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecordState": [
{
"Comparison": "string",
"Value": "string"
}
],
"Region": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIamInstanceProfileArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIpV4Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceIpV6Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceKeyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsEc2InstanceSubnetId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceVpcId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyCreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsIamAccessKeyPrincipalName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamUserUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceContainerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceDetailsOther": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourcePartition": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceRegion": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceTags": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"Sample": [
{
"Value": boolean
}
],
"SeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"SeverityNormalized": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SeverityProduct": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorCategory": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorLastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ThreatIntelIndicatorSource": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorSourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"Title": [
{
"Comparison": "string",
"Value": "string"
}
],
"Type": [
{
"Comparison": "string",
"Value": "string"
}
],
"UpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"UserDefinedFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"VerificationState": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesExploitAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesFixAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowState": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowStatus": [
{
"Comparison": "string",
"Value": "string"
}
]
},
"GroupByAttribute": "string",
"Name": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Filters](#API_CreateInsight_RequestSyntax) **
One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.
Type: [AwsSecurityFindingFilters](API_AwsSecurityFindingFilters.md) object
Required: Yes
** [GroupByAttribute](#API_CreateInsight_RequestSyntax) **
The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Name](#API_CreateInsight_RequestSyntax) **
The name of the custom insight to create.
Type: String
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"InsightArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [InsightArn](#API_CreateInsight_ResponseSyntax) **
The ARN of the insight created.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateInsight)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateInsight)
# CreateMembers
Creates a member association in Security Hub CSPM between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
`CreateMembers` is always used to add accounts that are not organization members.
For accounts that are managed using Organizations, `CreateMembers` is only used in the following cases:
+ Security Hub CSPM is not configured to automatically add new organization accounts.
+ The account was disassociated or deleted in Security Hub CSPM.
This action can only be used by an account that has Security Hub CSPM enabled. To enable Security Hub CSPM, you can use the `EnableSecurityHub` operation.
For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the `InviteMembers` operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub CSPM.
Accounts that are managed using Organizations don't receive an invitation. They automatically become a member account in Security Hub CSPM.
+ If the organization account does not have Security Hub CSPM enabled, then Security Hub CSPM and the default standards are automatically enabled. Note that Security Hub CSPM cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub CSPM before the administrator account enables it as a member account.
+ For organization accounts that already have Security Hub CSPM enabled, Security Hub CSPM does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member accounts, use the `DisassociateFromMasterAccount` or `DisassociateMembers` operation.
## Request Syntax
```
POST /members HTTP/1.1
Content-type: application/json
{
"AccountDetails": [
{
"AccountId": "string",
"Email": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AccountDetails](#API_CreateMembers_RequestSyntax) **
The list of accounts to associate with the Security Hub CSPM administrator account. For each account, the list includes the account ID and optionally the email address.
Type: Array of [AccountDetails](API_AccountDetails.md) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"UnprocessedAccounts": [
{
"AccountId": "string",
"ProcessingResult": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [UnprocessedAccounts](#API_CreateMembers_ResponseSyntax) **
The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.
Type: Array of [Result](API_Result.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateMembers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateMembers)
# CreateTicketV2
Grants permission to create a ticket in the chosen ITSM based on finding information for the provided finding metadata UID.
## Request Syntax
```
POST /ticketsv2 HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"ConnectorId": "string",
"FindingMetadataUid": "string",
"Mode": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ClientToken](#API_CreateTicketV2_RequestSyntax) **
The client idempotency token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[\x21-\x7E]{1,64}$`
Required: No
** [ConnectorId](#API_CreateTicketV2_RequestSyntax) **
The UUID of the connectorV2 to identify connectorV2 resource.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [FindingMetadataUid](#API_CreateTicketV2_RequestSyntax) **
The the unique ID for the finding.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Mode](#API_CreateTicketV2_RequestSyntax) **
The mode for ticket creation. When set to DRYRUN, the ticket is created using a Security Hub owned template test finding to verify the integration is working correctly.
Type: String
Valid Values: `DRYRUN`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"TicketId": "string",
"TicketSrcUrl": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TicketId](#API_CreateTicketV2_ResponseSyntax) **
The ID for the ticketv2.
Type: String
Pattern: `.*\S.*`
** [TicketSrcUrl](#API_CreateTicketV2_ResponseSyntax) **
The url to the created ticket.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/CreateTicketV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/CreateTicketV2)
# DeclineInvitations
**Note**
We recommend using AWS Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see [Managing Security Hub CSPM administrator and member accounts with Organizations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html) in the * AWS Security Hub CSPM User Guide*.
Declines invitations to become a Security Hub CSPM member account.
A prospective member account uses this operation to decline an invitation to become a member.
Only member accounts that aren't part of an AWS organization should use this operation. Organization accounts don't receive invitations.
## Request Syntax
```
POST /invitations/decline HTTP/1.1
Content-type: application/json
{
"AccountIds": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AccountIds](#API_DeclineInvitations_RequestSyntax) **
The list of prospective member account IDs for which to decline an invitation.
Type: Array of strings
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"UnprocessedAccounts": [
{
"AccountId": "string",
"ProcessingResult": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [UnprocessedAccounts](#API_DeclineInvitations_ResponseSyntax) **
The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.
Type: Array of [Result](API_Result.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeclineInvitations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeclineInvitations)
# DeleteActionTarget
Deletes a custom action target from Security Hub CSPM.
Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.
## Request Syntax
```
DELETE /actionTargets/ActionTargetArn+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ActionTargetArn](#API_DeleteActionTarget_RequestSyntax) **
The Amazon Resource Name (ARN) of the custom action target to delete.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ActionTargetArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ActionTargetArn](#API_DeleteActionTarget_ResponseSyntax) **
The ARN of the custom action target that was deleted.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteActionTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteActionTarget)
# DeleteAggregatorV2
Deletes the Aggregator V2.
## Request Syntax
```
DELETE /aggregatorv2/delete/AggregatorV2Arn+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [AggregatorV2Arn](#API_DeleteAggregatorV2_RequestSyntax) **
The ARN of the Aggregator V2.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteAggregatorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteAggregatorV2)
# DeleteAutomationRuleV2
Deletes a V2 automation rule.
## Request Syntax
```
DELETE /automationrulesv2/Identifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [Identifier](#API_DeleteAutomationRuleV2_RequestSyntax) **
The ARN of the V2 automation rule.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteAutomationRuleV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteAutomationRuleV2)
# DeleteConfigurationPolicy
Deletes a configuration policy. Only the AWS Security Hub CSPM delegated administrator can invoke this operation from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, organizational units, or the root by invoking the `StartConfigurationPolicyDisassociation` operation.
## Request Syntax
```
DELETE /configurationPolicy/Identifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [Identifier](#API_DeleteConfigurationPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteConfigurationPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteConfigurationPolicy)
# DeleteConnectorV2
Grants permission to delete a connectorV2.
## Request Syntax
```
DELETE /connectorsv2/ConnectorId+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ConnectorId](#API_DeleteConnectorV2_RequestSyntax) **
The UUID of the connectorV2 to identify connectorV2 resource.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteConnectorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteConnectorV2)
# DeleteFindingAggregator
**Note**
The *aggregation Region* is now called the *home Region*.
Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops occurring from the linked Regions to the home Region.
When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region.
## Request Syntax
```
DELETE /findingAggregator/delete/FindingAggregatorArn+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [FindingAggregatorArn](#API_DeleteFindingAggregator_RequestSyntax) **
The ARN of the finding aggregator to delete. To obtain the ARN, use `ListFindingAggregators`.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteFindingAggregator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteFindingAggregator)
# DeleteInsight
Deletes the insight specified by the `InsightArn`.
## Request Syntax
```
DELETE /insights/InsightArn+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [InsightArn](#API_DeleteInsight_RequestSyntax) **
The ARN of the insight to delete.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"InsightArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [InsightArn](#API_DeleteInsight_ResponseSyntax) **
The ARN of the insight that was deleted.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteInsight)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteInsight)
# DeleteInvitations
**Note**
We recommend using AWS Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see [Managing Security Hub CSPM administrator and member accounts with Organizations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html) in the * AWS Security Hub CSPM User Guide*.
Deletes invitations to become a Security Hub CSPM member account.
A Security Hub CSPM administrator account can use this operation to delete invitations sent to one or more prospective member accounts.
This operation is only used to delete invitations that are sent to prospective member accounts that aren't part of an AWS organization. Organization accounts don't receive invitations.
## Request Syntax
```
POST /invitations/delete HTTP/1.1
Content-type: application/json
{
"AccountIds": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AccountIds](#API_DeleteInvitations_RequestSyntax) **
The list of member account IDs that received the invitations you want to delete.
Type: Array of strings
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"UnprocessedAccounts": [
{
"AccountId": "string",
"ProcessingResult": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [UnprocessedAccounts](#API_DeleteInvitations_ResponseSyntax) **
The list of AWS accounts for which the invitations were not deleted. For each account, the list includes the account ID and the email address.
Type: Array of [Result](API_Result.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteInvitations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteInvitations)
# DeleteMembers
Deletes the specified member accounts from Security Hub CSPM.
You can invoke this API only to delete accounts that became members through invitation. You can't invoke this API to delete accounts that belong to an AWS Organizations organization.
## Request Syntax
```
POST /members/delete HTTP/1.1
Content-type: application/json
{
"AccountIds": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AccountIds](#API_DeleteMembers_RequestSyntax) **
The list of account IDs for the member accounts to delete.
Type: Array of strings
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"UnprocessedAccounts": [
{
"AccountId": "string",
"ProcessingResult": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [UnprocessedAccounts](#API_DeleteMembers_ResponseSyntax) **
The list of AWS accounts that were not deleted. For each account, the list includes the account ID and the email address.
Type: Array of [Result](API_Result.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DeleteMembers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DeleteMembers)
# DescribeActionTargets
Returns a list of the custom action targets in Security Hub CSPM in your account.
## Request Syntax
```
POST /actionTargets/get HTTP/1.1
Content-type: application/json
{
"ActionTargetArns": [ "string" ],
"MaxResults": number,
"NextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ActionTargetArns](#API_DescribeActionTargets_RequestSyntax) **
A list of custom action target ARNs for the custom action targets to retrieve.
Type: Array of strings
Pattern: `.*\S.*`
Required: No
** [MaxResults](#API_DescribeActionTargets_RequestSyntax) **
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_DescribeActionTargets_RequestSyntax) **
The token that is required for pagination. On your first call to the `DescribeActionTargets` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ActionTargets": [
{
"ActionTargetArn": "string",
"Description": "string",
"Name": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ActionTargets](#API_DescribeActionTargets_ResponseSyntax) **
A list of `ActionTarget` objects. Each object includes the `ActionTargetArn`, `Description`, and `Name` of a custom action target available in Security Hub CSPM.
Type: Array of [ActionTarget](API_ActionTarget.md) objects
** [NextToken](#API_DescribeActionTargets_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DescribeActionTargets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DescribeActionTargets)
# DescribeHub
Returns details about the Hub resource in your account, including the `HubArn` and the time when you enabled Security Hub CSPM.
## Request Syntax
```
GET /accounts?HubArn=HubArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [HubArn](#API_DescribeHub_RequestSyntax) **
The ARN of the Hub resource to retrieve.
Pattern: `.*\S.*`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AutoEnableControls": boolean,
"ControlFindingGenerator": "string",
"HubArn": "string",
"SubscribedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AutoEnableControls](#API_DescribeHub_ResponseSyntax) **
Whether to automatically enable new controls when they are added to standards that are enabled.
If set to `true`, then new controls for enabled standards are enabled automatically. If set to `false`, then new controls are not enabled.
When you automatically enable new controls, you can interact with the controls in the console and programmatically immediately after release. However, automatically enabled controls have a temporary default status of `DISABLED`. It can take up to several days for Security Hub CSPM to process the control release and designate the control as `ENABLED` in your account. During the processing period, you can manually enable or disable a control, and Security Hub CSPM will maintain that designation regardless of whether you have `AutoEnableControls` set to `true`.
Type: Boolean
** [ControlFindingGenerator](#API_DescribeHub_ResponseSyntax) **
Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to `SECURITY_CONTROL`, Security Hub CSPM generates a single finding for a control check even when the check applies to multiple enabled standards.
If the value for this field is set to `STANDARD_CONTROL`, Security Hub CSPM generates separate findings for a control check when the check applies to multiple enabled standards.
The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is `SECURITY_CONTROL` if you enabled Security Hub CSPM on or after February 23, 2023.
Type: String
Valid Values: `STANDARD_CONTROL | SECURITY_CONTROL`
** [HubArn](#API_DescribeHub_ResponseSyntax) **
The ARN of the Hub resource that was retrieved.
Type: String
Pattern: `.*\S.*`
** [SubscribedAt](#API_DescribeHub_ResponseSyntax) **
The date and time when Security Hub CSPM was enabled in the account.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DescribeHub)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DescribeHub)
# DescribeOrganizationConfiguration
Returns information about the way your organization is configured in AWS Security Hub CSPM. Only the Security Hub CSPM administrator account can invoke this operation.
## Request Syntax
```
GET /organization/configuration HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AutoEnable": boolean,
"AutoEnableStandards": "string",
"MemberAccountLimitReached": boolean,
"OrganizationConfiguration": {
"ConfigurationType": "string",
"Status": "string",
"StatusMessage": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AutoEnable](#API_DescribeOrganizationConfiguration_ResponseSyntax) **
Whether to automatically enable Security Hub CSPM in new member accounts when they join the organization.
If set to `true`, then Security Hub CSPM is automatically enabled in new accounts. If set to `false`, then Security Hub CSPM isn't enabled in new accounts automatically. The default value is `false`.
If the `ConfigurationType` of your organization is set to `CENTRAL`, then this field is set to `false` and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub CSPM is enabled and associate the policy with new organization accounts.
Type: Boolean
** [AutoEnableStandards](#API_DescribeOrganizationConfiguration_ResponseSyntax) **
Whether to automatically enable Security Hub CSPM [default standards](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html) in new member accounts when they join the organization.
If equal to `DEFAULT`, then Security Hub CSPM default standards are automatically enabled for new member accounts. If equal to `NONE`, then default standards are not automatically enabled for new member accounts. The default value of this parameter is equal to `DEFAULT`.
If the `ConfigurationType` of your organization is set to `CENTRAL`, then this field is set to `NONE` and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.
Type: String
Valid Values: `NONE | DEFAULT`
** [MemberAccountLimitReached](#API_DescribeOrganizationConfiguration_ResponseSyntax) **
Whether the maximum number of allowed member accounts are already associated with the Security Hub CSPM administrator account.
Type: Boolean
** [OrganizationConfiguration](#API_DescribeOrganizationConfiguration_ResponseSyntax) **
Provides information about the way an organization is configured in AWS Security Hub CSPM.
Type: [OrganizationConfiguration](API_OrganizationConfiguration.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DescribeOrganizationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DescribeOrganizationConfiguration)
# DescribeProducts
Returns information about product integrations in Security Hub CSPM.
You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.
If you don't provide an integration ARN, then the results include all of the available product integrations.
## Request Syntax
```
GET /products?MaxResults=MaxResults&NextToken=NextToken&ProductArn=ProductArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_DescribeProducts_RequestSyntax) **
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_DescribeProducts_RequestSyntax) **
The token that is required for pagination. On your first call to the `DescribeProducts` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
** [ProductArn](#API_DescribeProducts_RequestSyntax) **
The ARN of the integration to return.
Pattern: `.*\S.*`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Products": [
{
"ActivationUrl": "string",
"Categories": [ "string" ],
"CompanyName": "string",
"Description": "string",
"IntegrationTypes": [ "string" ],
"MarketplaceUrl": "string",
"ProductArn": "string",
"ProductName": "string",
"ProductSubscriptionResourcePolicy": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_DescribeProducts_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
** [Products](#API_DescribeProducts_ResponseSyntax) **
A list of products, including details for each product.
Type: Array of [Product](API_Product.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DescribeProducts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DescribeProducts)
# DescribeProductsV2
Gets information about the product integration.
## Request Syntax
```
GET /productsV2?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_DescribeProductsV2_RequestSyntax) **
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_DescribeProductsV2_RequestSyntax) **
The token required for pagination. On your first call, set the value of this parameter to `NULL`. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"ProductsV2": [
{
"ActivationUrl": "string",
"Categories": [ "string" ],
"CompanyName": "string",
"Description": "string",
"IntegrationV2Types": [ "string" ],
"MarketplaceProductId": "string",
"MarketplaceUrl": "string",
"ProductV2Name": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_DescribeProductsV2_ResponseSyntax) **
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Type: String
** [ProductsV2](#API_DescribeProductsV2_ResponseSyntax) **
Gets information about the product integration.
Type: Array of [ProductV2](API_ProductV2.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DescribeProductsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DescribeProductsV2)
# DescribeSecurityHubV2
Returns details about the service resource in your account.
## Request Syntax
```
GET /hubv2 HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"HubV2Arn": "string",
"SubscribedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [HubV2Arn](#API_DescribeSecurityHubV2_ResponseSyntax) **
The ARN of the service resource.
Type: String
Pattern: `.*\S.*`
** [SubscribedAt](#API_DescribeSecurityHubV2_ResponseSyntax) **
The date and time when the service was enabled in the account.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DescribeSecurityHubV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DescribeSecurityHubV2)
# DescribeStandards
Returns a list of the available standards in Security Hub CSPM.
For each standard, the results include the standard ARN, the name, and a description.
## Request Syntax
```
GET /standards?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_DescribeStandards_RequestSyntax) **
The maximum number of standards to return.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_DescribeStandards_RequestSyntax) **
The token that is required for pagination. On your first call to the `DescribeStandards` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Standards": [
{
"Description": "string",
"EnabledByDefault": boolean,
"Name": "string",
"StandardsArn": "string",
"StandardsManagedBy": {
"Company": "string",
"Product": "string"
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_DescribeStandards_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
** [Standards](#API_DescribeStandards_ResponseSyntax) **
A list of available standards.
Type: Array of [Standard](API_Standard.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DescribeStandards)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DescribeStandards)
# DescribeStandardsControls
Returns a list of security standards controls.
For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.
This operation returns an empty list for standard subscriptions where `StandardsControlsUpdatable` has value `NOT_READY_FOR_UPDATES`.
## Request Syntax
```
GET /standards/controls/StandardsSubscriptionArn+?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_DescribeStandardsControls_RequestSyntax) **
The maximum number of security standard controls to return.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_DescribeStandardsControls_RequestSyntax) **
The token that is required for pagination. On your first call to the `DescribeStandardsControls` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
** [StandardsSubscriptionArn](#API_DescribeStandardsControls_RequestSyntax) **
The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the `GetEnabledStandards` operation.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Controls": [
{
"ControlId": "string",
"ControlStatus": "string",
"ControlStatusUpdatedAt": "string",
"Description": "string",
"DisabledReason": "string",
"RelatedRequirements": [ "string" ],
"RemediationUrl": "string",
"SeverityRating": "string",
"StandardsControlArn": "string",
"Title": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Controls](#API_DescribeStandardsControls_ResponseSyntax) **
A list of security standards controls.
Type: Array of [StandardsControl](API_StandardsControl.md) objects
** [NextToken](#API_DescribeStandardsControls_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DescribeStandardsControls)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DescribeStandardsControls)
# DisableImportFindingsForProduct
Disables the integration of the specified product with Security Hub CSPM. After the integration is disabled, findings from that product are no longer sent to Security Hub CSPM.
## Request Syntax
```
DELETE /productSubscriptions/ProductSubscriptionArn+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ProductSubscriptionArn](#API_DisableImportFindingsForProduct_RequestSyntax) **
The ARN of the integrated product to disable the integration for.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DisableImportFindingsForProduct)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DisableImportFindingsForProduct)
# DisableOrganizationAdminAccount
Disables a Security Hub CSPM administrator account. Can only be called by the organization management account.
## Request Syntax
```
POST /organization/admin/disable HTTP/1.1
Content-type: application/json
{
"AdminAccountId": "string",
"Feature": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AdminAccountId](#API_DisableOrganizationAdminAccount_RequestSyntax) **
The AWS account identifier of the Security Hub CSPM administrator account.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Feature](#API_DisableOrganizationAdminAccount_RequestSyntax) **
The feature for which the delegated admin account is disabled. Defaults to Security Hub CSPM if not specified.
Type: String
Valid Values: `SecurityHub | SecurityHubV2`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DisableOrganizationAdminAccount)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DisableOrganizationAdminAccount)
# DisableSecurityHub
Disables Security Hub CSPM in your account only in the current AWS Region. To disable Security Hub CSPM in all Regions, you must submit one request per Region where you have enabled Security Hub CSPM.
You can't disable Security Hub CSPM in an account that is currently the Security Hub CSPM administrator.
When you disable Security Hub CSPM, your existing findings and insights and any Security Hub CSPM configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed.
If you want to save your existing findings, you must export them before you disable Security Hub CSPM.
## Request Syntax
```
DELETE /accounts HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DisableSecurityHub)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DisableSecurityHub)
# DisableSecurityHubV2
Disable the service for the current AWS Region or specified AWS Region.
## Request Syntax
```
DELETE /hubv2 HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DisableSecurityHubV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DisableSecurityHubV2)
# DisassociateFromAdministratorAccount
Disassociates the current Security Hub CSPM member account from the associated administrator account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
## Request Syntax
```
POST /administrator/disassociate HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DisassociateFromAdministratorAccount)
# DisassociateFromMasterAccount
This method is deprecated. Instead, use `DisassociateFromAdministratorAccount`.
The Security Hub CSPM console continues to use `DisassociateFromMasterAccount`. It will eventually change to use `DisassociateFromAdministratorAccount`. Any IAM policies that specifically control access to this function must continue to use `DisassociateFromMasterAccount`. You should also add `DisassociateFromAdministratorAccount` to your policies to ensure that the correct permissions are in place after the console begins to use `DisassociateFromAdministratorAccount`.
Disassociates the current Security Hub CSPM member account from the associated administrator account.
This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
## Request Syntax
```
POST /master/disassociate HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DisassociateFromMasterAccount)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DisassociateFromMasterAccount)
# DisassociateMembers
Disassociates the specified member accounts from the associated administrator account.
Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually.
## Request Syntax
```
POST /members/disassociate HTTP/1.1
Content-type: application/json
{
"AccountIds": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AccountIds](#API_DisassociateMembers_RequestSyntax) **
The account IDs of the member accounts to disassociate from the administrator account.
Type: Array of strings
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/DisassociateMembers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/DisassociateMembers)
# EnableImportFindingsForProduct
Enables the integration of a partner product with Security Hub CSPM. Integrated products send findings to Security Hub CSPM.
When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub CSPM is applied.
## Request Syntax
```
POST /productSubscriptions HTTP/1.1
Content-type: application/json
{
"ProductArn": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ProductArn](#API_EnableImportFindingsForProduct_RequestSyntax) **
The ARN of the product to enable the integration for.
Type: String
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ProductSubscriptionArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ProductSubscriptionArn](#API_EnableImportFindingsForProduct_ResponseSyntax) **
The ARN of your subscription to the product to enable integrations for.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/EnableImportFindingsForProduct)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/EnableImportFindingsForProduct)
# EnableOrganizationAdminAccount
Designates the Security Hub CSPM administrator account for an organization. Can only be called by the organization management account.
## Request Syntax
```
POST /organization/admin/enable HTTP/1.1
Content-type: application/json
{
"AdminAccountId": "string",
"Feature": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AdminAccountId](#API_EnableOrganizationAdminAccount_RequestSyntax) **
The AWS account identifier of the account to designate as the Security Hub CSPM administrator account.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Feature](#API_EnableOrganizationAdminAccount_RequestSyntax) **
The feature for which the delegated admin account is enabled. Defaults to Security Hub CSPM if not specified.
Type: String
Valid Values: `SecurityHub | SecurityHubV2`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AdminAccountId": "string",
"Feature": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AdminAccountId](#API_EnableOrganizationAdminAccount_ResponseSyntax) **
The AWS account identifier of the account to designate as the Security Hub CSPM administrator account.
Type: String
Pattern: `.*\S.*`
** [Feature](#API_EnableOrganizationAdminAccount_ResponseSyntax) **
The feature where the delegated administrator is enabled. The default is Security Hub CSPM CSPM if no delegated administrator is specified in the request.
Type: String
Valid Values: `SecurityHub | SecurityHubV2`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/EnableOrganizationAdminAccount)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/EnableOrganizationAdminAccount)
# EnableSecurityHub
Enables Security Hub CSPM for your account in the current Region or the Region you specify in the request.
When you enable Security Hub CSPM, you grant to Security Hub CSPM the permissions necessary to gather findings from other services that are integrated with Security Hub CSPM.
When you use the `EnableSecurityHub` operation to enable Security Hub CSPM, you also automatically enable the following standards:
+ Center for Internet Security (CIS) AWS Foundations Benchmark v1.2.0
+ AWS Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, set `EnableDefaultStandards` to `false`.
After you enable Security Hub CSPM, to enable a standard, use the `BatchEnableStandards` operation. To disable a standard, use the `BatchDisableStandards` operation.
To learn more, see the [setup information](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html) in the * AWS Security Hub CSPM User Guide*.
## Request Syntax
```
POST /accounts HTTP/1.1
Content-type: application/json
{
"ControlFindingGenerator": "string",
"EnableDefaultStandards": boolean,
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ControlFindingGenerator](#API_EnableSecurityHub_RequestSyntax) **
This field, used when enabling Security Hub CSPM, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to `SECURITY_CONTROL`, Security Hub CSPM generates a single finding for a control check even when the check applies to multiple enabled standards.
If the value for this field is set to `STANDARD_CONTROL`, Security Hub CSPM generates separate findings for a control check when the check applies to multiple enabled standards.
The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is `SECURITY_CONTROL` if you enabled Security Hub CSPM on or after February 23, 2023.
Type: String
Valid Values: `STANDARD_CONTROL | SECURITY_CONTROL`
Required: No
** [EnableDefaultStandards](#API_EnableSecurityHub_RequestSyntax) **
Whether to enable the security standards that Security Hub CSPM has designated as automatically enabled. If you don't provide a value for `EnableDefaultStandards`, it is set to `true`. To not enable the automatically enabled standards, set `EnableDefaultStandards` to `false`.
Type: Boolean
Required: No
** [Tags](#API_EnableSecurityHub_RequestSyntax) **
The tags to add to the hub resource when you enable Security Hub CSPM.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/EnableSecurityHub)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/EnableSecurityHub)
# EnableSecurityHubV2
Enables the service in account for the current AWS Region or specified AWS Region.
## Request Syntax
```
POST /hubv2 HTTP/1.1
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Tags](#API_EnableSecurityHubV2_RequestSyntax) **
The tags to add to the hub V2 resource when you enable Security Hub.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"HubV2Arn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [HubV2Arn](#API_EnableSecurityHubV2_ResponseSyntax) **
The ARN of the V2 resource that was created.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/EnableSecurityHubV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/EnableSecurityHubV2)
# GetAdministratorAccount
Provides the details for the Security Hub CSPM administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
## Request Syntax
```
GET /administrator HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Administrator": {
"AccountId": "string",
"InvitationId": "string",
"InvitedAt": "string",
"MemberStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Administrator](#API_GetAdministratorAccount_ResponseSyntax) **
Details about an invitation.
Type: [Invitation](API_Invitation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetAdministratorAccount)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetAdministratorAccount)
# GetAggregatorV2
Returns the configuration of the specified Aggregator V2.
## Request Syntax
```
GET /aggregatorv2/get/AggregatorV2Arn+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [AggregatorV2Arn](#API_GetAggregatorV2_RequestSyntax) **
The ARN of the Aggregator V2.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AggregationRegion": "string",
"AggregatorV2Arn": "string",
"LinkedRegions": [ "string" ],
"RegionLinkingMode": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AggregationRegion](#API_GetAggregatorV2_ResponseSyntax) **
The AWS Region where data is aggregated.
Type: String
Pattern: `.*\S.*`
** [AggregatorV2Arn](#API_GetAggregatorV2_ResponseSyntax) **
The ARN of the Aggregator V2.
Type: String
Pattern: `.*\S.*`
** [LinkedRegions](#API_GetAggregatorV2_ResponseSyntax) **
The list of Regions that are linked to the aggregation Region.
Type: Array of strings
Pattern: `.*\S.*`
** [RegionLinkingMode](#API_GetAggregatorV2_ResponseSyntax) **
Determines how Regions are linked to an Aggregator V2.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetAggregatorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetAggregatorV2)
# GetAutomationRuleV2
Returns an automation rule for the V2 service.
## Request Syntax
```
GET /automationrulesv2/Identifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [Identifier](#API_GetAutomationRuleV2_RequestSyntax) **
The ARN of the V2 automation rule.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Actions": [
{
"ExternalIntegrationConfiguration": {
"ConnectorArn": "string"
},
"FindingFieldsUpdate": {
"Comment": "string",
"SeverityId": number,
"StatusId": number
},
"Type": "string"
}
],
"CreatedAt": "string",
"Criteria": { ... },
"Description": "string",
"RuleArn": "string",
"RuleId": "string",
"RuleName": "string",
"RuleOrder": number,
"RuleStatus": "string",
"UpdatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Actions](#API_GetAutomationRuleV2_ResponseSyntax) **
A list of actions performed when the rule criteria is met.
Type: Array of [AutomationRulesActionV2](API_AutomationRulesActionV2.md) objects
Array Members: Fixed number of 1 item.
** [CreatedAt](#API_GetAutomationRuleV2_ResponseSyntax) **
The timestamp when the V2 automation rule was created.
Type: Timestamp
** [Criteria](#API_GetAutomationRuleV2_ResponseSyntax) **
The filtering type and configuration of the V2 automation rule.
Type: [Criteria](API_Criteria.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [Description](#API_GetAutomationRuleV2_ResponseSyntax) **
A description of the automation rule.
Type: String
Pattern: `.*\S.*`
** [RuleArn](#API_GetAutomationRuleV2_ResponseSyntax) **
The ARN of the V2 automation rule.
Type: String
Pattern: `.*\S.*`
** [RuleId](#API_GetAutomationRuleV2_ResponseSyntax) **
The ID of the V2 automation rule.
Type: String
Pattern: `.*\S.*`
** [RuleName](#API_GetAutomationRuleV2_ResponseSyntax) **
The name of the V2 automation rule.
Type: String
Pattern: `.*\S.*`
** [RuleOrder](#API_GetAutomationRuleV2_ResponseSyntax) **
The value for the rule priority.
Type: Float
Valid Range: Minimum value of 1.0. Maximum value of 1000.0.
** [RuleStatus](#API_GetAutomationRuleV2_ResponseSyntax) **
The status of the V2 automation automation rule.
Type: String
Valid Values: `ENABLED | DISABLED`
** [UpdatedAt](#API_GetAutomationRuleV2_ResponseSyntax) **
The timestamp when the V2 automation rule was updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetAutomationRuleV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetAutomationRuleV2)
# GetConfigurationPolicy
Provides information about a configuration policy. Only the AWS Security Hub CSPM delegated administrator can invoke this operation from the home Region.
## Request Syntax
```
GET /configurationPolicy/get/Identifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [Identifier](#API_GetConfigurationPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"ConfigurationPolicy": { ... },
"CreatedAt": "string",
"Description": "string",
"Id": "string",
"Name": "string",
"UpdatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Arn](#API_GetConfigurationPolicy_ResponseSyntax) **
The ARN of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [ConfigurationPolicy](#API_GetConfigurationPolicy_ResponseSyntax) **
An object that defines how Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the policy includes a list of security controls that are enabled, Security Hub CSPM disables all other controls (including newly released controls). If the policy includes a list of security controls that are disabled, Security Hub CSPM enables all other controls (including newly released controls).
Type: [Policy](API_Policy.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [CreatedAt](#API_GetConfigurationPolicy_ResponseSyntax) **
The date and time, in UTC and ISO 8601 format, that the configuration policy was created.
Type: Timestamp
** [Description](#API_GetConfigurationPolicy_ResponseSyntax) **
The description of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [Id](#API_GetConfigurationPolicy_ResponseSyntax) **
The UUID of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [Name](#API_GetConfigurationPolicy_ResponseSyntax) **
The name of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [UpdatedAt](#API_GetConfigurationPolicy_ResponseSyntax) **
The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetConfigurationPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetConfigurationPolicy)
# GetConfigurationPolicyAssociation
Returns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the AWS Security Hub CSPM delegated administrator can invoke this operation from the home Region.
## Request Syntax
```
POST /configurationPolicyAssociation/get HTTP/1.1
Content-type: application/json
{
"Target": { ... }
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Target](#API_GetConfigurationPolicyAssociation_RequestSyntax) **
The target account ID, organizational unit ID, or the root ID to retrieve the association for.
Type: [Target](API_Target.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AssociationStatus": "string",
"AssociationStatusMessage": "string",
"AssociationType": "string",
"ConfigurationPolicyId": "string",
"TargetId": "string",
"TargetType": "string",
"UpdatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AssociationStatus](#API_GetConfigurationPolicyAssociation_ResponseSyntax) **
The current status of the association between the specified target and the configuration.
Type: String
Valid Values: `PENDING | SUCCESS | FAILED`
** [AssociationStatusMessage](#API_GetConfigurationPolicyAssociation_ResponseSyntax) **
The explanation for a `FAILED` value for `AssociationStatus`.
Type: String
Pattern: `.*\S.*`
** [AssociationType](#API_GetConfigurationPolicyAssociation_ResponseSyntax) **
Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub CSPM delegated administrator or inherited from a parent.
Type: String
Valid Values: `INHERITED | APPLIED`
** [ConfigurationPolicyId](#API_GetConfigurationPolicyAssociation_ResponseSyntax) **
The universally unique identifier (UUID) of a configuration policy. For self-managed behavior, the value is `SELF_MANAGED_SECURITY_HUB`.
Type: String
Pattern: `.*\S.*`
** [TargetId](#API_GetConfigurationPolicyAssociation_ResponseSyntax) **
The target account ID, organizational unit ID, or the root ID for which the association is retrieved.
Type: String
Pattern: `.*\S.*`
** [TargetType](#API_GetConfigurationPolicyAssociation_ResponseSyntax) **
Specifies whether the target is an AWS account, organizational unit, or the organization root.
Type: String
Valid Values: `ACCOUNT | ORGANIZATIONAL_UNIT | ROOT`
** [UpdatedAt](#API_GetConfigurationPolicyAssociation_ResponseSyntax) **
The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetConfigurationPolicyAssociation)
# GetConnectorV2
Grants permission to retrieve details for a connectorV2 based on connector id.
## Request Syntax
```
GET /connectorsv2/ConnectorId+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ConnectorId](#API_GetConnectorV2_RequestSyntax) **
The UUID of the connectorV2 to identify connectorV2 resource.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ConnectorArn": "string",
"ConnectorId": "string",
"CreatedAt": "string",
"Description": "string",
"Health": {
"ConnectorStatus": "string",
"LastCheckedAt": "string",
"Message": "string"
},
"KmsKeyArn": "string",
"LastUpdatedAt": "string",
"Name": "string",
"ProviderDetail": { ... }
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConnectorArn](#API_GetConnectorV2_ResponseSyntax) **
The Amazon Resource Name (ARN) of the connectorV2.
Type: String
Pattern: `.*\S.*`
** [ConnectorId](#API_GetConnectorV2_ResponseSyntax) **
The UUID of the connectorV2 to identify connectorV2 resource.
Type: String
Pattern: `.*\S.*`
** [CreatedAt](#API_GetConnectorV2_ResponseSyntax) **
ISO 8601 UTC timestamp for the time create the connectorV2.
Type: Timestamp
** [Description](#API_GetConnectorV2_ResponseSyntax) **
The description of the connectorV2.
Type: String
Pattern: `.*\S.*`
** [Health](#API_GetConnectorV2_ResponseSyntax) **
The current health status for connectorV2
Type: [HealthCheck](API_HealthCheck.md) object
** [KmsKeyArn](#API_GetConnectorV2_ResponseSyntax) **
The Amazon Resource Name (ARN) of KMS key used for the connectorV2.
Type: String
Pattern: `.*\S.*`
** [LastUpdatedAt](#API_GetConnectorV2_ResponseSyntax) **
ISO 8601 UTC timestamp for the time update the connectorV2 connectorStatus.
Type: Timestamp
** [Name](#API_GetConnectorV2_ResponseSyntax) **
The name of the connectorV2.
Type: String
Pattern: `.*\S.*`
** [ProviderDetail](#API_GetConnectorV2_ResponseSyntax) **
The third-party provider detail for a service configuration.
Type: [ProviderDetail](API_ProviderDetail.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetConnectorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetConnectorV2)
# GetEnabledStandards
Returns a list of the standards that are currently enabled.
## Request Syntax
```
POST /standards/get HTTP/1.1
Content-type: application/json
{
"MaxResults": number,
"NextToken": "string",
"StandardsSubscriptionArns": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [MaxResults](#API_GetEnabledStandards_RequestSyntax) **
The maximum number of results to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_GetEnabledStandards_RequestSyntax) **
The token that is required for pagination. On your first call to the `GetEnabledStandards` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Type: String
Required: No
** [StandardsSubscriptionArns](#API_GetEnabledStandards_RequestSyntax) **
The list of the standards subscription ARNs for the standards to retrieve.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"StandardsSubscriptions": [
{
"StandardsArn": "string",
"StandardsControlsUpdatable": "string",
"StandardsInput": {
"string" : "string"
},
"StandardsStatus": "string",
"StandardsStatusReason": {
"StatusReasonCode": "string"
},
"StandardsSubscriptionArn": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_GetEnabledStandards_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
** [StandardsSubscriptions](#API_GetEnabledStandards_ResponseSyntax) **
The list of `StandardsSubscriptions` objects that include information about the enabled standards.
Type: Array of [StandardsSubscription](API_StandardsSubscription.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetEnabledStandards)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetEnabledStandards)
# GetFindingAggregator
**Note**
The *aggregation Region* is now called the *home Region*.
Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.
## Request Syntax
```
GET /findingAggregator/get/FindingAggregatorArn+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [FindingAggregatorArn](#API_GetFindingAggregator_RequestSyntax) **
The ARN of the finding aggregator to return details for. To obtain the ARN, use `ListFindingAggregators`.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"FindingAggregationRegion": "string",
"FindingAggregatorArn": "string",
"RegionLinkingMode": "string",
"Regions": [ "string" ]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [FindingAggregationRegion](#API_GetFindingAggregator_ResponseSyntax) **
The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
Type: String
Pattern: `.*\S.*`
** [FindingAggregatorArn](#API_GetFindingAggregator_ResponseSyntax) **
The ARN of the finding aggregator.
Type: String
Pattern: `.*\S.*`
** [RegionLinkingMode](#API_GetFindingAggregator_ResponseSyntax) **
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
Type: String
Pattern: `.*\S.*`
** [Regions](#API_GetFindingAggregator_ResponseSyntax) **
The list of excluded Regions or included Regions.
Type: Array of strings
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetFindingAggregator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetFindingAggregator)
# GetFindingHistory
Returns the history of a Security Hub CSPM finding. The history includes changes made to any fields in the AWS Security Finding Format (ASFF) except top-level timestamp fields, such as the `CreatedAt` and `UpdatedAt` fields.
This operation might return fewer results than the maximum number of results (`MaxResults`) specified in a request, even when more results are available. If this occurs, the response includes a `NextToken` value, which you should use to retrieve the next set of results in the response. The presence of a `NextToken` value in a response doesn't necessarily indicate that the results are incomplete. However, you should continue to specify a `NextToken` value until you receive a response that doesn't include this value.
## Request Syntax
```
POST /findingHistory/get HTTP/1.1
Content-type: application/json
{
"EndTime": "string",
"FindingIdentifier": {
"Id": "string",
"ProductArn": "string"
},
"MaxResults": number,
"NextToken": "string",
"StartTime": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [EndTime](#API_GetFindingHistory_RequestSyntax) **
An ISO 8601-formatted timestamp that indicates the end time of the requested finding history.
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.
For more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).
Type: Timestamp
Required: No
** [FindingIdentifier](#API_GetFindingHistory_RequestSyntax) **
Identifies which finding to get the finding history for.
Type: [AwsSecurityFindingIdentifier](API_AwsSecurityFindingIdentifier.md) object
Required: Yes
** [MaxResults](#API_GetFindingHistory_RequestSyntax) **
The maximum number of results to be returned. If you don’t provide it, Security Hub CSPM returns up to 100 results of finding history.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_GetFindingHistory_RequestSyntax) **
A token for pagination purposes. Provide `NULL` as the initial value. In subsequent requests, provide the token included in the response to get up to an additional 100 results of finding history. If you don’t provide `NextToken`, Security Hub CSPM returns up to 100 results of finding history for each request.
Type: String
Required: No
** [StartTime](#API_GetFindingHistory_RequestSyntax) **
A timestamp that indicates the start time of the requested finding history.
If you provide values for both `StartTime` and `EndTime`, AWS 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.
For more information about the validation and formatting of timestamp fields in AWS Security Hub CSPM, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps).
Type: Timestamp
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Records": [
{
"FindingCreated": boolean,
"FindingIdentifier": {
"Id": "string",
"ProductArn": "string"
},
"NextToken": "string",
"Updates": [
{
"NewValue": "string",
"OldValue": "string",
"UpdatedField": "string"
}
],
"UpdateSource": {
"Identity": "string",
"Type": "string"
},
"UpdateTime": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_GetFindingHistory_ResponseSyntax) **
A token for pagination purposes. Provide this token in the subsequent request to `GetFindingsHistory` to get up to an additional 100 results of history for the same finding that you specified in your initial request.
Type: String
** [Records](#API_GetFindingHistory_ResponseSyntax) **
A list of events that altered the specified finding during the specified time period.
Type: Array of [FindingHistoryRecord](API_FindingHistoryRecord.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetFindingHistory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetFindingHistory)
# GetFindings
Returns a list of findings that match the specified criteria.
If cross-Region aggregation is enabled, then when you call `GetFindings` from the home Region, the results include all of the matching findings from both the home Region and linked Regions.
## Request Syntax
```
POST /findings HTTP/1.1
Content-type: application/json
{
"Filters": {
"AwsAccountId": [
{
"Comparison": "string",
"Value": "string"
}
],
"AwsAccountName": [
{
"Comparison": "string",
"Value": "string"
}
],
"CompanyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceAssociatedStandardsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"Confidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"CreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"Criticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"Description": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsConfidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsCriticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsRelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsRelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityOriginal": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsTypes": [
{
"Comparison": "string",
"Value": "string"
}
],
"FirstObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"GeneratorId": [
{
"Comparison": "string",
"Value": "string"
}
],
"Id": [
{
"Comparison": "string",
"Value": "string"
}
],
"Keyword": [
{
"Value": "string"
}
],
"LastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"MalwareName": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwarePath": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareState": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareType": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationIpV4": [
{
"Cidr": "string"
}
],
"NetworkDestinationIpV6": [
{
"Cidr": "string"
}
],
"NetworkDestinationPort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NetworkDirection": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkProtocol": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceIpV4": [
{
"Cidr": "string"
}
],
"NetworkSourceIpV6": [
{
"Cidr": "string"
}
],
"NetworkSourceMac": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourcePort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NoteText": [
{
"Comparison": "string",
"Value": "string"
}
],
"NoteUpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteUpdatedBy": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProcessName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessParentPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessPath": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessTerminatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ProductName": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecommendationText": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecordState": [
{
"Comparison": "string",
"Value": "string"
}
],
"Region": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIamInstanceProfileArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIpV4Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceIpV6Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceKeyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsEc2InstanceSubnetId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceVpcId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyCreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsIamAccessKeyPrincipalName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamUserUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceContainerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceDetailsOther": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourcePartition": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceRegion": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceTags": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"Sample": [
{
"Value": boolean
}
],
"SeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"SeverityNormalized": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SeverityProduct": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorCategory": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorLastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ThreatIntelIndicatorSource": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorSourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"Title": [
{
"Comparison": "string",
"Value": "string"
}
],
"Type": [
{
"Comparison": "string",
"Value": "string"
}
],
"UpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"UserDefinedFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"VerificationState": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesExploitAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesFixAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowState": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowStatus": [
{
"Comparison": "string",
"Value": "string"
}
]
},
"MaxResults": number,
"NextToken": "string",
"SortCriteria": [
{
"Field": "string",
"SortOrder": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Filters](#API_GetFindings_RequestSyntax) **
The finding attributes used to define a condition to filter the returned findings.
You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.
Note that in the available filter fields, `WorkflowState` is deprecated. To search for a finding based on its workflow status, use `WorkflowStatus`.
Type: [AwsSecurityFindingFilters](API_AwsSecurityFindingFilters.md) object
Required: No
** [MaxResults](#API_GetFindings_RequestSyntax) **
The maximum number of findings to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_GetFindings_RequestSyntax) **
The token that is required for pagination. On your first call to the `GetFindings` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Type: String
Required: No
** [SortCriteria](#API_GetFindings_RequestSyntax) **
The finding attributes used to sort the list of returned findings.
Type: Array of [SortCriterion](API_SortCriterion.md) objects
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Findings": [
{
"Action": {
"ActionType": "string",
"AwsApiCallAction": {
"AffectedResources": {
"string" : "string"
},
"Api": "string",
"CallerType": "string",
"DomainDetails": {
"Domain": "string"
},
"FirstSeen": "string",
"LastSeen": "string",
"RemoteIpDetails": {
"City": {
"CityName": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"GeoLocation": {
"Lat": number,
"Lon": number
},
"IpAddressV4": "string",
"Organization": {
"Asn": number,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
}
},
"ServiceName": "string"
},
"DnsRequestAction": {
"Blocked": boolean,
"Domain": "string",
"Protocol": "string"
},
"NetworkConnectionAction": {
"Blocked": boolean,
"ConnectionDirection": "string",
"LocalPortDetails": {
"Port": number,
"PortName": "string"
},
"Protocol": "string",
"RemoteIpDetails": {
"City": {
"CityName": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"GeoLocation": {
"Lat": number,
"Lon": number
},
"IpAddressV4": "string",
"Organization": {
"Asn": number,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
}
},
"RemotePortDetails": {
"Port": number,
"PortName": "string"
}
},
"PortProbeAction": {
"Blocked": boolean,
"PortProbeDetails": [
{
"LocalIpDetails": {
"IpAddressV4": "string"
},
"LocalPortDetails": {
"Port": number,
"PortName": "string"
},
"RemoteIpDetails": {
"City": {
"CityName": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"GeoLocation": {
"Lat": number,
"Lon": number
},
"IpAddressV4": "string",
"Organization": {
"Asn": number,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
}
}
}
]
}
},
"AwsAccountId": "string",
"AwsAccountName": "string",
"CompanyName": "string",
"Compliance": {
"AssociatedStandards": [
{
"StandardsId": "string"
}
],
"RelatedRequirements": [ "string" ],
"SecurityControlId": "string",
"SecurityControlParameters": [
{
"Name": "string",
"Value": [ "string" ]
}
],
"Status": "string",
"StatusReasons": [
{
"Description": "string",
"ReasonCode": "string"
}
]
},
"Confidence": number,
"CreatedAt": "string",
"Criticality": number,
"Description": "string",
"Detection": {
"Sequence": {
"Actors": [
{
"Id": "string",
"Session": {
"CreatedTime": number,
"Issuer": "string",
"MfaStatus": "string",
"Uid": "string"
},
"User": {
"Account": {
"Name": "string",
"Uid": "string"
},
"CredentialUid": "string",
"Name": "string",
"Type": "string",
"Uid": "string"
}
}
],
"Endpoints": [
{
"AutonomousSystem": {
"Name": "string",
"Number": number
},
"Connection": {
"Direction": "string"
},
"Domain": "string",
"Id": "string",
"Ip": "string",
"Location": {
"City": "string",
"Country": "string",
"Lat": number,
"Lon": number
},
"Port": number
}
],
"SequenceIndicators": [
{
"Key": "string",
"Title": "string",
"Type": "string",
"Values": [ "string" ]
}
],
"Signals": [
{
"ActorIds": [ "string" ],
"Count": number,
"CreatedAt": number,
"EndpointIds": [ "string" ],
"FirstSeenAt": number,
"Id": "string",
"LastSeenAt": number,
"Name": "string",
"ProductArn": "string",
"ResourceIds": [ "string" ],
"Severity": number,
"SignalIndicators": [
{
"Key": "string",
"Title": "string",
"Type": "string",
"Values": [ "string" ]
}
],
"Title": "string",
"Type": "string",
"UpdatedAt": number
}
],
"Uid": "string"
}
},
"FindingProviderFields": {
"Confidence": number,
"Criticality": number,
"RelatedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Severity": {
"Label": "string",
"Original": "string"
},
"Types": [ "string" ]
},
"FirstObservedAt": "string",
"GeneratorDetails": {
"Description": "string",
"Labels": [ "string" ],
"Name": "string"
},
"GeneratorId": "string",
"Id": "string",
"LastObservedAt": "string",
"Malware": [
{
"Name": "string",
"Path": "string",
"State": "string",
"Type": "string"
}
],
"Network": {
"DestinationDomain": "string",
"DestinationIpV4": "string",
"DestinationIpV6": "string",
"DestinationPort": number,
"Direction": "string",
"OpenPortRange": {
"Begin": number,
"End": number
},
"Protocol": "string",
"SourceDomain": "string",
"SourceIpV4": "string",
"SourceIpV6": "string",
"SourceMac": "string",
"SourcePort": number
},
"NetworkPath": [
{
"ComponentId": "string",
"ComponentType": "string",
"Egress": {
"Destination": {
"Address": [ "string" ],
"PortRanges": [
{
"Begin": number,
"End": number
}
]
},
"Protocol": "string",
"Source": {
"Address": [ "string" ],
"PortRanges": [
{
"Begin": number,
"End": number
}
]
}
},
"Ingress": {
"Destination": {
"Address": [ "string" ],
"PortRanges": [
{
"Begin": number,
"End": number
}
]
},
"Protocol": "string",
"Source": {
"Address": [ "string" ],
"PortRanges": [
{
"Begin": number,
"End": number
}
]
}
}
}
],
"Note": {
"Text": "string",
"UpdatedAt": "string",
"UpdatedBy": "string"
},
"PatchSummary": {
"FailedCount": number,
"Id": "string",
"InstalledCount": number,
"InstalledOtherCount": number,
"InstalledPendingReboot": number,
"InstalledRejectedCount": number,
"MissingCount": number,
"Operation": "string",
"OperationEndTime": "string",
"OperationStartTime": "string",
"RebootOption": "string"
},
"Process": {
"LaunchedAt": "string",
"Name": "string",
"ParentPid": number,
"Path": "string",
"Pid": number,
"TerminatedAt": "string"
},
"ProcessedAt": "string",
"ProductArn": "string",
"ProductFields": {
"string" : "string"
},
"ProductName": "string",
"RecordState": "string",
"Region": "string",
"RelatedFindings": [
{
"Id": "string",
"ProductArn": "string"
}
],
"Remediation": {
"Recommendation": {
"Text": "string",
"Url": "string"
}
},
"Resources": [
{
"ApplicationArn": "string",
"ApplicationName": "string",
"DataClassification": {
"DetailedResultsLocation": "string",
"Result": {
"AdditionalOccurrences": boolean,
"CustomDataIdentifiers": {
"Detections": [
{
"Arn": "string",
"Count": number,
"Name": "string",
"Occurrences": {
"Cells": [
{
"CellReference": "string",
"Column": number,
"ColumnName": "string",
"Row": number
}
],
"LineRanges": [
{
"End": number,
"Start": number,
"StartColumn": number
}
],
"OffsetRanges": [
{
"End": number,
"Start": number,
"StartColumn": number
}
],
"Pages": [
{
"LineRange": {
"End": number,
"Start": number,
"StartColumn": number
},
"OffsetRange": {
"End": number,
"Start": number,
"StartColumn": number
},
"PageNumber": number
}
],
"Records": [
{
"JsonPath": "string",
"RecordIndex": number
}
]
}
}
],
"TotalCount": number
},
"MimeType": "string",
"SensitiveData": [
{
"Category": "string",
"Detections": [
{
"Count": number,
"Occurrences": {
"Cells": [
{
"CellReference": "string",
"Column": number,
"ColumnName": "string",
"Row": number
}
],
"LineRanges": [
{
"End": number,
"Start": number,
"StartColumn": number
}
],
"OffsetRanges": [
{
"End": number,
"Start": number,
"StartColumn": number
}
],
"Pages": [
{
"LineRange": {
"End": number,
"Start": number,
"StartColumn": number
},
"OffsetRange": {
"End": number,
"Start": number,
"StartColumn": number
},
"PageNumber": number
}
],
"Records": [
{
"JsonPath": "string",
"RecordIndex": number
}
]
},
"Type": "string"
}
],
"TotalCount": number
}
],
"SizeClassified": number,
"Status": {
"Code": "string",
"Reason": "string"
}
}
},
"Details": {
"AwsAmazonMqBroker": {
"AuthenticationStrategy": "string",
"AutoMinorVersionUpgrade": boolean,
"BrokerArn": "string",
"BrokerId": "string",
"BrokerName": "string",
"DeploymentMode": "string",
"EncryptionOptions": {
"KmsKeyId": "string",
"UseAwsOwnedKey": boolean
},
"EngineType": "string",
"EngineVersion": "string",
"HostInstanceType": "string",
"LdapServerMetadata": {
"Hosts": [ "string" ],
"RoleBase": "string",
"RoleName": "string",
"RoleSearchMatching": "string",
"RoleSearchSubtree": boolean,
"ServiceAccountUsername": "string",
"UserBase": "string",
"UserRoleName": "string",
"UserSearchMatching": "string",
"UserSearchSubtree": boolean
},
"Logs": {
"Audit": boolean,
"AuditLogGroup": "string",
"General": boolean,
"GeneralLogGroup": "string",
"Pending": {
"Audit": boolean,
"General": boolean
}
},
"MaintenanceWindowStartTime": {
"DayOfWeek": "string",
"TimeOfDay": "string",
"TimeZone": "string"
},
"PubliclyAccessible": boolean,
"SecurityGroups": [ "string" ],
"StorageType": "string",
"SubnetIds": [ "string" ],
"Users": [
{
"PendingChange": "string",
"Username": "string"
}
]
},
"AwsApiGatewayRestApi": {
"ApiKeySource": "string",
"BinaryMediaTypes": [ "string" ],
"CreatedDate": "string",
"Description": "string",
"EndpointConfiguration": {
"Types": [ "string" ]
},
"Id": "string",
"MinimumCompressionSize": number,
"Name": "string",
"Version": "string"
},
"AwsApiGatewayStage": {
"AccessLogSettings": {
"DestinationArn": "string",
"Format": "string"
},
"CacheClusterEnabled": boolean,
"CacheClusterSize": "string",
"CacheClusterStatus": "string",
"CanarySettings": {
"DeploymentId": "string",
"PercentTraffic": number,
"StageVariableOverrides": {
"string" : "string"
},
"UseStageCache": boolean
},
"ClientCertificateId": "string",
"CreatedDate": "string",
"DeploymentId": "string",
"Description": "string",
"DocumentationVersion": "string",
"LastUpdatedDate": "string",
"MethodSettings": [
{
"CacheDataEncrypted": boolean,
"CacheTtlInSeconds": number,
"CachingEnabled": boolean,
"DataTraceEnabled": boolean,
"HttpMethod": "string",
"LoggingLevel": "string",
"MetricsEnabled": boolean,
"RequireAuthorizationForCacheControl": boolean,
"ResourcePath": "string",
"ThrottlingBurstLimit": number,
"ThrottlingRateLimit": number,
"UnauthorizedCacheControlHeaderStrategy": "string"
}
],
"StageName": "string",
"TracingEnabled": boolean,
"Variables": {
"string" : "string"
},
"WebAclArn": "string"
},
"AwsApiGatewayV2Api": {
"ApiEndpoint": "string",
"ApiId": "string",
"ApiKeySelectionExpression": "string",
"CorsConfiguration": {
"AllowCredentials": boolean,
"AllowHeaders": [ "string" ],
"AllowMethods": [ "string" ],
"AllowOrigins": [ "string" ],
"ExposeHeaders": [ "string" ],
"MaxAge": number
},
"CreatedDate": "string",
"Description": "string",
"Name": "string",
"ProtocolType": "string",
"RouteSelectionExpression": "string",
"Version": "string"
},
"AwsApiGatewayV2Stage": {
"AccessLogSettings": {
"DestinationArn": "string",
"Format": "string"
},
"ApiGatewayManaged": boolean,
"AutoDeploy": boolean,
"ClientCertificateId": "string",
"CreatedDate": "string",
"DefaultRouteSettings": {
"DataTraceEnabled": boolean,
"DetailedMetricsEnabled": boolean,
"LoggingLevel": "string",
"ThrottlingBurstLimit": number,
"ThrottlingRateLimit": number
},
"DeploymentId": "string",
"Description": "string",
"LastDeploymentStatusMessage": "string",
"LastUpdatedDate": "string",
"RouteSettings": {
"DataTraceEnabled": boolean,
"DetailedMetricsEnabled": boolean,
"LoggingLevel": "string",
"ThrottlingBurstLimit": number,
"ThrottlingRateLimit": number
},
"StageName": "string",
"StageVariables": {
"string" : "string"
}
},
"AwsAppSyncGraphQlApi": {
"AdditionalAuthenticationProviders": [
{
"AuthenticationType": "string",
"LambdaAuthorizerConfig": {
"AuthorizerResultTtlInSeconds": number,
"AuthorizerUri": "string",
"IdentityValidationExpression": "string"
},
"OpenIdConnectConfig": {
"AuthTtL": number,
"ClientId": "string",
"IatTtL": number,
"Issuer": "string"
},
"UserPoolConfig": {
"AppIdClientRegex": "string",
"AwsRegion": "string",
"DefaultAction": "string",
"UserPoolId": "string"
}
}
],
"ApiId": "string",
"Arn": "string",
"AuthenticationType": "string",
"Id": "string",
"LambdaAuthorizerConfig": {
"AuthorizerResultTtlInSeconds": number,
"AuthorizerUri": "string",
"IdentityValidationExpression": "string"
},
"LogConfig": {
"CloudWatchLogsRoleArn": "string",
"ExcludeVerboseContent": boolean,
"FieldLogLevel": "string"
},
"Name": "string",
"OpenIdConnectConfig": {
"AuthTtL": number,
"ClientId": "string",
"IatTtL": number,
"Issuer": "string"
},
"UserPoolConfig": {
"AppIdClientRegex": "string",
"AwsRegion": "string",
"DefaultAction": "string",
"UserPoolId": "string"
},
"WafWebAclArn": "string",
"XrayEnabled": boolean
},
"AwsAthenaWorkGroup": {
"Configuration": {
"ResultConfiguration": {
"EncryptionConfiguration": {
"EncryptionOption": "string",
"KmsKey": "string"
}
}
},
"Description": "string",
"Name": "string",
"State": "string"
},
"AwsAutoScalingAutoScalingGroup": {
"AvailabilityZones": [
{
"Value": "string"
}
],
"CapacityRebalance": boolean,
"CreatedTime": "string",
"HealthCheckGracePeriod": number,
"HealthCheckType": "string",
"LaunchConfigurationName": "string",
"LaunchTemplate": {
"LaunchTemplateId": "string",
"LaunchTemplateName": "string",
"Version": "string"
},
"LoadBalancerNames": [ "string" ],
"MixedInstancesPolicy": {
"InstancesDistribution": {
"OnDemandAllocationStrategy": "string",
"OnDemandBaseCapacity": number,
"OnDemandPercentageAboveBaseCapacity": number,
"SpotAllocationStrategy": "string",
"SpotInstancePools": number,
"SpotMaxPrice": "string"
},
"LaunchTemplate": {
"LaunchTemplateSpecification": {
"LaunchTemplateId": "string",
"LaunchTemplateName": "string",
"Version": "string"
},
"Overrides": [
{
"InstanceType": "string",
"WeightedCapacity": "string"
}
]
}
}
},
"AwsAutoScalingLaunchConfiguration": {
"AssociatePublicIpAddress": boolean,
"BlockDeviceMappings": [
{
"DeviceName": "string",
"Ebs": {
"DeleteOnTermination": boolean,
"Encrypted": boolean,
"Iops": number,
"SnapshotId": "string",
"VolumeSize": number,
"VolumeType": "string"
},
"NoDevice": boolean,
"VirtualName": "string"
}
],
"ClassicLinkVpcId": "string",
"ClassicLinkVpcSecurityGroups": [ "string" ],
"CreatedTime": "string",
"EbsOptimized": boolean,
"IamInstanceProfile": "string",
"ImageId": "string",
"InstanceMonitoring": {
"Enabled": boolean
},
"InstanceType": "string",
"KernelId": "string",
"KeyName": "string",
"LaunchConfigurationName": "string",
"MetadataOptions": {
"HttpEndpoint": "string",
"HttpPutResponseHopLimit": number,
"HttpTokens": "string"
},
"PlacementTenancy": "string",
"RamdiskId": "string",
"SecurityGroups": [ "string" ],
"SpotPrice": "string",
"UserData": "string"
},
"AwsBackupBackupPlan": {
"BackupPlan": {
"AdvancedBackupSettings": [
{
"BackupOptions": {
"string" : "string"
},
"ResourceType": "string"
}
],
"BackupPlanName": "string",
"BackupPlanRule": [
{
"CompletionWindowMinutes": number,
"CopyActions": [
{
"DestinationBackupVaultArn": "string",
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number
}
}
],
"EnableContinuousBackup": boolean,
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number
},
"RuleId": "string",
"RuleName": "string",
"ScheduleExpression": "string",
"StartWindowMinutes": number,
"TargetBackupVault": "string"
}
]
},
"BackupPlanArn": "string",
"BackupPlanId": "string",
"VersionId": "string"
},
"AwsBackupBackupVault": {
"AccessPolicy": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"EncryptionKeyArn": "string",
"Notifications": {
"BackupVaultEvents": [ "string" ],
"SnsTopicArn": "string"
}
},
"AwsBackupRecoveryPoint": {
"BackupSizeInBytes": number,
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CalculatedLifecycle": {
"DeleteAt": "string",
"MoveToColdStorageAt": "string"
},
"CompletionDate": "string",
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": "string",
"EncryptionKeyArn": "string",
"IamRoleArn": "string",
"IsEncrypted": boolean,
"LastRestoreTime": "string",
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number
},
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceType": "string",
"SourceBackupVaultArn": "string",
"Status": "string",
"StatusMessage": "string",
"StorageClass": "string"
},
"AwsCertificateManagerCertificate": {
"CertificateAuthorityArn": "string",
"CreatedAt": "string",
"DomainName": "string",
"DomainValidationOptions": [
{
"DomainName": "string",
"ResourceRecord": {
"Name": "string",
"Type": "string",
"Value": "string"
},
"ValidationDomain": "string",
"ValidationEmails": [ "string" ],
"ValidationMethod": "string",
"ValidationStatus": "string"
}
],
"ExtendedKeyUsages": [
{
"Name": "string",
"OId": "string"
}
],
"FailureReason": "string",
"ImportedAt": "string",
"InUseBy": [ "string" ],
"IssuedAt": "string",
"Issuer": "string",
"KeyAlgorithm": "string",
"KeyUsages": [
{
"Name": "string"
}
],
"NotAfter": "string",
"NotBefore": "string",
"Options": {
"CertificateTransparencyLoggingPreference": "string"
},
"RenewalEligibility": "string",
"RenewalSummary": {
"DomainValidationOptions": [
{
"DomainName": "string",
"ResourceRecord": {
"Name": "string",
"Type": "string",
"Value": "string"
},
"ValidationDomain": "string",
"ValidationEmails": [ "string" ],
"ValidationMethod": "string",
"ValidationStatus": "string"
}
],
"RenewalStatus": "string",
"RenewalStatusReason": "string",
"UpdatedAt": "string"
},
"Serial": "string",
"SignatureAlgorithm": "string",
"Status": "string",
"Subject": "string",
"SubjectAlternativeNames": [ "string" ],
"Type": "string"
},
"AwsCloudFormationStack": {
"Capabilities": [ "string" ],
"CreationTime": "string",
"Description": "string",
"DisableRollback": boolean,
"DriftInformation": {
"StackDriftStatus": "string"
},
"EnableTerminationProtection": boolean,
"LastUpdatedTime": "string",
"NotificationArns": [ "string" ],
"Outputs": [
{
"Description": "string",
"OutputKey": "string",
"OutputValue": "string"
}
],
"RoleArn": "string",
"StackId": "string",
"StackName": "string",
"StackStatus": "string",
"StackStatusReason": "string",
"TimeoutInMinutes": number
},
"AwsCloudFrontDistribution": {
"CacheBehaviors": {
"Items": [
{
"ViewerProtocolPolicy": "string"
}
]
},
"DefaultCacheBehavior": {
"ViewerProtocolPolicy": "string"
},
"DefaultRootObject": "string",
"DomainName": "string",
"ETag": "string",
"LastModifiedTime": "string",
"Logging": {
"Bucket": "string",
"Enabled": boolean,
"IncludeCookies": boolean,
"Prefix": "string"
},
"OriginGroups": {
"Items": [
{
"FailoverCriteria": {
"StatusCodes": {
"Items": [ number ],
"Quantity": number
}
}
}
]
},
"Origins": {
"Items": [
{
"CustomOriginConfig": {
"HttpPort": number,
"HttpsPort": number,
"OriginKeepaliveTimeout": number,
"OriginProtocolPolicy": "string",
"OriginReadTimeout": number,
"OriginSslProtocols": {
"Items": [ "string" ],
"Quantity": number
}
},
"DomainName": "string",
"Id": "string",
"OriginPath": "string",
"S3OriginConfig": {
"OriginAccessIdentity": "string"
}
}
]
},
"Status": "string",
"ViewerCertificate": {
"AcmCertificateArn": "string",
"Certificate": "string",
"CertificateSource": "string",
"CloudFrontDefaultCertificate": boolean,
"IamCertificateId": "string",
"MinimumProtocolVersion": "string",
"SslSupportMethod": "string"
},
"WebAclId": "string"
},
"AwsCloudTrailTrail": {
"CloudWatchLogsLogGroupArn": "string",
"CloudWatchLogsRoleArn": "string",
"HasCustomEventSelectors": boolean,
"HomeRegion": "string",
"IncludeGlobalServiceEvents": boolean,
"IsMultiRegionTrail": boolean,
"IsOrganizationTrail": boolean,
"KmsKeyId": "string",
"LogFileValidationEnabled": boolean,
"Name": "string",
"S3BucketName": "string",
"S3KeyPrefix": "string",
"SnsTopicArn": "string",
"SnsTopicName": "string",
"TrailArn": "string"
},
"AwsCloudWatchAlarm": {
"ActionsEnabled": boolean,
"AlarmActions": [ "string" ],
"AlarmArn": "string",
"AlarmConfigurationUpdatedTimestamp": "string",
"AlarmDescription": "string",
"AlarmName": "string",
"ComparisonOperator": "string",
"DatapointsToAlarm": number,
"Dimensions": [
{
"Name": "string",
"Value": "string"
}
],
"EvaluateLowSampleCountPercentile": "string",
"EvaluationPeriods": number,
"ExtendedStatistic": "string",
"InsufficientDataActions": [ "string" ],
"MetricName": "string",
"Namespace": "string",
"OkActions": [ "string" ],
"Period": number,
"Statistic": "string",
"Threshold": number,
"ThresholdMetricId": "string",
"TreatMissingData": "string",
"Unit": "string"
},
"AwsCodeBuildProject": {
"Artifacts": [
{
"ArtifactIdentifier": "string",
"EncryptionDisabled": boolean,
"Location": "string",
"Name": "string",
"NamespaceType": "string",
"OverrideArtifactName": boolean,
"Packaging": "string",
"Path": "string",
"Type": "string"
}
],
"EncryptionKey": "string",
"Environment": {
"Certificate": "string",
"EnvironmentVariables": [
{
"Name": "string",
"Type": "string",
"Value": "string"
}
],
"ImagePullCredentialsType": "string",
"PrivilegedMode": boolean,
"RegistryCredential": {
"Credential": "string",
"CredentialProvider": "string"
},
"Type": "string"
},
"LogsConfig": {
"CloudWatchLogs": {
"GroupName": "string",
"Status": "string",
"StreamName": "string"
},
"S3Logs": {
"EncryptionDisabled": boolean,
"Location": "string",
"Status": "string"
}
},
"Name": "string",
"SecondaryArtifacts": [
{
"ArtifactIdentifier": "string",
"EncryptionDisabled": boolean,
"Location": "string",
"Name": "string",
"NamespaceType": "string",
"OverrideArtifactName": boolean,
"Packaging": "string",
"Path": "string",
"Type": "string"
}
],
"ServiceRole": "string",
"Source": {
"GitCloneDepth": number,
"InsecureSsl": boolean,
"Location": "string",
"Type": "string"
},
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ],
"VpcId": "string"
}
},
"AwsDmsEndpoint": {
"CertificateArn": "string",
"DatabaseName": "string",
"EndpointArn": "string",
"EndpointIdentifier": "string",
"EndpointType": "string",
"EngineName": "string",
"ExternalId": "string",
"ExtraConnectionAttributes": "string",
"KmsKeyId": "string",
"Port": number,
"ServerName": "string",
"SslMode": "string",
"Username": "string"
},
"AwsDmsReplicationInstance": {
"AllocatedStorage": number,
"AutoMinorVersionUpgrade": boolean,
"AvailabilityZone": "string",
"EngineVersion": "string",
"KmsKeyId": "string",
"MultiAZ": boolean,
"PreferredMaintenanceWindow": "string",
"PubliclyAccessible": boolean,
"ReplicationInstanceClass": "string",
"ReplicationInstanceIdentifier": "string",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupIdentifier": "string"
},
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "string"
}
]
},
"AwsDmsReplicationTask": {
"CdcStartPosition": "string",
"CdcStartTime": "string",
"CdcStopPosition": "string",
"Id": "string",
"MigrationType": "string",
"ReplicationInstanceArn": "string",
"ReplicationTaskIdentifier": "string",
"ReplicationTaskSettings": "string",
"ResourceIdentifier": "string",
"SourceEndpointArn": "string",
"TableMappings": "string",
"TargetEndpointArn": "string",
"TaskData": "string"
},
"AwsDynamoDbTable": {
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": "string"
},
"CreationDateTime": "string",
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": "string",
"LastIncreaseDateTime": "string",
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
}
],
"GlobalTableVersion": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"ProvisionedThroughput": {
"LastDecreaseDateTime": "string",
"LastIncreaseDateTime": "string",
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
}
}
],
"KmsMasterKeyId": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string"
}
],
"RestoreSummary": {
"RestoreDateTime": "string",
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SseDescription": {
"InaccessibleEncryptionDateTime": "string",
"KmsMasterKeyArn": "string",
"SseType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string"
},
"AwsEc2ClientVpnEndpoint": {
"AuthenticationOptions": [
{
"ActiveDirectory": {
"DirectoryId": "string"
},
"FederatedAuthentication": {
"SamlProviderArn": "string",
"SelfServiceSamlProviderArn": "string"
},
"MutualAuthentication": {
"ClientRootCertificateChain": "string"
},
"Type": "string"
}
],
"ClientCidrBlock": "string",
"ClientConnectOptions": {
"Enabled": boolean,
"LambdaFunctionArn": "string",
"Status": {
"Code": "string",
"Message": "string"
}
},
"ClientLoginBannerOptions": {
"BannerText": "string",
"Enabled": boolean
},
"ClientVpnEndpointId": "string",
"ConnectionLogOptions": {
"CloudwatchLogGroup": "string",
"CloudwatchLogStream": "string",
"Enabled": boolean
},
"Description": "string",
"DnsServer": [ "string" ],
"SecurityGroupIdSet": [ "string" ],
"SelfServicePortalUrl": "string",
"ServerCertificateArn": "string",
"SessionTimeoutHours": number,
"SplitTunnel": boolean,
"TransportProtocol": "string",
"VpcId": "string",
"VpnPort": number
},
"AwsEc2Eip": {
"AllocationId": "string",
"AssociationId": "string",
"Domain": "string",
"InstanceId": "string",
"NetworkBorderGroup": "string",
"NetworkInterfaceId": "string",
"NetworkInterfaceOwnerId": "string",
"PrivateIpAddress": "string",
"PublicIp": "string",
"PublicIpv4Pool": "string"
},
"AwsEc2Instance": {
"IamInstanceProfileArn": "string",
"ImageId": "string",
"IpV4Addresses": [ "string" ],
"IpV6Addresses": [ "string" ],
"KeyName": "string",
"LaunchedAt": "string",
"MetadataOptions": {
"HttpEndpoint": "string",
"HttpProtocolIpv6": "string",
"HttpPutResponseHopLimit": number,
"HttpTokens": "string",
"InstanceMetadataTags": "string"
},
"Monitoring": {
"State": "string"
},
"NetworkInterfaces": [
{
"NetworkInterfaceId": "string"
}
],
"SubnetId": "string",
"Type": "string",
"VirtualizationType": "string",
"VpcId": "string"
},
"AwsEc2LaunchTemplate": {
"DefaultVersionNumber": number,
"Id": "string",
"LatestVersionNumber": number,
"LaunchTemplateData": {
"BlockDeviceMappingSet": [
{
"DeviceName": "string",
"Ebs": {
"DeleteOnTermination": boolean,
"Encrypted": boolean,
"Iops": number,
"KmsKeyId": "string",
"SnapshotId": "string",
"Throughput": number,
"VolumeSize": number,
"VolumeType": "string"
},
"NoDevice": "string",
"VirtualName": "string"
}
],
"CapacityReservationSpecification": {
"CapacityReservationPreference": "string",
"CapacityReservationTarget": {
"CapacityReservationId": "string",
"CapacityReservationResourceGroupArn": "string"
}
},
"CpuOptions": {
"CoreCount": number,
"ThreadsPerCore": number
},
"CreditSpecification": {
"CpuCredits": "string"
},
"DisableApiStop": boolean,
"DisableApiTermination": boolean,
"EbsOptimized": boolean,
"ElasticGpuSpecificationSet": [
{
"Type": "string"
}
],
"ElasticInferenceAcceleratorSet": [
{
"Count": number,
"Type": "string"
}
],
"EnclaveOptions": {
"Enabled": boolean
},
"HibernationOptions": {
"Configured": boolean
},
"IamInstanceProfile": {
"Arn": "string",
"Name": "string"
},
"ImageId": "string",
"InstanceInitiatedShutdownBehavior": "string",
"InstanceMarketOptions": {
"MarketType": "string",
"SpotOptions": {
"BlockDurationMinutes": number,
"InstanceInterruptionBehavior": "string",
"MaxPrice": "string",
"SpotInstanceType": "string",
"ValidUntil": "string"
}
},
"InstanceRequirements": {
"AcceleratorCount": {
"Max": number,
"Min": number
},
"AcceleratorManufacturers": [ "string" ],
"AcceleratorNames": [ "string" ],
"AcceleratorTotalMemoryMiB": {
"Max": number,
"Min": number
},
"AcceleratorTypes": [ "string" ],
"BareMetal": "string",
"BaselineEbsBandwidthMbps": {
"Max": number,
"Min": number
},
"BurstablePerformance": "string",
"CpuManufacturers": [ "string" ],
"ExcludedInstanceTypes": [ "string" ],
"InstanceGenerations": [ "string" ],
"LocalStorage": "string",
"LocalStorageTypes": [ "string" ],
"MemoryGiBPerVCpu": {
"Max": number,
"Min": number
},
"MemoryMiB": {
"Max": number,
"Min": number
},
"NetworkInterfaceCount": {
"Max": number,
"Min": number
},
"OnDemandMaxPricePercentageOverLowestPrice": number,
"RequireHibernateSupport": boolean,
"SpotMaxPricePercentageOverLowestPrice": number,
"TotalLocalStorageGB": {
"Max": number,
"Min": number
},
"VCpuCount": {
"Max": number,
"Min": number
}
},
"InstanceType": "string",
"KernelId": "string",
"KeyName": "string",
"LicenseSet": [
{
"LicenseConfigurationArn": "string"
}
],
"MaintenanceOptions": {
"AutoRecovery": "string"
},
"MetadataOptions": {
"HttpEndpoint": "string",
"HttpProtocolIpv6": "string",
"HttpPutResponseHopLimit": number,
"HttpTokens": "string",
"InstanceMetadataTags": "string"
},
"Monitoring": {
"Enabled": boolean
},
"NetworkInterfaceSet": [
{
"AssociateCarrierIpAddress": boolean,
"AssociatePublicIpAddress": boolean,
"DeleteOnTermination": boolean,
"Description": "string",
"DeviceIndex": number,
"Groups": [ "string" ],
"InterfaceType": "string",
"Ipv4PrefixCount": number,
"Ipv4Prefixes": [
{
"Ipv4Prefix": "string"
}
],
"Ipv6AddressCount": number,
"Ipv6Addresses": [
{
"Ipv6Address": "string"
}
],
"Ipv6PrefixCount": number,
"Ipv6Prefixes": [
{
"Ipv6Prefix": "string"
}
],
"NetworkCardIndex": number,
"NetworkInterfaceId": "string",
"PrivateIpAddress": "string",
"PrivateIpAddresses": [
{
"Primary": boolean,
"PrivateIpAddress": "string"
}
],
"SecondaryPrivateIpAddressCount": number,
"SubnetId": "string"
}
],
"Placement": {
"Affinity": "string",
"AvailabilityZone": "string",
"GroupName": "string",
"HostId": "string",
"HostResourceGroupArn": "string",
"PartitionNumber": number,
"SpreadDomain": "string",
"Tenancy": "string"
},
"PrivateDnsNameOptions": {
"EnableResourceNameDnsAAAARecord": boolean,
"EnableResourceNameDnsARecord": boolean,
"HostnameType": "string"
},
"RamDiskId": "string",
"SecurityGroupIdSet": [ "string" ],
"SecurityGroupSet": [ "string" ],
"UserData": "string"
},
"LaunchTemplateName": "string"
},
"AwsEc2NetworkAcl": {
"Associations": [
{
"NetworkAclAssociationId": "string",
"NetworkAclId": "string",
"SubnetId": "string"
}
],
"Entries": [
{
"CidrBlock": "string",
"Egress": boolean,
"IcmpTypeCode": {
"Code": number,
"Type": number
},
"Ipv6CidrBlock": "string",
"PortRange": {
"From": number,
"To": number
},
"Protocol": "string",
"RuleAction": "string",
"RuleNumber": number
}
],
"IsDefault": boolean,
"NetworkAclId": "string",
"OwnerId": "string",
"VpcId": "string"
},
"AwsEc2NetworkInterface": {
"Attachment": {
"AttachmentId": "string",
"AttachTime": "string",
"DeleteOnTermination": boolean,
"DeviceIndex": number,
"InstanceId": "string",
"InstanceOwnerId": "string",
"Status": "string"
},
"IpV6Addresses": [
{
"IpV6Address": "string"
}
],
"NetworkInterfaceId": "string",
"PrivateIpAddresses": [
{
"PrivateDnsName": "string",
"PrivateIpAddress": "string"
}
],
"PublicDnsName": "string",
"PublicIp": "string",
"SecurityGroups": [
{
"GroupId": "string",
"GroupName": "string"
}
],
"SourceDestCheck": boolean
},
"AwsEc2RouteTable": {
"AssociationSet": [
{
"AssociationState": {
"State": "string",
"StatusMessage": "string"
},
"GatewayId": "string",
"Main": boolean,
"RouteTableAssociationId": "string",
"RouteTableId": "string",
"SubnetId": "string"
}
],
"OwnerId": "string",
"PropagatingVgwSet": [
{
"GatewayId": "string"
}
],
"RouteSet": [
{
"CarrierGatewayId": "string",
"CoreNetworkArn": "string",
"DestinationCidrBlock": "string",
"DestinationIpv6CidrBlock": "string",
"DestinationPrefixListId": "string",
"EgressOnlyInternetGatewayId": "string",
"GatewayId": "string",
"InstanceId": "string",
"InstanceOwnerId": "string",
"LocalGatewayId": "string",
"NatGatewayId": "string",
"NetworkInterfaceId": "string",
"Origin": "string",
"State": "string",
"TransitGatewayId": "string",
"VpcPeeringConnectionId": "string"
}
],
"RouteTableId": "string",
"VpcId": "string"
},
"AwsEc2SecurityGroup": {
"GroupId": "string",
"GroupName": "string",
"IpPermissions": [
{
"FromPort": number,
"IpProtocol": "string",
"IpRanges": [
{
"CidrIp": "string"
}
],
"Ipv6Ranges": [
{
"CidrIpv6": "string"
}
],
"PrefixListIds": [
{
"PrefixListId": "string"
}
],
"ToPort": number,
"UserIdGroupPairs": [
{
"GroupId": "string",
"GroupName": "string",
"PeeringStatus": "string",
"UserId": "string",
"VpcId": "string",
"VpcPeeringConnectionId": "string"
}
]
}
],
"IpPermissionsEgress": [
{
"FromPort": number,
"IpProtocol": "string",
"IpRanges": [
{
"CidrIp": "string"
}
],
"Ipv6Ranges": [
{
"CidrIpv6": "string"
}
],
"PrefixListIds": [
{
"PrefixListId": "string"
}
],
"ToPort": number,
"UserIdGroupPairs": [
{
"GroupId": "string",
"GroupName": "string",
"PeeringStatus": "string",
"UserId": "string",
"VpcId": "string",
"VpcPeeringConnectionId": "string"
}
]
}
],
"OwnerId": "string",
"VpcId": "string"
},
"AwsEc2Subnet": {
"AssignIpv6AddressOnCreation": boolean,
"AvailabilityZone": "string",
"AvailabilityZoneId": "string",
"AvailableIpAddressCount": number,
"CidrBlock": "string",
"DefaultForAz": boolean,
"Ipv6CidrBlockAssociationSet": [
{
"AssociationId": "string",
"CidrBlockState": "string",
"Ipv6CidrBlock": "string"
}
],
"MapPublicIpOnLaunch": boolean,
"OwnerId": "string",
"State": "string",
"SubnetArn": "string",
"SubnetId": "string",
"VpcId": "string"
},
"AwsEc2TransitGateway": {
"AmazonSideAsn": number,
"AssociationDefaultRouteTableId": "string",
"AutoAcceptSharedAttachments": "string",
"DefaultRouteTableAssociation": "string",
"DefaultRouteTablePropagation": "string",
"Description": "string",
"DnsSupport": "string",
"Id": "string",
"MulticastSupport": "string",
"PropagationDefaultRouteTableId": "string",
"TransitGatewayCidrBlocks": [ "string" ],
"VpnEcmpSupport": "string"
},
"AwsEc2Volume": {
"Attachments": [
{
"AttachTime": "string",
"DeleteOnTermination": boolean,
"InstanceId": "string",
"Status": "string"
}
],
"CreateTime": "string",
"DeviceName": "string",
"Encrypted": boolean,
"KmsKeyId": "string",
"Size": number,
"SnapshotId": "string",
"Status": "string",
"VolumeId": "string",
"VolumeScanStatus": "string",
"VolumeType": "string"
},
"AwsEc2Vpc": {
"CidrBlockAssociationSet": [
{
"AssociationId": "string",
"CidrBlock": "string",
"CidrBlockState": "string"
}
],
"DhcpOptionsId": "string",
"Ipv6CidrBlockAssociationSet": [
{
"AssociationId": "string",
"CidrBlockState": "string",
"Ipv6CidrBlock": "string"
}
],
"State": "string"
},
"AwsEc2VpcEndpointService": {
"AcceptanceRequired": boolean,
"AvailabilityZones": [ "string" ],
"BaseEndpointDnsNames": [ "string" ],
"GatewayLoadBalancerArns": [ "string" ],
"ManagesVpcEndpoints": boolean,
"NetworkLoadBalancerArns": [ "string" ],
"PrivateDnsName": "string",
"ServiceId": "string",
"ServiceName": "string",
"ServiceState": "string",
"ServiceType": [
{
"ServiceType": "string"
}
]
},
"AwsEc2VpcPeeringConnection": {
"AccepterVpcInfo": {
"CidrBlock": "string",
"CidrBlockSet": [
{
"CidrBlock": "string"
}
],
"Ipv6CidrBlockSet": [
{
"Ipv6CidrBlock": "string"
}
],
"OwnerId": "string",
"PeeringOptions": {
"AllowDnsResolutionFromRemoteVpc": boolean,
"AllowEgressFromLocalClassicLinkToRemoteVpc": boolean,
"AllowEgressFromLocalVpcToRemoteClassicLink": boolean
},
"Region": "string",
"VpcId": "string"
},
"ExpirationTime": "string",
"RequesterVpcInfo": {
"CidrBlock": "string",
"CidrBlockSet": [
{
"CidrBlock": "string"
}
],
"Ipv6CidrBlockSet": [
{
"Ipv6CidrBlock": "string"
}
],
"OwnerId": "string",
"PeeringOptions": {
"AllowDnsResolutionFromRemoteVpc": boolean,
"AllowEgressFromLocalClassicLinkToRemoteVpc": boolean,
"AllowEgressFromLocalVpcToRemoteClassicLink": boolean
},
"Region": "string",
"VpcId": "string"
},
"Status": {
"Code": "string",
"Message": "string"
},
"VpcPeeringConnectionId": "string"
},
"AwsEc2VpnConnection": {
"Category": "string",
"CustomerGatewayConfiguration": "string",
"CustomerGatewayId": "string",
"Options": {
"StaticRoutesOnly": boolean,
"TunnelOptions": [
{
"DpdTimeoutSeconds": number,
"IkeVersions": [ "string" ],
"OutsideIpAddress": "string",
"Phase1DhGroupNumbers": [ number ],
"Phase1EncryptionAlgorithms": [ "string" ],
"Phase1IntegrityAlgorithms": [ "string" ],
"Phase1LifetimeSeconds": number,
"Phase2DhGroupNumbers": [ number ],
"Phase2EncryptionAlgorithms": [ "string" ],
"Phase2IntegrityAlgorithms": [ "string" ],
"Phase2LifetimeSeconds": number,
"PreSharedKey": "string",
"RekeyFuzzPercentage": number,
"RekeyMarginTimeSeconds": number,
"ReplayWindowSize": number,
"TunnelInsideCidr": "string"
}
]
},
"Routes": [
{
"DestinationCidrBlock": "string",
"State": "string"
}
],
"State": "string",
"TransitGatewayId": "string",
"Type": "string",
"VgwTelemetry": [
{
"AcceptedRouteCount": number,
"CertificateArn": "string",
"LastStatusChange": "string",
"OutsideIpAddress": "string",
"Status": "string",
"StatusMessage": "string"
}
],
"VpnConnectionId": "string",
"VpnGatewayId": "string"
},
"AwsEcrContainerImage": {
"Architecture": "string",
"ImageDigest": "string",
"ImagePublishedAt": "string",
"ImageTags": [ "string" ],
"RegistryId": "string",
"RepositoryName": "string"
},
"AwsEcrRepository": {
"Arn": "string",
"ImageScanningConfiguration": {
"ScanOnPush": boolean
},
"ImageTagMutability": "string",
"LifecyclePolicy": {
"LifecyclePolicyText": "string",
"RegistryId": "string"
},
"RepositoryName": "string",
"RepositoryPolicyText": "string"
},
"AwsEcsCluster": {
"ActiveServicesCount": number,
"CapacityProviders": [ "string" ],
"ClusterArn": "string",
"ClusterName": "string",
"ClusterSettings": [
{
"Name": "string",
"Value": "string"
}
],
"Configuration": {
"ExecuteCommandConfiguration": {
"KmsKeyId": "string",
"LogConfiguration": {
"CloudWatchEncryptionEnabled": boolean,
"CloudWatchLogGroupName": "string",
"S3BucketName": "string",
"S3EncryptionEnabled": boolean,
"S3KeyPrefix": "string"
},
"Logging": "string"
}
},
"DefaultCapacityProviderStrategy": [
{
"Base": number,
"CapacityProvider": "string",
"Weight": number
}
],
"RegisteredContainerInstancesCount": number,
"RunningTasksCount": number,
"Status": "string"
},
"AwsEcsContainer": {
"Image": "string",
"MountPoints": [
{
"ContainerPath": "string",
"SourceVolume": "string"
}
],
"Name": "string",
"Privileged": boolean
},
"AwsEcsService": {
"CapacityProviderStrategy": [
{
"Base": number,
"CapacityProvider": "string",
"Weight": number
}
],
"Cluster": "string",
"DeploymentConfiguration": {
"DeploymentCircuitBreaker": {
"Enable": boolean,
"Rollback": boolean
},
"MaximumPercent": number,
"MinimumHealthyPercent": number
},
"DeploymentController": {
"Type": "string"
},
"DesiredCount": number,
"EnableEcsManagedTags": boolean,
"EnableExecuteCommand": boolean,
"HealthCheckGracePeriodSeconds": number,
"LaunchType": "string",
"LoadBalancers": [
{
"ContainerName": "string",
"ContainerPort": number,
"LoadBalancerName": "string",
"TargetGroupArn": "string"
}
],
"Name": "string",
"NetworkConfiguration": {
"AwsVpcConfiguration": {
"AssignPublicIp": "string",
"SecurityGroups": [ "string" ],
"Subnets": [ "string" ]
}
},
"PlacementConstraints": [
{
"Expression": "string",
"Type": "string"
}
],
"PlacementStrategies": [
{
"Field": "string",
"Type": "string"
}
],
"PlatformVersion": "string",
"PropagateTags": "string",
"Role": "string",
"SchedulingStrategy": "string",
"ServiceArn": "string",
"ServiceName": "string",
"ServiceRegistries": [
{
"ContainerName": "string",
"ContainerPort": number,
"Port": number,
"RegistryArn": "string"
}
],
"TaskDefinition": "string"
},
"AwsEcsTask": {
"ClusterArn": "string",
"Containers": [
{
"Image": "string",
"MountPoints": [
{
"ContainerPath": "string",
"SourceVolume": "string"
}
],
"Name": "string",
"Privileged": boolean
}
],
"CreatedAt": "string",
"Group": "string",
"StartedAt": "string",
"StartedBy": "string",
"TaskDefinitionArn": "string",
"Version": "string",
"Volumes": [
{
"Host": {
"SourcePath": "string"
},
"Name": "string"
}
]
},
"AwsEcsTaskDefinition": {
"ContainerDefinitions": [
{
"Command": [ "string" ],
"Cpu": number,
"DependsOn": [
{
"Condition": "string",
"ContainerName": "string"
}
],
"DisableNetworking": boolean,
"DnsSearchDomains": [ "string" ],
"DnsServers": [ "string" ],
"DockerLabels": {
"string" : "string"
},
"DockerSecurityOptions": [ "string" ],
"EntryPoint": [ "string" ],
"Environment": [
{
"Name": "string",
"Value": "string"
}
],
"EnvironmentFiles": [
{
"Type": "string",
"Value": "string"
}
],
"Essential": boolean,
"ExtraHosts": [
{
"Hostname": "string",
"IpAddress": "string"
}
],
"FirelensConfiguration": {
"Options": {
"string" : "string"
},
"Type": "string"
},
"HealthCheck": {
"Command": [ "string" ],
"Interval": number,
"Retries": number,
"StartPeriod": number,
"Timeout": number
},
"Hostname": "string",
"Image": "string",
"Interactive": boolean,
"Links": [ "string" ],
"LinuxParameters": {
"Capabilities": {
"Add": [ "string" ],
"Drop": [ "string" ]
},
"Devices": [
{
"ContainerPath": "string",
"HostPath": "string",
"Permissions": [ "string" ]
}
],
"InitProcessEnabled": boolean,
"MaxSwap": number,
"SharedMemorySize": number,
"Swappiness": number,
"Tmpfs": [
{
"ContainerPath": "string",
"MountOptions": [ "string" ],
"Size": number
}
]
},
"LogConfiguration": {
"LogDriver": "string",
"Options": {
"string" : "string"
},
"SecretOptions": [
{
"Name": "string",
"ValueFrom": "string"
}
]
},
"Memory": number,
"MemoryReservation": number,
"MountPoints": [
{
"ContainerPath": "string",
"ReadOnly": boolean,
"SourceVolume": "string"
}
],
"Name": "string",
"PortMappings": [
{
"ContainerPort": number,
"HostPort": number,
"Protocol": "string"
}
],
"Privileged": boolean,
"PseudoTerminal": boolean,
"ReadonlyRootFilesystem": boolean,
"RepositoryCredentials": {
"CredentialsParameter": "string"
},
"ResourceRequirements": [
{
"Type": "string",
"Value": "string"
}
],
"Secrets": [
{
"Name": "string",
"ValueFrom": "string"
}
],
"StartTimeout": number,
"StopTimeout": number,
"SystemControls": [
{
"Namespace": "string",
"Value": "string"
}
],
"Ulimits": [
{
"HardLimit": number,
"Name": "string",
"SoftLimit": number
}
],
"User": "string",
"VolumesFrom": [
{
"ReadOnly": boolean,
"SourceContainer": "string"
}
],
"WorkingDirectory": "string"
}
],
"Cpu": "string",
"ExecutionRoleArn": "string",
"Family": "string",
"InferenceAccelerators": [
{
"DeviceName": "string",
"DeviceType": "string"
}
],
"IpcMode": "string",
"Memory": "string",
"NetworkMode": "string",
"PidMode": "string",
"PlacementConstraints": [
{
"Expression": "string",
"Type": "string"
}
],
"ProxyConfiguration": {
"ContainerName": "string",
"ProxyConfigurationProperties": [
{
"Name": "string",
"Value": "string"
}
],
"Type": "string"
},
"RequiresCompatibilities": [ "string" ],
"Status": "string",
"TaskRoleArn": "string",
"Volumes": [
{
"DockerVolumeConfiguration": {
"Autoprovision": boolean,
"Driver": "string",
"DriverOpts": {
"string" : "string"
},
"Labels": {
"string" : "string"
},
"Scope": "string"
},
"EfsVolumeConfiguration": {
"AuthorizationConfig": {
"AccessPointId": "string",
"Iam": "string"
},
"FilesystemId": "string",
"RootDirectory": "string",
"TransitEncryption": "string",
"TransitEncryptionPort": number
},
"Host": {
"SourcePath": "string"
},
"Name": "string"
}
]
},
"AwsEfsAccessPoint": {
"AccessPointId": "string",
"Arn": "string",
"ClientToken": "string",
"FileSystemId": "string",
"PosixUser": {
"Gid": "string",
"SecondaryGids": [ "string" ],
"Uid": "string"
},
"RootDirectory": {
"CreationInfo": {
"OwnerGid": "string",
"OwnerUid": "string",
"Permissions": "string"
},
"Path": "string"
}
},
"AwsEksCluster": {
"Arn": "string",
"CertificateAuthorityData": "string",
"ClusterStatus": "string",
"Endpoint": "string",
"Logging": {
"ClusterLogging": [
{
"Enabled": boolean,
"Types": [ "string" ]
}
]
},
"Name": "string",
"ResourcesVpcConfig": {
"EndpointPublicAccess": boolean,
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"RoleArn": "string",
"Version": "string"
},
"AwsElasticBeanstalkEnvironment": {
"ApplicationName": "string",
"Cname": "string",
"DateCreated": "string",
"DateUpdated": "string",
"Description": "string",
"EndpointUrl": "string",
"EnvironmentArn": "string",
"EnvironmentId": "string",
"EnvironmentLinks": [
{
"EnvironmentName": "string",
"LinkName": "string"
}
],
"EnvironmentName": "string",
"OptionSettings": [
{
"Namespace": "string",
"OptionName": "string",
"ResourceName": "string",
"Value": "string"
}
],
"PlatformArn": "string",
"SolutionStackName": "string",
"Status": "string",
"Tier": {
"Name": "string",
"Type": "string",
"Version": "string"
},
"VersionLabel": "string"
},
"AwsElasticsearchDomain": {
"AccessPolicies": "string",
"DomainEndpointOptions": {
"EnforceHTTPS": boolean,
"TLSSecurityPolicy": "string"
},
"DomainId": "string",
"DomainName": "string",
"ElasticsearchClusterConfig": {
"DedicatedMasterCount": number,
"DedicatedMasterEnabled": boolean,
"DedicatedMasterType": "string",
"InstanceCount": number,
"InstanceType": "string",
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": number
},
"ZoneAwarenessEnabled": boolean
},
"ElasticsearchVersion": "string",
"EncryptionAtRestOptions": {
"Enabled": boolean,
"KmsKeyId": "string"
},
"Endpoint": "string",
"Endpoints": {
"string" : "string"
},
"LogPublishingOptions": {
"AuditLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
},
"IndexSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
},
"SearchSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
}
},
"NodeToNodeEncryptionOptions": {
"Enabled": boolean
},
"ServiceSoftwareOptions": {
"AutomatedUpdateDate": "string",
"Cancellable": boolean,
"CurrentVersion": "string",
"Description": "string",
"NewVersion": "string",
"UpdateAvailable": boolean,
"UpdateStatus": "string"
},
"VPCOptions": {
"AvailabilityZones": [ "string" ],
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VPCId": "string"
}
},
"AwsElbLoadBalancer": {
"AvailabilityZones": [ "string" ],
"BackendServerDescriptions": [
{
"InstancePort": number,
"PolicyNames": [ "string" ]
}
],
"CanonicalHostedZoneName": "string",
"CanonicalHostedZoneNameID": "string",
"CreatedTime": "string",
"DnsName": "string",
"HealthCheck": {
"HealthyThreshold": number,
"Interval": number,
"Target": "string",
"Timeout": number,
"UnhealthyThreshold": number
},
"Instances": [
{
"InstanceId": "string"
}
],
"ListenerDescriptions": [
{
"Listener": {
"InstancePort": number,
"InstanceProtocol": "string",
"LoadBalancerPort": number,
"Protocol": "string",
"SslCertificateId": "string"
},
"PolicyNames": [ "string" ]
}
],
"LoadBalancerAttributes": {
"AccessLog": {
"EmitInterval": number,
"Enabled": boolean,
"S3BucketName": "string",
"S3BucketPrefix": "string"
},
"AdditionalAttributes": [
{
"Key": "string",
"Value": "string"
}
],
"ConnectionDraining": {
"Enabled": boolean,
"Timeout": number
},
"ConnectionSettings": {
"IdleTimeout": number
},
"CrossZoneLoadBalancing": {
"Enabled": boolean
}
},
"LoadBalancerName": "string",
"Policies": {
"AppCookieStickinessPolicies": [
{
"CookieName": "string",
"PolicyName": "string"
}
],
"LbCookieStickinessPolicies": [
{
"CookieExpirationPeriod": number,
"PolicyName": "string"
}
],
"OtherPolicies": [ "string" ]
},
"Scheme": "string",
"SecurityGroups": [ "string" ],
"SourceSecurityGroup": {
"GroupName": "string",
"OwnerAlias": "string"
},
"Subnets": [ "string" ],
"VpcId": "string"
},
"AwsElbv2LoadBalancer": {
"AvailabilityZones": [
{
"SubnetId": "string",
"ZoneName": "string"
}
],
"CanonicalHostedZoneId": "string",
"CreatedTime": "string",
"DNSName": "string",
"IpAddressType": "string",
"LoadBalancerAttributes": [
{
"Key": "string",
"Value": "string"
}
],
"Scheme": "string",
"SecurityGroups": [ "string" ],
"State": {
"Code": "string",
"Reason": "string"
},
"Type": "string",
"VpcId": "string"
},
"AwsEventSchemasRegistry": {
"Description": "string",
"RegistryArn": "string",
"RegistryName": "string"
},
"AwsEventsEndpoint": {
"Arn": "string",
"Description": "string",
"EndpointId": "string",
"EndpointUrl": "string",
"EventBuses": [
{
"EventBusArn": "string"
}
],
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {
"Route": "string"
}
}
},
"State": "string",
"StateReason": "string"
},
"AwsEventsEventbus": {
"Arn": "string",
"Name": "string",
"Policy": "string"
},
"AwsGuardDutyDetector": {
"DataSources": {
"CloudTrail": {
"Status": "string"
},
"DnsLogs": {
"Status": "string"
},
"FlowLogs": {
"Status": "string"
},
"Kubernetes": {
"AuditLogs": {
"Status": "string"
}
},
"MalwareProtection": {
"ScanEc2InstanceWithFindings": {
"EbsVolumes": {
"Reason": "string",
"Status": "string"
}
},
"ServiceRole": "string"
},
"S3Logs": {
"Status": "string"
}
},
"Features": [
{
"Name": "string",
"Status": "string"
}
],
"FindingPublishingFrequency": "string",
"ServiceRole": "string",
"Status": "string"
},
"AwsIamAccessKey": {
"AccessKeyId": "string",
"AccountId": "string",
"CreatedAt": "string",
"PrincipalId": "string",
"PrincipalName": "string",
"PrincipalType": "string",
"SessionContext": {
"Attributes": {
"CreationDate": "string",
"MfaAuthenticated": boolean
},
"SessionIssuer": {
"AccountId": "string",
"Arn": "string",
"PrincipalId": "string",
"Type": "string",
"UserName": "string"
}
},
"Status": "string",
"UserName": "string"
},
"AwsIamGroup": {
"AttachedManagedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"GroupPolicyList": [
{
"PolicyName": "string"
}
],
"Path": "string"
},
"AwsIamPolicy": {
"AttachmentCount": number,
"CreateDate": "string",
"DefaultVersionId": "string",
"Description": "string",
"IsAttachable": boolean,
"Path": "string",
"PermissionsBoundaryUsageCount": number,
"PolicyId": "string",
"PolicyName": "string",
"PolicyVersionList": [
{
"CreateDate": "string",
"IsDefaultVersion": boolean,
"VersionId": "string"
}
],
"UpdateDate": "string"
},
"AwsIamRole": {
"AssumeRolePolicyDocument": "string",
"AttachedManagedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"CreateDate": "string",
"InstanceProfileList": [
{
"Arn": "string",
"CreateDate": "string",
"InstanceProfileId": "string",
"InstanceProfileName": "string",
"Path": "string",
"Roles": [
{
"Arn": "string",
"AssumeRolePolicyDocument": "string",
"CreateDate": "string",
"Path": "string",
"RoleId": "string",
"RoleName": "string"
}
]
}
],
"MaxSessionDuration": number,
"Path": "string",
"PermissionsBoundary": {
"PermissionsBoundaryArn": "string",
"PermissionsBoundaryType": "string"
},
"RoleId": "string",
"RoleName": "string",
"RolePolicyList": [
{
"PolicyName": "string"
}
]
},
"AwsIamUser": {
"AttachedManagedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"CreateDate": "string",
"GroupList": [ "string" ],
"Path": "string",
"PermissionsBoundary": {
"PermissionsBoundaryArn": "string",
"PermissionsBoundaryType": "string"
},
"UserId": "string",
"UserName": "string",
"UserPolicyList": [
{
"PolicyName": "string"
}
]
},
"AwsKinesisStream": {
"Arn": "string",
"Name": "string",
"RetentionPeriodHours": number,
"ShardCount": number,
"StreamEncryption": {
"EncryptionType": "string",
"KeyId": "string"
}
},
"AwsKmsKey": {
"AWSAccountId": "string",
"CreationDate": number,
"Description": "string",
"KeyId": "string",
"KeyManager": "string",
"KeyRotationStatus": boolean,
"KeyState": "string",
"Origin": "string"
},
"AwsLambdaFunction": {
"Architectures": [ "string" ],
"Code": {
"S3Bucket": "string",
"S3Key": "string",
"S3ObjectVersion": "string",
"ZipFile": "string"
},
"CodeSha256": "string",
"DeadLetterConfig": {
"TargetArn": "string"
},
"Environment": {
"Error": {
"ErrorCode": "string",
"Message": "string"
},
"Variables": {
"string" : "string"
}
},
"FunctionName": "string",
"Handler": "string",
"KmsKeyArn": "string",
"LastModified": "string",
"Layers": [
{
"Arn": "string",
"CodeSize": number
}
],
"MasterArn": "string",
"MemorySize": number,
"PackageType": "string",
"RevisionId": "string",
"Role": "string",
"Runtime": "string",
"Timeout": number,
"TracingConfig": {
"Mode": "string"
},
"Version": "string",
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VpcId": "string"
}
},
"AwsLambdaLayerVersion": {
"CompatibleRuntimes": [ "string" ],
"CreatedDate": "string",
"Version": number
},
"AwsMskCluster": {
"ClusterInfo": {
"ClientAuthentication": {
"Sasl": {
"Iam": {
"Enabled": boolean
},
"Scram": {
"Enabled": boolean
}
},
"Tls": {
"CertificateAuthorityArnList": [ "string" ],
"Enabled": boolean
},
"Unauthenticated": {
"Enabled": boolean
}
},
"ClusterName": "string",
"CurrentVersion": "string",
"EncryptionInfo": {
"EncryptionAtRest": {
"DataVolumeKMSKeyId": "string"
},
"EncryptionInTransit": {
"ClientBroker": "string",
"InCluster": boolean
}
},
"EnhancedMonitoring": "string",
"NumberOfBrokerNodes": number
}
},
"AwsNetworkFirewallFirewall": {
"DeleteProtection": boolean,
"Description": "string",
"FirewallArn": "string",
"FirewallId": "string",
"FirewallName": "string",
"FirewallPolicyArn": "string",
"FirewallPolicyChangeProtection": boolean,
"SubnetChangeProtection": boolean,
"SubnetMappings": [
{
"SubnetId": "string"
}
],
"VpcId": "string"
},
"AwsNetworkFirewallFirewallPolicy": {
"Description": "string",
"FirewallPolicy": {
"StatefulRuleGroupReferences": [
{
"ResourceArn": "string"
}
],
"StatelessCustomActions": [
{
"ActionDefinition": {
"PublishMetricAction": {
"Dimensions": [
{
"Value": "string"
}
]
}
},
"ActionName": "string"
}
],
"StatelessDefaultActions": [ "string" ],
"StatelessFragmentDefaultActions": [ "string" ],
"StatelessRuleGroupReferences": [
{
"Priority": number,
"ResourceArn": "string"
}
]
},
"FirewallPolicyArn": "string",
"FirewallPolicyId": "string",
"FirewallPolicyName": "string"
},
"AwsNetworkFirewallRuleGroup": {
"Capacity": number,
"Description": "string",
"RuleGroup": {
"RulesSource": {
"RulesSourceList": {
"GeneratedRulesType": "string",
"Targets": [ "string" ],
"TargetTypes": [ "string" ]
},
"RulesString": "string",
"StatefulRules": [
{
"Action": "string",
"Header": {
"Destination": "string",
"DestinationPort": "string",
"Direction": "string",
"Protocol": "string",
"Source": "string",
"SourcePort": "string"
},
"RuleOptions": [
{
"Keyword": "string",
"Settings": [ "string" ]
}
]
}
],
"StatelessRulesAndCustomActions": {
"CustomActions": [
{
"ActionDefinition": {
"PublishMetricAction": {
"Dimensions": [
{
"Value": "string"
}
]
}
},
"ActionName": "string"
}
],
"StatelessRules": [
{
"Priority": number,
"RuleDefinition": {
"Actions": [ "string" ],
"MatchAttributes": {
"DestinationPorts": [
{
"FromPort": number,
"ToPort": number
}
],
"Destinations": [
{
"AddressDefinition": "string"
}
],
"Protocols": [ number ],
"SourcePorts": [
{
"FromPort": number,
"ToPort": number
}
],
"Sources": [
{
"AddressDefinition": "string"
}
],
"TcpFlags": [
{
"Flags": [ "string" ],
"Masks": [ "string" ]
}
]
}
}
}
]
}
},
"RuleVariables": {
"IpSets": {
"Definition": [ "string" ]
},
"PortSets": {
"Definition": [ "string" ]
}
}
},
"RuleGroupArn": "string",
"RuleGroupId": "string",
"RuleGroupName": "string",
"Type": "string"
},
"AwsOpenSearchServiceDomain": {
"AccessPolicies": "string",
"AdvancedSecurityOptions": {
"Enabled": boolean,
"InternalUserDatabaseEnabled": boolean,
"MasterUserOptions": {
"MasterUserArn": "string",
"MasterUserName": "string",
"MasterUserPassword": "string"
}
},
"Arn": "string",
"ClusterConfig": {
"DedicatedMasterCount": number,
"DedicatedMasterEnabled": boolean,
"DedicatedMasterType": "string",
"InstanceCount": number,
"InstanceType": "string",
"WarmCount": number,
"WarmEnabled": boolean,
"WarmType": "string",
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": number
},
"ZoneAwarenessEnabled": boolean
},
"DomainEndpoint": "string",
"DomainEndpointOptions": {
"CustomEndpoint": "string",
"CustomEndpointCertificateArn": "string",
"CustomEndpointEnabled": boolean,
"EnforceHTTPS": boolean,
"TLSSecurityPolicy": "string"
},
"DomainEndpoints": {
"string" : "string"
},
"DomainName": "string",
"EncryptionAtRestOptions": {
"Enabled": boolean,
"KmsKeyId": "string"
},
"EngineVersion": "string",
"Id": "string",
"LogPublishingOptions": {
"AuditLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
},
"IndexSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
},
"SearchSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
}
},
"NodeToNodeEncryptionOptions": {
"Enabled": boolean
},
"ServiceSoftwareOptions": {
"AutomatedUpdateDate": "string",
"Cancellable": boolean,
"CurrentVersion": "string",
"Description": "string",
"NewVersion": "string",
"OptionalDeployment": boolean,
"UpdateAvailable": boolean,
"UpdateStatus": "string"
},
"VpcOptions": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"AwsRdsDbCluster": {
"ActivityStreamStatus": "string",
"AllocatedStorage": number,
"AssociatedRoles": [
{
"RoleArn": "string",
"Status": "string"
}
],
"AutoMinorVersionUpgrade": boolean,
"AvailabilityZones": [ "string" ],
"BackupRetentionPeriod": number,
"ClusterCreateTime": "string",
"CopyTagsToSnapshot": boolean,
"CrossAccountClone": boolean,
"CustomEndpoints": [ "string" ],
"DatabaseName": "string",
"DbClusterIdentifier": "string",
"DbClusterMembers": [
{
"DbClusterParameterGroupStatus": "string",
"DbInstanceIdentifier": "string",
"IsClusterWriter": boolean,
"PromotionTier": number
}
],
"DbClusterOptionGroupMemberships": [
{
"DbClusterOptionGroupName": "string",
"Status": "string"
}
],
"DbClusterParameterGroup": "string",
"DbClusterResourceId": "string",
"DbSubnetGroup": "string",
"DeletionProtection": boolean,
"DomainMemberships": [
{
"Domain": "string",
"Fqdn": "string",
"IamRoleName": "string",
"Status": "string"
}
],
"EnabledCloudWatchLogsExports": [ "string" ],
"Endpoint": "string",
"Engine": "string",
"EngineMode": "string",
"EngineVersion": "string",
"HostedZoneId": "string",
"HttpEndpointEnabled": boolean,
"IamDatabaseAuthenticationEnabled": boolean,
"KmsKeyId": "string",
"MasterUsername": "string",
"MultiAz": boolean,
"Port": number,
"PreferredBackupWindow": "string",
"PreferredMaintenanceWindow": "string",
"ReaderEndpoint": "string",
"ReadReplicaIdentifiers": [ "string" ],
"Status": "string",
"StorageEncrypted": boolean,
"VpcSecurityGroups": [
{
"Status": "string",
"VpcSecurityGroupId": "string"
}
]
},
"AwsRdsDbClusterSnapshot": {
"AllocatedStorage": number,
"AvailabilityZones": [ "string" ],
"ClusterCreateTime": "string",
"DbClusterIdentifier": "string",
"DbClusterSnapshotAttributes": [
{
"AttributeName": "string",
"AttributeValues": [ "string" ]
}
],
"DbClusterSnapshotIdentifier": "string",
"Engine": "string",
"EngineVersion": "string",
"IamDatabaseAuthenticationEnabled": boolean,
"KmsKeyId": "string",
"LicenseModel": "string",
"MasterUsername": "string",
"PercentProgress": number,
"Port": number,
"SnapshotCreateTime": "string",
"SnapshotType": "string",
"Status": "string",
"StorageEncrypted": boolean,
"VpcId": "string"
},
"AwsRdsDbInstance": {
"AllocatedStorage": number,
"AssociatedRoles": [
{
"FeatureName": "string",
"RoleArn": "string",
"Status": "string"
}
],
"AutoMinorVersionUpgrade": boolean,
"AvailabilityZone": "string",
"BackupRetentionPeriod": number,
"CACertificateIdentifier": "string",
"CharacterSetName": "string",
"CopyTagsToSnapshot": boolean,
"DBClusterIdentifier": "string",
"DBInstanceClass": "string",
"DBInstanceIdentifier": "string",
"DbInstancePort": number,
"DbInstanceStatus": "string",
"DbiResourceId": "string",
"DBName": "string",
"DbParameterGroups": [
{
"DbParameterGroupName": "string",
"ParameterApplyStatus": "string"
}
],
"DbSecurityGroups": [ "string" ],
"DbSubnetGroup": {
"DbSubnetGroupArn": "string",
"DbSubnetGroupDescription": "string",
"DbSubnetGroupName": "string",
"SubnetGroupStatus": "string",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "string"
},
"SubnetIdentifier": "string",
"SubnetStatus": "string"
}
],
"VpcId": "string"
},
"DeletionProtection": boolean,
"DomainMemberships": [
{
"Domain": "string",
"Fqdn": "string",
"IamRoleName": "string",
"Status": "string"
}
],
"EnabledCloudWatchLogsExports": [ "string" ],
"Endpoint": {
"Address": "string",
"HostedZoneId": "string",
"Port": number
},
"Engine": "string",
"EngineVersion": "string",
"EnhancedMonitoringResourceArn": "string",
"IAMDatabaseAuthenticationEnabled": boolean,
"InstanceCreateTime": "string",
"Iops": number,
"KmsKeyId": "string",
"LatestRestorableTime": "string",
"LicenseModel": "string",
"ListenerEndpoint": {
"Address": "string",
"HostedZoneId": "string",
"Port": number
},
"MasterUsername": "string",
"MaxAllocatedStorage": number,
"MonitoringInterval": number,
"MonitoringRoleArn": "string",
"MultiAz": boolean,
"OptionGroupMemberships": [
{
"OptionGroupName": "string",
"Status": "string"
}
],
"PendingModifiedValues": {
"AllocatedStorage": number,
"BackupRetentionPeriod": number,
"CaCertificateIdentifier": "string",
"DbInstanceClass": "string",
"DbInstanceIdentifier": "string",
"DbSubnetGroupName": "string",
"EngineVersion": "string",
"Iops": number,
"LicenseModel": "string",
"MasterUserPassword": "string",
"MultiAZ": boolean,
"PendingCloudWatchLogsExports": {
"LogTypesToDisable": [ "string" ],
"LogTypesToEnable": [ "string" ]
},
"Port": number,
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
],
"StorageType": "string"
},
"PerformanceInsightsEnabled": boolean,
"PerformanceInsightsKmsKeyId": "string",
"PerformanceInsightsRetentionPeriod": number,
"PreferredBackupWindow": "string",
"PreferredMaintenanceWindow": "string",
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
],
"PromotionTier": number,
"PubliclyAccessible": boolean,
"ReadReplicaDBClusterIdentifiers": [ "string" ],
"ReadReplicaDBInstanceIdentifiers": [ "string" ],
"ReadReplicaSourceDBInstanceIdentifier": "string",
"SecondaryAvailabilityZone": "string",
"StatusInfos": [
{
"Message": "string",
"Normal": boolean,
"Status": "string",
"StatusType": "string"
}
],
"StorageEncrypted": boolean,
"StorageType": "string",
"TdeCredentialArn": "string",
"Timezone": "string",
"VpcSecurityGroups": [
{
"Status": "string",
"VpcSecurityGroupId": "string"
}
]
},
"AwsRdsDbSecurityGroup": {
"DbSecurityGroupArn": "string",
"DbSecurityGroupDescription": "string",
"DbSecurityGroupName": "string",
"Ec2SecurityGroups": [
{
"Ec2SecurityGroupId": "string",
"Ec2SecurityGroupName": "string",
"Ec2SecurityGroupOwnerId": "string",
"Status": "string"
}
],
"IpRanges": [
{
"CidrIp": "string",
"Status": "string"
}
],
"OwnerId": "string",
"VpcId": "string"
},
"AwsRdsDbSnapshot": {
"AllocatedStorage": number,
"AvailabilityZone": "string",
"DbInstanceIdentifier": "string",
"DbiResourceId": "string",
"DbSnapshotIdentifier": "string",
"Encrypted": boolean,
"Engine": "string",
"EngineVersion": "string",
"IamDatabaseAuthenticationEnabled": boolean,
"InstanceCreateTime": "string",
"Iops": number,
"KmsKeyId": "string",
"LicenseModel": "string",
"MasterUsername": "string",
"OptionGroupName": "string",
"PercentProgress": number,
"Port": number,
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
],
"SnapshotCreateTime": "string",
"SnapshotType": "string",
"SourceDbSnapshotIdentifier": "string",
"SourceRegion": "string",
"Status": "string",
"StorageType": "string",
"TdeCredentialArn": "string",
"Timezone": "string",
"VpcId": "string"
},
"AwsRdsEventSubscription": {
"CustomerAwsId": "string",
"CustSubscriptionId": "string",
"Enabled": boolean,
"EventCategoriesList": [ "string" ],
"EventSubscriptionArn": "string",
"SnsTopicArn": "string",
"SourceIdsList": [ "string" ],
"SourceType": "string",
"Status": "string",
"SubscriptionCreationTime": "string"
},
"AwsRedshiftCluster": {
"AllowVersionUpgrade": boolean,
"AutomatedSnapshotRetentionPeriod": number,
"AvailabilityZone": "string",
"ClusterAvailabilityStatus": "string",
"ClusterCreateTime": "string",
"ClusterIdentifier": "string",
"ClusterNodes": [
{
"NodeRole": "string",
"PrivateIpAddress": "string",
"PublicIpAddress": "string"
}
],
"ClusterParameterGroups": [
{
"ClusterParameterStatusList": [
{
"ParameterApplyErrorDescription": "string",
"ParameterApplyStatus": "string",
"ParameterName": "string"
}
],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
}
],
"ClusterPublicKey": "string",
"ClusterRevisionNumber": "string",
"ClusterSecurityGroups": [
{
"ClusterSecurityGroupName": "string",
"Status": "string"
}
],
"ClusterSnapshotCopyStatus": {
"DestinationRegion": "string",
"ManualSnapshotRetentionPeriod": number,
"RetentionPeriod": number,
"SnapshotCopyGrantName": "string"
},
"ClusterStatus": "string",
"ClusterSubnetGroupName": "string",
"ClusterVersion": "string",
"DBName": "string",
"DeferredMaintenanceWindows": [
{
"DeferMaintenanceEndTime": "string",
"DeferMaintenanceIdentifier": "string",
"DeferMaintenanceStartTime": "string"
}
],
"ElasticIpStatus": {
"ElasticIp": "string",
"Status": "string"
},
"ElasticResizeNumberOfNodeOptions": "string",
"Encrypted": boolean,
"Endpoint": {
"Address": "string",
"Port": number
},
"EnhancedVpcRouting": boolean,
"ExpectedNextSnapshotScheduleTime": "string",
"ExpectedNextSnapshotScheduleTimeStatus": "string",
"HsmStatus": {
"HsmClientCertificateIdentifier": "string",
"HsmConfigurationIdentifier": "string",
"Status": "string"
},
"IamRoles": [
{
"ApplyStatus": "string",
"IamRoleArn": "string"
}
],
"KmsKeyId": "string",
"LoggingStatus": {
"BucketName": "string",
"LastFailureMessage": "string",
"LastFailureTime": "string",
"LastSuccessfulDeliveryTime": "string",
"LoggingEnabled": boolean,
"S3KeyPrefix": "string"
},
"MaintenanceTrackName": "string",
"ManualSnapshotRetentionPeriod": number,
"MasterUsername": "string",
"NextMaintenanceWindowStartTime": "string",
"NodeType": "string",
"NumberOfNodes": number,
"PendingActions": [ "string" ],
"PendingModifiedValues": {
"AutomatedSnapshotRetentionPeriod": number,
"ClusterIdentifier": "string",
"ClusterType": "string",
"ClusterVersion": "string",
"EncryptionType": "string",
"EnhancedVpcRouting": boolean,
"MaintenanceTrackName": "string",
"MasterUserPassword": "string",
"NodeType": "string",
"NumberOfNodes": number,
"PubliclyAccessible": boolean
},
"PreferredMaintenanceWindow": "string",
"PubliclyAccessible": boolean,
"ResizeInfo": {
"AllowCancelResize": boolean,
"ResizeType": "string"
},
"RestoreStatus": {
"CurrentRestoreRateInMegaBytesPerSecond": number,
"ElapsedTimeInSeconds": number,
"EstimatedTimeToCompletionInSeconds": number,
"ProgressInMegaBytes": number,
"SnapshotSizeInMegaBytes": number,
"Status": "string"
},
"SnapshotScheduleIdentifier": "string",
"SnapshotScheduleState": "string",
"VpcId": "string",
"VpcSecurityGroups": [
{
"Status": "string",
"VpcSecurityGroupId": "string"
}
]
},
"AwsRoute53HostedZone": {
"HostedZone": {
"Config": {
"Comment": "string"
},
"Id": "string",
"Name": "string"
},
"NameServers": [ "string" ],
"QueryLoggingConfig": {
"CloudWatchLogsLogGroupArn": {
"CloudWatchLogsLogGroupArn": "string",
"HostedZoneId": "string",
"Id": "string"
}
},
"Vpcs": [
{
"Id": "string",
"Region": "string"
}
]
},
"AwsS3AccessPoint": {
"AccessPointArn": "string",
"Alias": "string",
"Bucket": "string",
"BucketAccountId": "string",
"Name": "string",
"NetworkOrigin": "string",
"PublicAccessBlockConfiguration": {
"BlockPublicAcls": boolean,
"BlockPublicPolicy": boolean,
"IgnorePublicAcls": boolean,
"RestrictPublicBuckets": boolean
},
"VpcConfiguration": {
"VpcId": "string"
}
},
"AwsS3AccountPublicAccessBlock": {
"BlockPublicAcls": boolean,
"BlockPublicPolicy": boolean,
"IgnorePublicAcls": boolean,
"RestrictPublicBuckets": boolean
},
"AwsS3Bucket": {
"AccessControlList": "string",
"BucketLifecycleConfiguration": {
"Rules": [
{
"AbortIncompleteMultipartUpload": {
"DaysAfterInitiation": number
},
"ExpirationDate": "string",
"ExpirationInDays": number,
"ExpiredObjectDeleteMarker": boolean,
"Filter": {
"Predicate": {
"Operands": [
{
"Prefix": "string",
"Tag": {
"Key": "string",
"Value": "string"
},
"Type": "string"
}
],
"Prefix": "string",
"Tag": {
"Key": "string",
"Value": "string"
},
"Type": "string"
}
},
"ID": "string",
"NoncurrentVersionExpirationInDays": number,
"NoncurrentVersionTransitions": [
{
"Days": number,
"StorageClass": "string"
}
],
"Prefix": "string",
"Status": "string",
"Transitions": [
{
"Date": "string",
"Days": number,
"StorageClass": "string"
}
]
}
]
},
"BucketLoggingConfiguration": {
"DestinationBucketName": "string",
"LogFilePrefix": "string"
},
"BucketNotificationConfiguration": {
"Configurations": [
{
"Destination": "string",
"Events": [ "string" ],
"Filter": {
"S3KeyFilter": {
"FilterRules": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Type": "string"
}
]
},
"BucketVersioningConfiguration": {
"IsMfaDeleteEnabled": boolean,
"Status": "string"
},
"BucketWebsiteConfiguration": {
"ErrorDocument": "string",
"IndexDocumentSuffix": "string",
"RedirectAllRequestsTo": {
"Hostname": "string",
"Protocol": "string"
},
"RoutingRules": [
{
"Condition": {
"HttpErrorCodeReturnedEquals": "string",
"KeyPrefixEquals": "string"
},
"Redirect": {
"Hostname": "string",
"HttpRedirectCode": "string",
"Protocol": "string",
"ReplaceKeyPrefixWith": "string",
"ReplaceKeyWith": "string"
}
}
]
},
"CreatedAt": "string",
"Name": "string",
"ObjectLockConfiguration": {
"ObjectLockEnabled": "string",
"Rule": {
"DefaultRetention": {
"Days": number,
"Mode": "string",
"Years": number
}
}
},
"OwnerAccountId": "string",
"OwnerId": "string",
"OwnerName": "string",
"PublicAccessBlockConfiguration": {
"BlockPublicAcls": boolean,
"BlockPublicPolicy": boolean,
"IgnorePublicAcls": boolean,
"RestrictPublicBuckets": boolean
},
"ServerSideEncryptionConfiguration": {
"Rules": [
{
"ApplyServerSideEncryptionByDefault": {
"KMSMasterKeyID": "string",
"SSEAlgorithm": "string"
}
}
]
}
},
"AwsS3Object": {
"ContentType": "string",
"ETag": "string",
"LastModified": "string",
"ServerSideEncryption": "string",
"SSEKMSKeyId": "string",
"VersionId": "string"
},
"AwsSageMakerNotebookInstance": {
"AcceleratorTypes": [ "string" ],
"AdditionalCodeRepositories": [ "string" ],
"DefaultCodeRepository": "string",
"DirectInternetAccess": "string",
"FailureReason": "string",
"InstanceMetadataServiceConfiguration": {
"MinimumInstanceMetadataServiceVersion": "string"
},
"InstanceType": "string",
"KmsKeyId": "string",
"NetworkInterfaceId": "string",
"NotebookInstanceArn": "string",
"NotebookInstanceLifecycleConfigName": "string",
"NotebookInstanceName": "string",
"NotebookInstanceStatus": "string",
"PlatformIdentifier": "string",
"RoleArn": "string",
"RootAccess": "string",
"SecurityGroups": [ "string" ],
"SubnetId": "string",
"Url": "string",
"VolumeSizeInGB": number
},
"AwsSecretsManagerSecret": {
"Deleted": boolean,
"Description": "string",
"KmsKeyId": "string",
"Name": "string",
"RotationEnabled": boolean,
"RotationLambdaArn": "string",
"RotationOccurredWithinFrequency": boolean,
"RotationRules": {
"AutomaticallyAfterDays": number
}
},
"AwsSnsTopic": {
"ApplicationSuccessFeedbackRoleArn": "string",
"FirehoseFailureFeedbackRoleArn": "string",
"FirehoseSuccessFeedbackRoleArn": "string",
"HttpFailureFeedbackRoleArn": "string",
"HttpSuccessFeedbackRoleArn": "string",
"KmsMasterKeyId": "string",
"Owner": "string",
"SqsFailureFeedbackRoleArn": "string",
"SqsSuccessFeedbackRoleArn": "string",
"Subscription": [
{
"Endpoint": "string",
"Protocol": "string"
}
],
"TopicName": "string"
},
"AwsSqsQueue": {
"DeadLetterTargetArn": "string",
"KmsDataKeyReusePeriodSeconds": number,
"KmsMasterKeyId": "string",
"QueueName": "string"
},
"AwsSsmPatchCompliance": {
"Patch": {
"ComplianceSummary": {
"ComplianceType": "string",
"CompliantCriticalCount": number,
"CompliantHighCount": number,
"CompliantInformationalCount": number,
"CompliantLowCount": number,
"CompliantMediumCount": number,
"CompliantUnspecifiedCount": number,
"ExecutionType": "string",
"NonCompliantCriticalCount": number,
"NonCompliantHighCount": number,
"NonCompliantInformationalCount": number,
"NonCompliantLowCount": number,
"NonCompliantMediumCount": number,
"NonCompliantUnspecifiedCount": number,
"OverallSeverity": "string",
"PatchBaselineId": "string",
"PatchGroup": "string",
"Status": "string"
}
}
},
"AwsStepFunctionStateMachine": {
"Label": "string",
"LoggingConfiguration": {
"Destinations": [
{
"CloudWatchLogsLogGroup": {
"LogGroupArn": "string"
}
}
],
"IncludeExecutionData": boolean,
"Level": "string"
},
"Name": "string",
"RoleArn": "string",
"StateMachineArn": "string",
"Status": "string",
"TracingConfiguration": {
"Enabled": boolean
},
"Type": "string"
},
"AwsWafRateBasedRule": {
"MatchPredicates": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": number,
"RuleId": "string"
},
"AwsWafRegionalRateBasedRule": {
"MatchPredicates": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": number,
"RuleId": "string"
},
"AwsWafRegionalRule": {
"MetricName": "string",
"Name": "string",
"PredicateList": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"RuleId": "string"
},
"AwsWafRegionalRuleGroup": {
"MetricName": "string",
"Name": "string",
"RuleGroupId": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
]
},
"AwsWafRegionalWebAcl": {
"DefaultAction": "string",
"MetricName": "string",
"Name": "string",
"RulesList": [
{
"Action": {
"Type": "string"
},
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
],
"WebAclId": "string"
},
"AwsWafRule": {
"MetricName": "string",
"Name": "string",
"PredicateList": [
{
"DataId": "string",
"Negated": boolean,
"Type": "string"
}
],
"RuleId": "string"
},
"AwsWafRuleGroup": {
"MetricName": "string",
"Name": "string",
"RuleGroupId": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
]
},
"AwsWafv2RuleGroup": {
"Arn": "string",
"Capacity": number,
"Description": "string",
"Id": "string",
"Name": "string",
"Rules": [
{
"Action": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string",
"OverrideAction": "string",
"Priority": number,
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
],
"Scope": "string",
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
},
"AwsWafv2WebAcl": {
"Arn": "string",
"Capacity": number,
"CaptchaConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"DefaultAction": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Description": "string",
"Id": "string",
"ManagedbyFirewallManager": boolean,
"Name": "string",
"Rules": [
{
"Action": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string",
"OverrideAction": "string",
"Priority": number,
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
],
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
},
"AwsWafWebAcl": {
"DefaultAction": "string",
"Name": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
],
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
],
"WebAclId": "string"
},
"AwsXrayEncryptionConfig": {
"KeyId": "string",
"Status": "string",
"Type": "string"
},
"CodeRepository": {
"CodeSecurityIntegrationArn": "string",
"ProjectName": "string",
"ProviderType": "string"
},
"Container": {
"ContainerRuntime": "string",
"ImageId": "string",
"ImageName": "string",
"LaunchedAt": "string",
"Name": "string",
"Privileged": boolean,
"VolumeMounts": [
{
"MountPath": "string",
"Name": "string"
}
]
},
"Other": {
"string" : "string"
}
},
"Id": "string",
"Partition": "string",
"Region": "string",
"ResourceRole": "string",
"Tags": {
"string" : "string"
},
"Type": "string"
}
],
"Sample": boolean,
"SchemaVersion": "string",
"Severity": {
"Label": "string",
"Normalized": number,
"Original": "string",
"Product": number
},
"SourceUrl": "string",
"ThreatIntelIndicators": [
{
"Category": "string",
"LastObservedAt": "string",
"Source": "string",
"SourceUrl": "string",
"Type": "string",
"Value": "string"
}
],
"Threats": [
{
"FilePaths": [
{
"FileName": "string",
"FilePath": "string",
"Hash": "string",
"ResourceId": "string"
}
],
"ItemCount": number,
"Name": "string",
"Severity": "string"
}
],
"Title": "string",
"Types": [ "string" ],
"UpdatedAt": "string",
"UserDefinedFields": {
"string" : "string"
},
"VerificationState": "string",
"Vulnerabilities": [
{
"CodeVulnerabilities": [
{
"Cwes": [ "string" ],
"FilePath": {
"EndLine": number,
"FileName": "string",
"FilePath": "string",
"StartLine": number
},
"SourceArn": "string"
}
],
"Cvss": [
{
"Adjustments": [
{
"Metric": "string",
"Reason": "string"
}
],
"BaseScore": number,
"BaseVector": "string",
"Source": "string",
"Version": "string"
}
],
"EpssScore": number,
"ExploitAvailable": "string",
"FixAvailable": "string",
"Id": "string",
"LastKnownExploitAt": "string",
"ReferenceUrls": [ "string" ],
"RelatedVulnerabilities": [ "string" ],
"Vendor": {
"Name": "string",
"Url": "string",
"VendorCreatedAt": "string",
"VendorSeverity": "string",
"VendorUpdatedAt": "string"
},
"VulnerablePackages": [
{
"Architecture": "string",
"Epoch": "string",
"FilePath": "string",
"FixedInVersion": "string",
"Name": "string",
"PackageManager": "string",
"Release": "string",
"Remediation": "string",
"SourceLayerArn": "string",
"SourceLayerHash": "string",
"Version": "string"
}
]
}
],
"Workflow": {
"Status": "string"
},
"WorkflowState": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Findings](#API_GetFindings_ResponseSyntax) **
The findings that matched the filters specified in the request.
Type: Array of [AwsSecurityFinding](API_AwsSecurityFinding.md) objects
** [NextToken](#API_GetFindings_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetFindings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetFindings)
# GetFindingStatisticsV2
Returns aggregated statistical data about findings.
You can use the `Scopes` parameter to define the data boundary for the query. Currently, `Scopes` supports `AwsOrganizations`, which lets you aggregate findings from your entire organization or from specific organizational units. Only the delegated administrator account can use `Scopes`.
`GetFindingStatisticsV2` uses `securityhub:GetAdhocInsightResults` in the `Action` element of an IAM policy statement. You must have permission to perform the `securityhub:GetAdhocInsightResults` action.
## Request Syntax
```
POST /findingsv2/statistics HTTP/1.1
Content-type: application/json
{
"GroupByRules": [
{
"Filters": {
"CompositeFilters": [
{
"BooleanFilters": [
{
"FieldName": "string",
"Filter": {
"Value": boolean
}
}
],
"DateFilters": [
{
"FieldName": "string",
"Filter": {
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
}
],
"IpFilters": [
{
"FieldName": "string",
"Filter": {
"Cidr": "string"
}
}
],
"MapFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Key": "string",
"Value": "string"
}
}
],
"NestedCompositeFilters": [
"CompositeFilter"
],
"NumberFilters": [
{
"FieldName": "string",
"Filter": {
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
}
],
"Operator": "string",
"StringFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Value": "string"
}
}
]
}
],
"CompositeOperator": "string"
},
"GroupByField": "string"
}
],
"MaxStatisticResults": number,
"Scopes": {
"AwsOrganizations": [
{
"OrganizationalUnitId": "string",
"OrganizationId": "string"
}
]
},
"SortOrder": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [GroupByRules](#API_GetFindingStatisticsV2_RequestSyntax) **
Specifies how security findings should be aggregated and organized in the statistical analysis. It can accept up to 5 `groupBy` fields in a single call.
Type: Array of [GroupByRule](API_GroupByRule.md) objects
Required: Yes
** [MaxStatisticResults](#API_GetFindingStatisticsV2_RequestSyntax) **
The maximum number of results to be returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 400.
Required: No
** [Scopes](#API_GetFindingStatisticsV2_RequestSyntax) **
Limits the results to findings from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an `AccessDeniedException`.
This parameter is optional. If you omit it, the delegated administrator sees statistics from all accounts across the entire organization. Other accounts see only statistics for their own findings.
You can specify up to 10 entries in `Scopes.AwsOrganizations`. If multiple entries are specified, the entries are combined using OR logic.
Type: [FindingScopes](API_FindingScopes.md) object
Required: No
** [SortOrder](#API_GetFindingStatisticsV2_RequestSyntax) **
Orders the aggregation count in descending or ascending order. Descending order is the default.
Type: String
Valid Values: `asc | desc`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"GroupByResults": [
{
"GroupByField": "string",
"GroupByValues": [
{
"Count": number,
"FieldValue": "string"
}
]
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GroupByResults](#API_GetFindingStatisticsV2_ResponseSyntax) **
Aggregated statistics about security findings based on specified grouping criteria.
Type: Array of [GroupByResult](API_GroupByResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** OrganizationalUnitNotFoundException **
The request failed because one or more organizational units specified in the request don't exist within the caller's organization.
HTTP Status Code: 400
** OrganizationNotFoundException **
The request failed because one or more organizations specified in the request don't exist or don't belong to the caller's organization.
HTTP Status Code: 400
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetFindingStatisticsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetFindingStatisticsV2)
# GetFindingsTrendsV2
Returns findings trend data based on the specified criteria. This operation helps you analyze patterns and changes in findings over time.
## Request Syntax
```
POST /findingsTrendsv2 HTTP/1.1
Content-type: application/json
{
"EndTime": "string",
"Filters": {
"CompositeFilters": [
{
"NestedCompositeFilters": [
"FindingsTrendsCompositeFilter"
],
"Operator": "string",
"StringFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Value": "string"
}
}
]
}
],
"CompositeOperator": "string"
},
"MaxResults": number,
"NextToken": "string",
"StartTime": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [EndTime](#API_GetFindingsTrendsV2_RequestSyntax) **
The ending timestamp for the time period to analyze findings trends, in ISO 8601 format.
Type: Timestamp
Required: Yes
** [Filters](#API_GetFindingsTrendsV2_RequestSyntax) **
The filters to apply to the findings trend data.
Type: [FindingsTrendsFilters](API_FindingsTrendsFilters.md) object
Required: No
** [MaxResults](#API_GetFindingsTrendsV2_RequestSyntax) **
The maximum number of trend data points to return in a single response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_GetFindingsTrendsV2_RequestSyntax) **
The token to use for paginating results. This value is returned in the response if more results are available.
Type: String
Required: No
** [StartTime](#API_GetFindingsTrendsV2_RequestSyntax) **
The starting timestamp for the time period to analyze findings trends, in ISO 8601 format.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Granularity": "string",
"NextToken": "string",
"TrendsMetrics": [
{
"Timestamp": "string",
"TrendsValues": {
"SeverityTrends": {
"Critical": number,
"Fatal": number,
"High": number,
"Informational": number,
"Low": number,
"Medium": number,
"Other": number,
"Unknown": number
}
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Granularity](#API_GetFindingsTrendsV2_ResponseSyntax) **
The time interval granularity for the returned trend data.
Type: String
Valid Values: `Daily | Weekly | Monthly`
** [NextToken](#API_GetFindingsTrendsV2_ResponseSyntax) **
The token to use for retrieving the next page of results, if more trend data is available.
Type: String
** [TrendsMetrics](#API_GetFindingsTrendsV2_ResponseSyntax) **
The collection of time-series trend metrics, including counts of findings by severity across the specified time period.
Type: Array of [TrendsMetricsResult](API_TrendsMetricsResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetFindingsTrendsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetFindingsTrendsV2)
# GetFindingsV2
Returns a list of findings that match the specified criteria.
You can use the `Scopes` parameter to define the data boundary for the query. Currently, `Scopes` supports `AwsOrganizations`, which lets you retrieve findings from your entire organization or from specific organizational units. Only the delegated administrator account can use `Scopes`.
You can use the `Filters` parameter to refine results based on finding attributes. You can use `Scopes` and `Filters` independently or together. When both are provided, `Scopes` narrows the data set first, and then `Filters` refines results within that scoped data set.
`GetFindings` and `GetFindingsV2` both use `securityhub:GetFindings` in the `Action` element of an IAM policy statement. You must have permission to perform the `securityhub:GetFindings` action.
## Request Syntax
```
POST /findingsv2 HTTP/1.1
Content-type: application/json
{
"Filters": {
"CompositeFilters": [
{
"BooleanFilters": [
{
"FieldName": "string",
"Filter": {
"Value": boolean
}
}
],
"DateFilters": [
{
"FieldName": "string",
"Filter": {
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
}
],
"IpFilters": [
{
"FieldName": "string",
"Filter": {
"Cidr": "string"
}
}
],
"MapFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Key": "string",
"Value": "string"
}
}
],
"NestedCompositeFilters": [
"CompositeFilter"
],
"NumberFilters": [
{
"FieldName": "string",
"Filter": {
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
}
],
"Operator": "string",
"StringFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Value": "string"
}
}
]
}
],
"CompositeOperator": "string"
},
"MaxResults": number,
"NextToken": "string",
"Scopes": {
"AwsOrganizations": [
{
"OrganizationalUnitId": "string",
"OrganizationId": "string"
}
]
},
"SortCriteria": [
{
"Field": "string",
"SortOrder": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Filters](#API_GetFindingsV2_RequestSyntax) **
The finding attributes used to define a condition to filter the returned OCSF findings. You can filter up to 10 composite filters. For each filter type inside of a composite filter, you can provide up to 20 filters.
Type: [OcsfFindingFilters](API_OcsfFindingFilters.md) object
Required: No
** [MaxResults](#API_GetFindingsV2_RequestSyntax) **
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_GetFindingsV2_RequestSyntax) **
The token required for pagination. On your first call, set the value of this parameter to `NULL`. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
Type: String
Required: No
** [Scopes](#API_GetFindingsV2_RequestSyntax) **
Limits the results to findings from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an `AccessDeniedException`.
This parameter is optional. If you omit it, the delegated administrator sees findings from all accounts across the entire organization. Other accounts see only their own findings.
You can specify up to 10 entries in `Scopes.AwsOrganizations`. If multiple entries are specified, the entries are combined using OR logic.
Type: [FindingScopes](API_FindingScopes.md) object
Required: No
** [SortCriteria](#API_GetFindingsV2_RequestSyntax) **
The finding attributes used to sort the list of returned findings.
Type: Array of [SortCriterion](API_SortCriterion.md) objects
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Findings": [ JSON value ],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Findings](#API_GetFindingsV2_ResponseSyntax) **
An array of security findings returned by the operation.
Type: Array of JSON values
** [NextToken](#API_GetFindingsV2_ResponseSyntax) **
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** OrganizationalUnitNotFoundException **
The request failed because one or more organizational units specified in the request don't exist within the caller's organization.
HTTP Status Code: 400
** OrganizationNotFoundException **
The request failed because one or more organizations specified in the request don't exist or don't belong to the caller's organization.
HTTP Status Code: 400
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetFindingsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetFindingsV2)
# GetInsightResults
Lists the results of the Security Hub CSPM insight specified by the insight ARN.
## Request Syntax
```
GET /insights/results/InsightArn+ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [InsightArn](#API_GetInsightResults_RequestSyntax) **
The ARN of the insight for which to return results.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"InsightResults": {
"GroupByAttribute": "string",
"InsightArn": "string",
"ResultValues": [
{
"Count": number,
"GroupByAttributeValue": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [InsightResults](#API_GetInsightResults_ResponseSyntax) **
The insight results returned by the operation.
Type: [InsightResults](API_InsightResults.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetInsightResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetInsightResults)
# GetInsights
Lists and describes insights for the specified insight ARNs.
## Request Syntax
```
POST /insights/get HTTP/1.1
Content-type: application/json
{
"InsightArns": [ "string" ],
"MaxResults": number,
"NextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [InsightArns](#API_GetInsights_RequestSyntax) **
The ARNs of the insights to describe. If you don't provide any insight ARNs, then `GetInsights` returns all of your custom insights. It does not return any managed insights.
Type: Array of strings
Pattern: `.*\S.*`
Required: No
** [MaxResults](#API_GetInsights_RequestSyntax) **
The maximum number of items to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_GetInsights_RequestSyntax) **
The token that is required for pagination. On your first call to the `GetInsights` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Insights": [
{
"Filters": {
"AwsAccountId": [
{
"Comparison": "string",
"Value": "string"
}
],
"AwsAccountName": [
{
"Comparison": "string",
"Value": "string"
}
],
"CompanyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceAssociatedStandardsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"Confidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"CreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"Criticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"Description": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsConfidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsCriticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsRelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsRelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityOriginal": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsTypes": [
{
"Comparison": "string",
"Value": "string"
}
],
"FirstObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"GeneratorId": [
{
"Comparison": "string",
"Value": "string"
}
],
"Id": [
{
"Comparison": "string",
"Value": "string"
}
],
"Keyword": [
{
"Value": "string"
}
],
"LastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"MalwareName": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwarePath": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareState": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareType": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationIpV4": [
{
"Cidr": "string"
}
],
"NetworkDestinationIpV6": [
{
"Cidr": "string"
}
],
"NetworkDestinationPort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NetworkDirection": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkProtocol": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceIpV4": [
{
"Cidr": "string"
}
],
"NetworkSourceIpV6": [
{
"Cidr": "string"
}
],
"NetworkSourceMac": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourcePort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NoteText": [
{
"Comparison": "string",
"Value": "string"
}
],
"NoteUpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteUpdatedBy": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProcessName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessParentPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessPath": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessTerminatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ProductName": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecommendationText": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecordState": [
{
"Comparison": "string",
"Value": "string"
}
],
"Region": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIamInstanceProfileArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIpV4Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceIpV6Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceKeyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsEc2InstanceSubnetId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceVpcId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyCreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsIamAccessKeyPrincipalName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamUserUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceContainerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceDetailsOther": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourcePartition": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceRegion": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceTags": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"Sample": [
{
"Value": boolean
}
],
"SeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"SeverityNormalized": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SeverityProduct": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorCategory": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorLastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ThreatIntelIndicatorSource": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorSourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"Title": [
{
"Comparison": "string",
"Value": "string"
}
],
"Type": [
{
"Comparison": "string",
"Value": "string"
}
],
"UpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"UserDefinedFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"VerificationState": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesExploitAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesFixAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowState": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowStatus": [
{
"Comparison": "string",
"Value": "string"
}
]
},
"GroupByAttribute": "string",
"InsightArn": "string",
"Name": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Insights](#API_GetInsights_ResponseSyntax) **
The insights returned by the operation.
Type: Array of [Insight](API_Insight.md) objects
** [NextToken](#API_GetInsights_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetInsights)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetInsights)
# GetInvitationsCount
**Note**
We recommend using AWS Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see [Managing Security Hub CSPM administrator and member accounts with Organizations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html) in the * AWS Security Hub CSPM User Guide*.
Returns the count of all Security Hub CSPM membership invitations that were sent to the calling member account, not including the currently accepted invitation.
## Request Syntax
```
GET /invitations/count HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"InvitationsCount": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [InvitationsCount](#API_GetInvitationsCount_ResponseSyntax) **
The number of all membership invitations sent to this Security Hub CSPM member account, not including the currently accepted invitation.
Type: Integer
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetInvitationsCount)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetInvitationsCount)
# GetMasterAccount
This method is deprecated. Instead, use `GetAdministratorAccount`.
The Security Hub CSPM console continues to use `GetMasterAccount`. It will eventually change to use `GetAdministratorAccount`. Any IAM policies that specifically control access to this function must continue to use `GetMasterAccount`. You should also add `GetAdministratorAccount` to your policies to ensure that the correct permissions are in place after the console begins to use `GetAdministratorAccount`.
Provides the details for the Security Hub CSPM administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
## Request Syntax
```
GET /master HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Master": {
"AccountId": "string",
"InvitationId": "string",
"InvitedAt": "string",
"MemberStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Master](#API_GetMasterAccount_ResponseSyntax) **
A list of details about the Security Hub CSPM administrator account for the current member account.
Type: [Invitation](API_Invitation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetMasterAccount)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetMasterAccount)
# GetMembers
Returns the details for the Security Hub CSPM member accounts for the specified account IDs.
An administrator account can be either the delegated Security Hub CSPM administrator account for an organization or an administrator account that enabled Security Hub CSPM manually.
The results include both member accounts that are managed using Organizations and accounts that were invited manually.
## Request Syntax
```
POST /members/get HTTP/1.1
Content-type: application/json
{
"AccountIds": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AccountIds](#API_GetMembers_RequestSyntax) **
The list of account IDs for the Security Hub CSPM member accounts to return the details for.
Type: Array of strings
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Members": [
{
"AccountId": "string",
"AdministratorId": "string",
"Email": "string",
"InvitedAt": "string",
"MasterId": "string",
"MemberStatus": "string",
"UpdatedAt": "string"
}
],
"UnprocessedAccounts": [
{
"AccountId": "string",
"ProcessingResult": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Members](#API_GetMembers_ResponseSyntax) **
The list of details about the Security Hub CSPM member accounts.
Type: Array of [Member](API_Member.md) objects
** [UnprocessedAccounts](#API_GetMembers_ResponseSyntax) **
The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.
Type: Array of [Result](API_Result.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetMembers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetMembers)
# GetResourcesStatisticsV2
Retrieves statistical information about AWS resources and their associated security findings.
You can use the `Scopes` parameter to define the data boundary for the query. Currently, `Scopes` supports `AwsOrganizations`, which lets you aggregate resources from your entire organization or from specific organizational units. Only the delegated administrator account can use `Scopes`.
## Request Syntax
```
POST /resourcesv2/statistics HTTP/1.1
Content-type: application/json
{
"GroupByRules": [
{
"Filters": {
"CompositeFilters": [
{
"DateFilters": [
{
"FieldName": "string",
"Filter": {
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
}
],
"MapFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Key": "string",
"Value": "string"
}
}
],
"NestedCompositeFilters": [
"ResourcesCompositeFilter"
],
"NumberFilters": [
{
"FieldName": "string",
"Filter": {
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
}
],
"Operator": "string",
"StringFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Value": "string"
}
}
]
}
],
"CompositeOperator": "string"
},
"GroupByField": "string"
}
],
"MaxStatisticResults": number,
"Scopes": {
"AwsOrganizations": [
{
"OrganizationalUnitId": "string",
"OrganizationId": "string"
}
]
},
"SortOrder": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [GroupByRules](#API_GetResourcesStatisticsV2_RequestSyntax) **
How resource statistics should be aggregated and organized in the response.
Type: Array of [ResourceGroupByRule](API_ResourceGroupByRule.md) objects
Required: Yes
** [MaxStatisticResults](#API_GetResourcesStatisticsV2_RequestSyntax) **
The maximum number of results to be returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 400.
Required: No
** [Scopes](#API_GetResourcesStatisticsV2_RequestSyntax) **
Limits the results to resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an `AccessDeniedException`.
This parameter is optional. If you omit it, the delegated administrator sees statistics from all accounts across the entire organization. Other accounts see only statistics for their own resources.
You can specify up to 10 entries in `Scopes.AwsOrganizations`. If multiple entries are specified, the entries are combined using OR logic.
Type: [ResourceScopes](API_ResourceScopes.md) object
Required: No
** [SortOrder](#API_GetResourcesStatisticsV2_RequestSyntax) **
Sorts aggregated statistics.
Type: String
Valid Values: `asc | desc`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"GroupByResults": [
{
"GroupByField": "string",
"GroupByValues": [
{
"Count": number,
"FieldValue": "string"
}
]
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GroupByResults](#API_GetResourcesStatisticsV2_ResponseSyntax) **
The aggregated statistics about resources based on the specified grouping rule.
Type: Array of [GroupByResult](API_GroupByResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** OrganizationalUnitNotFoundException **
The request failed because one or more organizational units specified in the request don't exist within the caller's organization.
HTTP Status Code: 400
** OrganizationNotFoundException **
The request failed because one or more organizations specified in the request don't exist or don't belong to the caller's organization.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetResourcesStatisticsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetResourcesStatisticsV2)
# GetResourcesTrendsV2
Returns resource trend data based on the specified criteria. This operation helps you analyze patterns and changes in resource compliance over time.
## Request Syntax
```
POST /resourcesTrendsv2 HTTP/1.1
Content-type: application/json
{
"EndTime": "string",
"Filters": {
"CompositeFilters": [
{
"NestedCompositeFilters": [
"ResourcesTrendsCompositeFilter"
],
"Operator": "string",
"StringFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Value": "string"
}
}
]
}
],
"CompositeOperator": "string"
},
"MaxResults": number,
"NextToken": "string",
"StartTime": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [EndTime](#API_GetResourcesTrendsV2_RequestSyntax) **
The ending timestamp for the time period to analyze resources trends, in ISO 8601 format.
Type: Timestamp
Required: Yes
** [Filters](#API_GetResourcesTrendsV2_RequestSyntax) **
The filters to apply to the resources trend data.
Type: [ResourcesTrendsFilters](API_ResourcesTrendsFilters.md) object
Required: No
** [MaxResults](#API_GetResourcesTrendsV2_RequestSyntax) **
The maximum number of trend data points to return in a single response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_GetResourcesTrendsV2_RequestSyntax) **
The token to use for paginating results. This value is returned in the response if more results are available.
Type: String
Required: No
** [StartTime](#API_GetResourcesTrendsV2_RequestSyntax) **
The starting timestamp for the time period to analyze resources trends, in ISO 8601 format.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Granularity": "string",
"NextToken": "string",
"TrendsMetrics": [
{
"Timestamp": "string",
"TrendsValues": {
"ResourcesCount": {
"AllResources": number
}
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Granularity](#API_GetResourcesTrendsV2_ResponseSyntax) **
The time interval granularity for the returned trend data (such as DAILY or WEEKLY).
Type: String
Valid Values: `Daily | Weekly | Monthly`
** [NextToken](#API_GetResourcesTrendsV2_ResponseSyntax) **
The token to use for retrieving the next page of results, if more trend data is available.
Type: String
** [TrendsMetrics](#API_GetResourcesTrendsV2_ResponseSyntax) **
The collection of time-series trend metrics, including counts of resources across the specified time period.
Type: Array of [ResourcesTrendsMetricsResult](API_ResourcesTrendsMetricsResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetResourcesTrendsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetResourcesTrendsV2)
# GetResourcesV2
Returns a list of resources.
You can use the `Scopes` parameter to define the data boundary for the query. Currently, `Scopes` supports `AwsOrganizations`, which lets you retrieve resources from your entire organization or from specific organizational units. Only the delegated administrator account can use `Scopes`.
You can use the `Filters` parameter to refine results based on resource attributes. You can use `Scopes` and `Filters` independently or together. When both are provided, `Scopes` narrows the data set first, and then `Filters` refines results within that scoped data set.
## Request Syntax
```
POST /resourcesv2 HTTP/1.1
Content-type: application/json
{
"Filters": {
"CompositeFilters": [
{
"DateFilters": [
{
"FieldName": "string",
"Filter": {
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
}
],
"MapFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Key": "string",
"Value": "string"
}
}
],
"NestedCompositeFilters": [
"ResourcesCompositeFilter"
],
"NumberFilters": [
{
"FieldName": "string",
"Filter": {
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
}
],
"Operator": "string",
"StringFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Value": "string"
}
}
]
}
],
"CompositeOperator": "string"
},
"MaxResults": number,
"NextToken": "string",
"Scopes": {
"AwsOrganizations": [
{
"OrganizationalUnitId": "string",
"OrganizationId": "string"
}
]
},
"SortCriteria": [
{
"Field": "string",
"SortOrder": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Filters](#API_GetResourcesV2_RequestSyntax) **
Filters resources based on a set of criteria.
Type: [ResourcesFilters](API_ResourcesFilters.md) object
Required: No
** [MaxResults](#API_GetResourcesV2_RequestSyntax) **
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_GetResourcesV2_RequestSyntax) **
The token required for pagination. On your first call, set the value of this parameter to `NULL`. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
Type: String
Required: No
** [Scopes](#API_GetResourcesV2_RequestSyntax) **
Limits the results to resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an `AccessDeniedException`.
This parameter is optional. If you omit it, the delegated administrator sees resources from all accounts across the entire organization. Other accounts see only their own resources.
You can specify up to 10 entries in `Scopes.AwsOrganizations`. If multiple entries are specified, the entries are combined using OR logic.
Type: [ResourceScopes](API_ResourceScopes.md) object
Required: No
** [SortCriteria](#API_GetResourcesV2_RequestSyntax) **
The resource attributes used to sort the list of returned resources.
Type: Array of [SortCriterion](API_SortCriterion.md) objects
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Resources": [
{
"AccountId": "string",
"FindingsSummary": [
{
"FindingType": "string",
"ProductName": "string",
"Severities": {
"Critical": number,
"Fatal": number,
"High": number,
"Informational": number,
"Low": number,
"Medium": number,
"Other": number,
"Unknown": number
},
"TotalFindings": number
}
],
"Region": "string",
"ResourceCategory": "string",
"ResourceConfig": JSON value,
"ResourceCreationTimeDt": "string",
"ResourceDetailCaptureTimeDt": "string",
"ResourceGuid": "string",
"ResourceId": "string",
"ResourceName": "string",
"ResourceTags": [
{
"Key": "string",
"Value": "string"
}
],
"ResourceType": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_GetResourcesV2_ResponseSyntax) **
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Type: String
** [Resources](#API_GetResourcesV2_ResponseSyntax) **
An array of resources returned by the operation.
Type: Array of [ResourceResult](API_ResourceResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** OrganizationalUnitNotFoundException **
The request failed because one or more organizational units specified in the request don't exist within the caller's organization.
HTTP Status Code: 400
** OrganizationNotFoundException **
The request failed because one or more organizations specified in the request don't exist or don't belong to the caller's organization.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetResourcesV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetResourcesV2)
# GetSecurityControlDefinition
Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.
## Request Syntax
```
GET /securityControl/definition?SecurityControlId=SecurityControlId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [SecurityControlId](#API_GetSecurityControlDefinition_RequestSyntax) **
The ID of the security control to retrieve the definition for. This field doesn’t accept an Amazon Resource Name (ARN).
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"SecurityControlDefinition": {
"CurrentRegionAvailability": "string",
"CustomizableProperties": [ "string" ],
"Description": "string",
"ParameterDefinitions": {
"string" : {
"ConfigurationOptions": { ... },
"Description": "string"
}
},
"RemediationUrl": "string",
"SecurityControlId": "string",
"SeverityRating": "string",
"Title": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [SecurityControlDefinition](#API_GetSecurityControlDefinition_ResponseSyntax) **
Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in AWS Regions, and a link to remediation steps.
Type: [SecurityControlDefinition](API_SecurityControlDefinition.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/GetSecurityControlDefinition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/GetSecurityControlDefinition)
# InviteMembers
**Note**
We recommend using AWS Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see [Managing Security Hub CSPM administrator and member accounts with Organizations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html) in the * AWS Security Hub CSPM User Guide*.
Invites other AWS accounts to become member accounts for the Security Hub CSPM administrator account that the invitation is sent from.
This operation is only used to invite accounts that don't belong to an AWS organization. Organization accounts don't receive invitations.
Before you can use this action to invite a member, you must first use the `CreateMembers` action to create the member account in Security Hub CSPM.
When the account owner enables Security Hub CSPM and accepts the invitation to become a member account, the administrator account can view the findings generated in the member account.
## Request Syntax
```
POST /members/invite HTTP/1.1
Content-type: application/json
{
"AccountIds": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AccountIds](#API_InviteMembers_RequestSyntax) **
The list of account IDs of the AWS accounts to invite to Security Hub CSPM as members.
Type: Array of strings
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"UnprocessedAccounts": [
{
"AccountId": "string",
"ProcessingResult": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [UnprocessedAccounts](#API_InviteMembers_ResponseSyntax) **
The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.
Type: Array of [Result](API_Result.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/InviteMembers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/InviteMembers)
# ListAggregatorsV2
Retrieves a list of V2 aggregators.
## Request Syntax
```
GET /aggregatorv2/list?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListAggregatorsV2_RequestSyntax) **
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListAggregatorsV2_RequestSyntax) **
The token required for pagination. On your first call, set the value of this parameter to `NULL`. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AggregatorsV2": [
{
"AggregatorV2Arn": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AggregatorsV2](#API_ListAggregatorsV2_ResponseSyntax) **
An array of aggregators.
Type: Array of [AggregatorV2](API_AggregatorV2.md) objects
** [NextToken](#API_ListAggregatorsV2_ResponseSyntax) **
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListAggregatorsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListAggregatorsV2)
# ListAutomationRules
A list of automation rules and their metadata for the calling account.
## Request Syntax
```
GET /automationrules/list?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListAutomationRules_RequestSyntax) **
The maximum number of rules to return in the response. This currently ranges from 1 to 100.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListAutomationRules_RequestSyntax) **
A token to specify where to start paginating the response. This is the `NextToken` from a previously truncated response. On your first call to the `ListAutomationRules` API, set the value of this parameter to `NULL`.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AutomationRulesMetadata": [
{
"CreatedAt": "string",
"CreatedBy": "string",
"Description": "string",
"IsTerminal": boolean,
"RuleArn": "string",
"RuleName": "string",
"RuleOrder": number,
"RuleStatus": "string",
"UpdatedAt": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AutomationRulesMetadata](#API_ListAutomationRules_ResponseSyntax) **
Metadata for rules in the calling account. The response includes rules with a `RuleStatus` of `ENABLED` and `DISABLED`.
Type: Array of [AutomationRulesMetadata](API_AutomationRulesMetadata.md) objects
** [NextToken](#API_ListAutomationRules_ResponseSyntax) **
A pagination token for the response.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListAutomationRules)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListAutomationRules)
# ListAutomationRulesV2
Returns a list of automation rules and metadata for the calling account.
## Request Syntax
```
GET /automationrulesv2/list?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListAutomationRulesV2_RequestSyntax) **
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListAutomationRulesV2_RequestSyntax) **
The token required for pagination. On your first call, set the value of this parameter to `NULL`. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Rules": [
{
"Actions": [
{
"Type": "string"
}
],
"CreatedAt": "string",
"Description": "string",
"RuleArn": "string",
"RuleId": "string",
"RuleName": "string",
"RuleOrder": number,
"RuleStatus": "string",
"UpdatedAt": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListAutomationRulesV2_ResponseSyntax) **
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Type: String
** [Rules](#API_ListAutomationRulesV2_ResponseSyntax) **
An array of automation rules.
Type: Array of [AutomationRulesMetadataV2](API_AutomationRulesMetadataV2.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListAutomationRulesV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListAutomationRulesV2)
# ListConfigurationPolicies
Lists the configuration policies that the AWS Security Hub CSPM delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.
## Request Syntax
```
GET /configurationPolicy/list?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListConfigurationPolicies_RequestSyntax) **
The maximum number of results that's returned by `ListConfigurationPolicies` in each page of the response. When this parameter is used, `ListConfigurationPolicies` returns the specified number of results in a single page and a `NextToken` response element. You can see the remaining results of the initial request by sending another `ListConfigurationPolicies` request with the returned `NextToken` value. A valid range for `MaxResults` is between 1 and 100.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListConfigurationPolicies_RequestSyntax) **
The NextToken value that's returned from a previous paginated `ListConfigurationPolicies` request where `MaxResults` was used but the results exceeded the value of that parameter. Pagination continues from the `MaxResults` was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned the `NextToken` value. This value is `null` when there are no more results to return.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ConfigurationPolicySummaries": [
{
"Arn": "string",
"Description": "string",
"Id": "string",
"Name": "string",
"ServiceEnabled": boolean,
"UpdatedAt": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConfigurationPolicySummaries](#API_ListConfigurationPolicies_ResponseSyntax) **
Provides metadata for each of your configuration policies.
Type: Array of [ConfigurationPolicySummary](API_ConfigurationPolicySummary.md) objects
** [NextToken](#API_ListConfigurationPolicies_ResponseSyntax) **
The `NextToken` value to include in the next `ListConfigurationPolicies` request. When the results of a `ListConfigurationPolicies` request exceed `MaxResults`, this value can be used to retrieve the next page of results. This value is `null` when there are no more results to return.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListConfigurationPolicies)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListConfigurationPolicies)
# ListConfigurationPolicyAssociations
Provides information about the associations for your configuration policies and self-managed behavior. Only the AWS Security Hub CSPM delegated administrator can invoke this operation from the home Region.
## Request Syntax
```
POST /configurationPolicyAssociation/list HTTP/1.1
Content-type: application/json
{
"Filters": {
"AssociationStatus": "string",
"AssociationType": "string",
"ConfigurationPolicyId": "string"
},
"MaxResults": number,
"NextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Filters](#API_ListConfigurationPolicyAssociations_RequestSyntax) **
Options for filtering the `ListConfigurationPolicyAssociations` response. You can filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) of a configuration, `AssociationType`, or `AssociationStatus`.
Type: [AssociationFilters](API_AssociationFilters.md) object
Required: No
** [MaxResults](#API_ListConfigurationPolicyAssociations_RequestSyntax) **
The maximum number of results that's returned by `ListConfigurationPolicies` in each page of the response. When this parameter is used, `ListConfigurationPolicyAssociations` returns the specified number of results in a single page and a `NextToken` response element. You can see the remaining results of the initial request by sending another `ListConfigurationPolicyAssociations` request with the returned `NextToken` value. A valid range for `MaxResults` is between 1 and 100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListConfigurationPolicyAssociations_RequestSyntax) **
The `NextToken` value that's returned from a previous paginated `ListConfigurationPolicyAssociations` request where `MaxResults` was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned the `NextToken` value. This value is `null` when there are no more results to return.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ConfigurationPolicyAssociationSummaries": [
{
"AssociationStatus": "string",
"AssociationStatusMessage": "string",
"AssociationType": "string",
"ConfigurationPolicyId": "string",
"TargetId": "string",
"TargetType": "string",
"UpdatedAt": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConfigurationPolicyAssociationSummaries](#API_ListConfigurationPolicyAssociations_ResponseSyntax) **
An object that contains the details of each configuration policy association that’s returned in a `ListConfigurationPolicyAssociations` request.
Type: Array of [ConfigurationPolicyAssociationSummary](API_ConfigurationPolicyAssociationSummary.md) objects
** [NextToken](#API_ListConfigurationPolicyAssociations_ResponseSyntax) **
The `NextToken` value to include in the next `ListConfigurationPolicyAssociations` request. When the results of a `ListConfigurationPolicyAssociations` request exceed `MaxResults`, this value can be used to retrieve the next page of results. This value is `null` when there are no more results to return.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListConfigurationPolicyAssociations)
# ListConnectorsV2
Grants permission to retrieve a list of connectorsV2 and their metadata for the calling account.
## Request Syntax
```
GET /connectorsv2?ConnectorStatus=ConnectorStatus&MaxResults=MaxResults&NextToken=NextToken&ProviderName=ProviderName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ConnectorStatus](#API_ListConnectorsV2_RequestSyntax) **
The status for the connectorV2.
Valid Values: `CONNECTED | FAILED_TO_CONNECT | PENDING_CONFIGURATION | PENDING_AUTHORIZATION`
** [MaxResults](#API_ListConnectorsV2_RequestSyntax) **
The maximum number of results to be returned.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListConnectorsV2_RequestSyntax) **
The pagination token per the AWS Pagination standard
** [ProviderName](#API_ListConnectorsV2_RequestSyntax) **
The name of the third-party provider.
Valid Values: `JIRA_CLOUD | SERVICENOW`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Connectors": [
{
"ConnectorArn": "string",
"ConnectorId": "string",
"CreatedAt": "string",
"Description": "string",
"Name": "string",
"ProviderSummary": {
"ConnectorStatus": "string",
"ProviderName": "string"
}
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Connectors](#API_ListConnectorsV2_ResponseSyntax) **
An array of connectorV2 summaries.
Type: Array of [ConnectorSummary](API_ConnectorSummary.md) objects
** [NextToken](#API_ListConnectorsV2_ResponseSyntax) **
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListConnectorsV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListConnectorsV2)
# ListEnabledProductsForImport
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub CSPM.
## Request Syntax
```
GET /productSubscriptions?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListEnabledProductsForImport_RequestSyntax) **
The maximum number of items to return in the response.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListEnabledProductsForImport_RequestSyntax) **
The token that is required for pagination. On your first call to the `ListEnabledProductsForImport` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"ProductSubscriptions": [ "string" ]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListEnabledProductsForImport_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
** [ProductSubscriptions](#API_ListEnabledProductsForImport_ResponseSyntax) **
The list of ARNs for the resources that represent your subscriptions to products.
Type: Array of strings
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListEnabledProductsForImport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListEnabledProductsForImport)
# ListFindingAggregators
If cross-Region aggregation is enabled, then `ListFindingAggregators` returns the Amazon Resource Name (ARN) of the finding aggregator. You can run this operation from any AWS Region.
## Request Syntax
```
GET /findingAggregator/list?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListFindingAggregators_RequestSyntax) **
The maximum number of results to return. This operation currently only returns a single result.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListFindingAggregators_RequestSyntax) **
The token returned with the previous set of results. Identifies the next set of results to return.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"FindingAggregators": [
{
"FindingAggregatorArn": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [FindingAggregators](#API_ListFindingAggregators_ResponseSyntax) **
The list of finding aggregators. This operation currently only returns a single result.
Type: Array of [FindingAggregator](API_FindingAggregator.md) objects
** [NextToken](#API_ListFindingAggregators_ResponseSyntax) **
If there are more results, this is the token to provide in the next call to `ListFindingAggregators`.
This operation currently only returns a single result.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListFindingAggregators)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListFindingAggregators)
# ListInvitations
**Note**
We recommend using AWS Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see [Managing Security Hub CSPM administrator and member accounts with Organizations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html) in the * AWS Security Hub CSPM User Guide*.
Lists all Security Hub CSPM membership invitations that were sent to the calling account.
Only accounts that are managed by invitation can use this operation. Accounts that are managed using the integration with Organizations don't receive invitations.
## Request Syntax
```
GET /invitations?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListInvitations_RequestSyntax) **
The maximum number of items to return in the response.
Valid Range: Minimum value of 1. Maximum value of 50.
** [NextToken](#API_ListInvitations_RequestSyntax) **
The token that is required for pagination. On your first call to the `ListInvitations` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Invitations": [
{
"AccountId": "string",
"InvitationId": "string",
"InvitedAt": "string",
"MemberStatus": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Invitations](#API_ListInvitations_ResponseSyntax) **
The details of the invitations returned by the operation.
Type: Array of [Invitation](API_Invitation.md) objects
** [NextToken](#API_ListInvitations_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListInvitations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListInvitations)
# ListMembers
Lists details about all member accounts for the current Security Hub CSPM administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
## Request Syntax
```
GET /members?MaxResults=MaxResults&NextToken=NextToken&OnlyAssociated=OnlyAssociated HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListMembers_RequestSyntax) **
The maximum number of items to return in the response.
Valid Range: Minimum value of 1. Maximum value of 50.
** [NextToken](#API_ListMembers_RequestSyntax) **
The token that is required for pagination. On your first call to the `ListMembers` operation, set the value of this parameter to `NULL`.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
** [OnlyAssociated](#API_ListMembers_RequestSyntax) **
Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is `TRUE`.
If `OnlyAssociated` is set to `TRUE`, the response includes member accounts whose relationship status with the administrator account is set to `ENABLED`.
If `OnlyAssociated` is set to `FALSE`, the response includes all existing member accounts.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Members": [
{
"AccountId": "string",
"AdministratorId": "string",
"Email": "string",
"InvitedAt": "string",
"MasterId": "string",
"MemberStatus": "string",
"UpdatedAt": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Members](#API_ListMembers_ResponseSyntax) **
Member details returned by the operation.
Type: Array of [Member](API_Member.md) objects
** [NextToken](#API_ListMembers_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListMembers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListMembers)
# ListOrganizationAdminAccounts
Lists the Security Hub CSPM administrator accounts. Can only be called by the organization management account.
## Request Syntax
```
GET /organization/admin?Feature=Feature&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [Feature](#API_ListOrganizationAdminAccounts_RequestSyntax) **
The feature where the delegated administrator account is listed. Defaults to Security Hub CSPM if not specified.
Valid Values: `SecurityHub | SecurityHubV2`
** [MaxResults](#API_ListOrganizationAdminAccounts_RequestSyntax) **
The maximum number of items to return in the response.
Valid Range: Minimum value of 1. Maximum value of 10.
** [NextToken](#API_ListOrganizationAdminAccounts_RequestSyntax) **
The token that is required for pagination. On your first call to the `ListOrganizationAdminAccounts` operation, set the value of this parameter to `NULL`. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AdminAccounts": [
{
"AccountId": "string",
"Status": "string"
}
],
"Feature": "string",
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AdminAccounts](#API_ListOrganizationAdminAccounts_ResponseSyntax) **
The list of Security Hub CSPM administrator accounts.
Type: Array of [AdminAccount](API_AdminAccount.md) objects
** [Feature](#API_ListOrganizationAdminAccounts_ResponseSyntax) **
The feature where the delegated administrator account is listed. Defaults to Security Hub CSPM CSPM if not specified.
Type: String
Valid Values: `SecurityHub | SecurityHubV2`
** [NextToken](#API_ListOrganizationAdminAccounts_ResponseSyntax) **
The pagination token to use to request the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListOrganizationAdminAccounts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListOrganizationAdminAccounts)
# ListSecurityControlDefinitions
Lists all of the security controls that apply to a specified standard.
## Request Syntax
```
GET /securityControls/definitions?MaxResults=MaxResults&NextToken=NextToken&StandardsArn=StandardsArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListSecurityControlDefinitions_RequestSyntax) **
An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 security controls that apply to the specified standard. The results also include a `NextToken` parameter that you can use in a subsequent API call to get the next 25 controls. This repeats until all controls for the standard are returned.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListSecurityControlDefinitions_RequestSyntax) **
Optional pagination parameter.
** [StandardsArn](#API_ListSecurityControlDefinitions_RequestSyntax) **
The Amazon Resource Name (ARN) of the standard that you want to view controls for.
Pattern: `.*\S.*`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"SecurityControlDefinitions": [
{
"CurrentRegionAvailability": "string",
"CustomizableProperties": [ "string" ],
"Description": "string",
"ParameterDefinitions": {
"string" : {
"ConfigurationOptions": { ... },
"Description": "string"
}
},
"RemediationUrl": "string",
"SecurityControlId": "string",
"SeverityRating": "string",
"Title": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListSecurityControlDefinitions_ResponseSyntax) **
A pagination parameter that's included in the response only if it was included in the request.
Type: String
** [SecurityControlDefinitions](#API_ListSecurityControlDefinitions_ResponseSyntax) **
An array of controls that apply to the specified standard.
Type: Array of [SecurityControlDefinition](API_SecurityControlDefinition.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListSecurityControlDefinitions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListSecurityControlDefinitions)
# ListStandardsControlAssociations
Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
This operation omits standards control associations for standard subscriptions where `StandardsControlsUpdatable` has value `NOT_READY_FOR_UPDATES`.
## Request Syntax
```
GET /associations?MaxResults=MaxResults&NextToken=NextToken&SecurityControlId=SecurityControlId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListStandardsControlAssociations_RequestSyntax) **
An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 standard and control associations. The results also include a `NextToken` parameter that you can use in a subsequent API call to get the next 25 associations. This repeats until all associations for the specified control are returned. The number of results is limited by the number of supported Security Hub CSPM standards that you've enabled in the calling account.
Valid Range: Minimum value of 1. Maximum value of 100.
** [NextToken](#API_ListStandardsControlAssociations_RequestSyntax) **
Optional pagination parameter.
** [SecurityControlId](#API_ListStandardsControlAssociations_RequestSyntax) **
The identifier of the control (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters) that you want to determine the enablement status of in each enabled standard.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"StandardsControlAssociationSummaries": [
{
"AssociationStatus": "string",
"RelatedRequirements": [ "string" ],
"SecurityControlArn": "string",
"SecurityControlId": "string",
"StandardsArn": "string",
"StandardsControlDescription": "string",
"StandardsControlTitle": "string",
"UpdatedAt": "string",
"UpdatedReason": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListStandardsControlAssociations_ResponseSyntax) **
A pagination parameter that's included in the response only if it was included in the request.
Type: String
** [StandardsControlAssociationSummaries](#API_ListStandardsControlAssociations_ResponseSyntax) **
An array that provides the enablement status and other details for each security control that applies to each enabled standard.
Type: Array of [StandardsControlAssociationSummary](API_StandardsControlAssociationSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListStandardsControlAssociations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListStandardsControlAssociations)
# ListTagsForResource
Returns a list of tags associated with a resource.
## Request Syntax
```
GET /tags/ResourceArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **
The ARN of the resource to retrieve tags for.
Pattern: `^arn:aws:securityhub:.*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Tags](#API_ListTagsForResource_ResponseSyntax) **
The tags associated with a resource.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/ListTagsForResource)
# RegisterConnectorV2
Grants permission to complete the authorization based on input parameters.
## Request Syntax
```
POST /connectorsv2/register HTTP/1.1
Content-type: application/json
{
"AuthCode": "string",
"AuthState": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AuthCode](#API_RegisterConnectorV2_RequestSyntax) **
The authCode retrieved from authUrl to complete the OAuth 2.0 authorization code flow.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [AuthState](#API_RegisterConnectorV2_RequestSyntax) **
The authState retrieved from authUrl to complete the OAuth 2.0 authorization code flow.
Type: String
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ConnectorArn": "string",
"ConnectorId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConnectorArn](#API_RegisterConnectorV2_ResponseSyntax) **
The Amazon Resource Name (ARN) of the connectorV2.
Type: String
Pattern: `.*\S.*`
** [ConnectorId](#API_RegisterConnectorV2_ResponseSyntax) **
The UUID of the connectorV2 to identify connectorV2 resource.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/RegisterConnectorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/RegisterConnectorV2)
# StartConfigurationPolicyAssociation
Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the AWS Security Hub CSPM delegated administrator can invoke this operation from the home Region.
## Request Syntax
```
POST /configurationPolicyAssociation/associate HTTP/1.1
Content-type: application/json
{
"ConfigurationPolicyIdentifier": "string",
"Target": { ... }
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ConfigurationPolicyIdentifier](#API_StartConfigurationPolicyAssociation_RequestSyntax) **
The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a configuration policy, or a value of `SELF_MANAGED_SECURITY_HUB` for a self-managed configuration.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Target](#API_StartConfigurationPolicyAssociation_RequestSyntax) **
The identifier of the target account, organizational unit, or the root to associate with the specified configuration.
Type: [Target](API_Target.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AssociationStatus": "string",
"AssociationStatusMessage": "string",
"AssociationType": "string",
"ConfigurationPolicyId": "string",
"TargetId": "string",
"TargetType": "string",
"UpdatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AssociationStatus](#API_StartConfigurationPolicyAssociation_ResponseSyntax) **
The current status of the association between the specified target and the configuration.
Type: String
Valid Values: `PENDING | SUCCESS | FAILED`
** [AssociationStatusMessage](#API_StartConfigurationPolicyAssociation_ResponseSyntax) **
An explanation for a `FAILED` value for `AssociationStatus`.
Type: String
Pattern: `.*\S.*`
** [AssociationType](#API_StartConfigurationPolicyAssociation_ResponseSyntax) **
Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub CSPM delegated administrator or inherited from a parent.
Type: String
Valid Values: `INHERITED | APPLIED`
** [ConfigurationPolicyId](#API_StartConfigurationPolicyAssociation_ResponseSyntax) **
The UUID of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [TargetId](#API_StartConfigurationPolicyAssociation_ResponseSyntax) **
The identifier of the target account, organizational unit, or the organization root with which the configuration is associated.
Type: String
Pattern: `.*\S.*`
** [TargetType](#API_StartConfigurationPolicyAssociation_ResponseSyntax) **
Indicates whether the target is an AWS account, organizational unit, or the organization root.
Type: String
Valid Values: `ACCOUNT | ORGANIZATIONAL_UNIT | ROOT`
** [UpdatedAt](#API_StartConfigurationPolicyAssociation_ResponseSyntax) **
The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/StartConfigurationPolicyAssociation)
# StartConfigurationPolicyDisassociation
Disassociates a target account, organizational unit, or the root from a specified configuration. When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the AWS Security Hub CSPM delegated administrator can invoke this operation from the home Region.
## Request Syntax
```
POST /configurationPolicyAssociation/disassociate HTTP/1.1
Content-type: application/json
{
"ConfigurationPolicyIdentifier": "string",
"Target": { ... }
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ConfigurationPolicyIdentifier](#API_StartConfigurationPolicyDisassociation_RequestSyntax) **
The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a configuration policy, or a value of `SELF_MANAGED_SECURITY_HUB` for a self-managed configuration.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Target](#API_StartConfigurationPolicyDisassociation_RequestSyntax) **
The identifier of the target account, organizational unit, or the root to disassociate from the specified configuration.
Type: [Target](API_Target.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/StartConfigurationPolicyDisassociation)
# TagResource
Adds one or more tags to a resource.
## Request Syntax
```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [ResourceArn](#API_TagResource_RequestSyntax) **
The ARN of the resource to apply the tags to.
Pattern: `^arn:aws:securityhub:.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Tags](#API_TagResource_RequestSyntax) **
The tags to add to the resource. You can add up to 50 tags at a time. The tag keys can be no longer than 128 characters. The tag values can be no longer than 256 characters.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Value Length Constraints: Maximum length of 256.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/TagResource)
# UntagResource
Removes one or more tags from a resource.
## Request Syntax
```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ResourceArn](#API_UntagResource_RequestSyntax) **
The ARN of the resource to remove the tags from.
Pattern: `^arn:aws:securityhub:.*`
Required: Yes
** [TagKeys](#API_UntagResource_RequestSyntax) **
The tag keys associated with the tags to remove from the resource. You can remove up to 50 tags at a time.
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UntagResource)
# UpdateActionTarget
Updates the name and description of a custom action target in Security Hub CSPM.
## Request Syntax
```
PATCH /actionTargets/ActionTargetArn+ HTTP/1.1
Content-type: application/json
{
"Description": "string",
"Name": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [ActionTargetArn](#API_UpdateActionTarget_RequestSyntax) **
The ARN of the custom action target to update.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Description](#API_UpdateActionTarget_RequestSyntax) **
The updated description for the custom action target.
Type: String
Pattern: `.*\S.*`
Required: No
** [Name](#API_UpdateActionTarget_RequestSyntax) **
The updated name of the custom action target.
Type: String
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateActionTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateActionTarget)
# UpdateAggregatorV2
Udpates the configuration for the Aggregator V2.
## Request Syntax
```
PATCH /aggregatorv2/update/AggregatorV2Arn+ HTTP/1.1
Content-type: application/json
{
"LinkedRegions": [ "string" ],
"RegionLinkingMode": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [AggregatorV2Arn](#API_UpdateAggregatorV2_RequestSyntax) **
The ARN of the Aggregator V2.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [LinkedRegions](#API_UpdateAggregatorV2_RequestSyntax) **
A list of AWS Regions linked to the aggegation Region.
Type: Array of strings
Pattern: `.*\S.*`
Required: No
** [RegionLinkingMode](#API_UpdateAggregatorV2_RequestSyntax) **
Determines how AWS Regions should be linked to the Aggregator V2.
Type: String
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AggregationRegion": "string",
"AggregatorV2Arn": "string",
"LinkedRegions": [ "string" ],
"RegionLinkingMode": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AggregationRegion](#API_UpdateAggregatorV2_ResponseSyntax) **
The AWS Region where data is aggregated.
Type: String
Pattern: `.*\S.*`
** [AggregatorV2Arn](#API_UpdateAggregatorV2_ResponseSyntax) **
The ARN of the Aggregator V2.
Type: String
Pattern: `.*\S.*`
** [LinkedRegions](#API_UpdateAggregatorV2_ResponseSyntax) **
A list of AWS Regions linked to the aggegation Region.
Type: Array of strings
Pattern: `.*\S.*`
** [RegionLinkingMode](#API_UpdateAggregatorV2_ResponseSyntax) **
Determines how AWS Regions should be linked to the Aggregator V2.
Type: String
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateAggregatorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateAggregatorV2)
# UpdateAutomationRuleV2
Updates a V2 automation rule.
## Request Syntax
```
PATCH /automationrulesv2/Identifier HTTP/1.1
Content-type: application/json
{
"Actions": [
{
"ExternalIntegrationConfiguration": {
"ConnectorArn": "string"
},
"FindingFieldsUpdate": {
"Comment": "string",
"SeverityId": number,
"StatusId": number
},
"Type": "string"
}
],
"Criteria": { ... },
"Description": "string",
"RuleName": "string",
"RuleOrder": number,
"RuleStatus": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [Identifier](#API_UpdateAutomationRuleV2_RequestSyntax) **
The ARN of the automation rule.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Actions](#API_UpdateAutomationRuleV2_RequestSyntax) **
A list of actions to be performed when the rule criteria is met.
Type: Array of [AutomationRulesActionV2](API_AutomationRulesActionV2.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [Criteria](#API_UpdateAutomationRuleV2_RequestSyntax) **
The filtering type and configuration of the automation rule.
Type: [Criteria](API_Criteria.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [Description](#API_UpdateAutomationRuleV2_RequestSyntax) **
A description of the automation rule.
Type: String
Pattern: `.*\S.*`
Required: No
** [RuleName](#API_UpdateAutomationRuleV2_RequestSyntax) **
The name of the automation rule.
Type: String
Pattern: `.*\S.*`
Required: No
** [RuleOrder](#API_UpdateAutomationRuleV2_RequestSyntax) **
Represents a value for the rule priority.
Type: Float
Valid Range: Minimum value of 1.0. Maximum value of 1000.0.
Required: No
** [RuleStatus](#API_UpdateAutomationRuleV2_RequestSyntax) **
The status of the automation rule.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateAutomationRuleV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateAutomationRuleV2)
# UpdateConfigurationPolicy
Updates a configuration policy. Only the AWS Security Hub CSPM delegated administrator can invoke this operation from the home Region.
## Request Syntax
```
PATCH /configurationPolicy/Identifier HTTP/1.1
Content-type: application/json
{
"ConfigurationPolicy": { ... },
"Description": "string",
"Name": "string",
"UpdatedReason": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [Identifier](#API_UpdateConfigurationPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [ConfigurationPolicy](#API_UpdateConfigurationPolicy_RequestSyntax) **
An object that defines how Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls).
When updating a configuration policy, provide a complete list of standards that you want to enable and a complete list of controls that you want to enable or disable. The updated configuration replaces the current configuration.
Type: [Policy](API_Policy.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [Description](#API_UpdateConfigurationPolicy_RequestSyntax) **
The description of the configuration policy.
Type: String
Pattern: `.*\S.*`
Required: No
** [Name](#API_UpdateConfigurationPolicy_RequestSyntax) **
The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted: `-, ., !, *, /`.
Type: String
Pattern: `.*\S.*`
Required: No
** [UpdatedReason](#API_UpdateConfigurationPolicy_RequestSyntax) **
The reason for updating the configuration policy.
Type: String
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"ConfigurationPolicy": { ... },
"CreatedAt": "string",
"Description": "string",
"Id": "string",
"Name": "string",
"UpdatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Arn](#API_UpdateConfigurationPolicy_ResponseSyntax) **
The ARN of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [ConfigurationPolicy](#API_UpdateConfigurationPolicy_ResponseSyntax) **
An object that defines how Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the request included a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If the request included a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls).
Type: [Policy](API_Policy.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [CreatedAt](#API_UpdateConfigurationPolicy_ResponseSyntax) **
The date and time, in UTC and ISO 8601 format, that the configuration policy was created.
Type: Timestamp
** [Description](#API_UpdateConfigurationPolicy_ResponseSyntax) **
The description of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [Id](#API_UpdateConfigurationPolicy_ResponseSyntax) **
The UUID of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [Name](#API_UpdateConfigurationPolicy_ResponseSyntax) **
The name of the configuration policy.
Type: String
Pattern: `.*\S.*`
** [UpdatedAt](#API_UpdateConfigurationPolicy_ResponseSyntax) **
The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateConfigurationPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateConfigurationPolicy)
# UpdateConnectorV2
Grants permission to update a connectorV2 based on its id and input parameters.
## Request Syntax
```
PATCH /connectorsv2/ConnectorId+ HTTP/1.1
Content-type: application/json
{
"Description": "string",
"Provider": { ... }
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [ConnectorId](#API_UpdateConnectorV2_RequestSyntax) **
The UUID of the connectorV2 to identify connectorV2 resource.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Description](#API_UpdateConnectorV2_RequestSyntax) **
The description of the connectorV2.
Type: String
Pattern: `.*\S.*`
Required: No
** [Provider](#API_UpdateConnectorV2_RequestSyntax) **
The third-party provider’s service configuration.
Type: [ProviderUpdateConfiguration](API_ProviderUpdateConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** ConflictException **
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
** InternalServerException **
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ThrottlingException **
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
** ValidationException **
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateConnectorV2)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateConnectorV2)
# UpdateFindingAggregator
**Note**
The *aggregation Region* is now called the *home Region*.
Updates cross-Region aggregation settings. You can use this operation to update the Region linking mode and the list of included or excluded AWS Regions. However, you can't use this operation to change the home Region.
You can invoke this operation from the current home Region only.
## Request Syntax
```
PATCH /findingAggregator/update HTTP/1.1
Content-type: application/json
{
"FindingAggregatorArn": "string",
"RegionLinkingMode": "string",
"Regions": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [FindingAggregatorArn](#API_UpdateFindingAggregator_RequestSyntax) **
The ARN of the finding aggregator. To obtain the ARN, use `ListFindingAggregators`.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [RegionLinkingMode](#API_UpdateFindingAggregator_RequestSyntax) **
Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub CSPM supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
+ `ALL_REGIONS` - Aggregates findings from all of the Regions where Security Hub CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.
+ `ALL_REGIONS_EXCEPT_SPECIFIED` - Aggregates findings from all of the Regions where Security Hub CSPM is enabled, except for the Regions listed in the `Regions` parameter. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.
+ `SPECIFIED_REGIONS` - Aggregates findings only from the Regions listed in the `Regions` parameter. Security Hub CSPM does not automatically aggregate findings from new Regions.
+ `NO_REGIONS` - Aggregates no data because no Regions are selected as linked Regions.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [Regions](#API_UpdateFindingAggregator_RequestSyntax) **
If `RegionLinkingMode` is `ALL_REGIONS_EXCEPT_SPECIFIED`, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.
If `RegionLinkingMode` is `SPECIFIED_REGIONS`, then this is a space-separated list of Regions that do replicate and send findings to the home Region.
An `InvalidInputException` error results if you populate this field while `RegionLinkingMode` is `NO_REGIONS`.
Type: Array of strings
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"FindingAggregationRegion": "string",
"FindingAggregatorArn": "string",
"RegionLinkingMode": "string",
"Regions": [ "string" ]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [FindingAggregationRegion](#API_UpdateFindingAggregator_ResponseSyntax) **
The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
Type: String
Pattern: `.*\S.*`
** [FindingAggregatorArn](#API_UpdateFindingAggregator_ResponseSyntax) **
The ARN of the finding aggregator.
Type: String
Pattern: `.*\S.*`
** [RegionLinkingMode](#API_UpdateFindingAggregator_ResponseSyntax) **
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
Type: String
Pattern: `.*\S.*`
** [Regions](#API_UpdateFindingAggregator_ResponseSyntax) **
The list of excluded Regions or included Regions.
Type: Array of strings
Pattern: `.*\S.*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateFindingAggregator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateFindingAggregator)
# UpdateFindings
`UpdateFindings` is a deprecated operation. Instead of `UpdateFindings`, use the `BatchUpdateFindings` operation.
The `UpdateFindings` operation updates the `Note` and `RecordState` of the AWS Security Hub CSPM aggregated findings that the filter attributes specify. Any member account that can view the finding can also see the update to the finding.
Finding updates made with `UpdateFindings` aren't persisted if the same finding is later updated by the finding provider through the `BatchImportFindings` operation. In addition, Security Hub CSPM doesn't record updates made with `UpdateFindings` in the finding history.
## Request Syntax
```
PATCH /findings HTTP/1.1
Content-type: application/json
{
"Filters": {
"AwsAccountId": [
{
"Comparison": "string",
"Value": "string"
}
],
"AwsAccountName": [
{
"Comparison": "string",
"Value": "string"
}
],
"CompanyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceAssociatedStandardsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"Confidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"CreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"Criticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"Description": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsConfidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsCriticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsRelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsRelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityOriginal": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsTypes": [
{
"Comparison": "string",
"Value": "string"
}
],
"FirstObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"GeneratorId": [
{
"Comparison": "string",
"Value": "string"
}
],
"Id": [
{
"Comparison": "string",
"Value": "string"
}
],
"Keyword": [
{
"Value": "string"
}
],
"LastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"MalwareName": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwarePath": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareState": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareType": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationIpV4": [
{
"Cidr": "string"
}
],
"NetworkDestinationIpV6": [
{
"Cidr": "string"
}
],
"NetworkDestinationPort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NetworkDirection": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkProtocol": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceIpV4": [
{
"Cidr": "string"
}
],
"NetworkSourceIpV6": [
{
"Cidr": "string"
}
],
"NetworkSourceMac": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourcePort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NoteText": [
{
"Comparison": "string",
"Value": "string"
}
],
"NoteUpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteUpdatedBy": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProcessName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessParentPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessPath": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessTerminatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ProductName": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecommendationText": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecordState": [
{
"Comparison": "string",
"Value": "string"
}
],
"Region": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIamInstanceProfileArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIpV4Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceIpV6Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceKeyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsEc2InstanceSubnetId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceVpcId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyCreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsIamAccessKeyPrincipalName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamUserUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceContainerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceDetailsOther": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourcePartition": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceRegion": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceTags": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"Sample": [
{
"Value": boolean
}
],
"SeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"SeverityNormalized": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SeverityProduct": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorCategory": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorLastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ThreatIntelIndicatorSource": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorSourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"Title": [
{
"Comparison": "string",
"Value": "string"
}
],
"Type": [
{
"Comparison": "string",
"Value": "string"
}
],
"UpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"UserDefinedFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"VerificationState": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesExploitAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesFixAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowState": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowStatus": [
{
"Comparison": "string",
"Value": "string"
}
]
},
"Note": {
"Text": "string",
"UpdatedBy": "string"
},
"RecordState": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Filters](#API_UpdateFindings_RequestSyntax) **
A collection of attributes that specify which findings you want to update.
Type: [AwsSecurityFindingFilters](API_AwsSecurityFindingFilters.md) object
Required: Yes
** [Note](#API_UpdateFindings_RequestSyntax) **
The updated note for the finding.
Type: [NoteUpdate](API_NoteUpdate.md) object
Required: No
** [RecordState](#API_UpdateFindings_RequestSyntax) **
The updated record state for the finding.
Type: String
Valid Values: `ACTIVE | ARCHIVED`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateFindings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateFindings)
# UpdateInsight
Updates the Security Hub CSPM insight identified by the specified insight ARN.
## Request Syntax
```
PATCH /insights/InsightArn+ HTTP/1.1
Content-type: application/json
{
"Filters": {
"AwsAccountId": [
{
"Comparison": "string",
"Value": "string"
}
],
"AwsAccountName": [
{
"Comparison": "string",
"Value": "string"
}
],
"CompanyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceAssociatedStandardsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceSecurityControlParametersValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"ComplianceStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"Confidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"CreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"Criticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"Description": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsConfidence": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsCriticality": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"FindingProviderFieldsRelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsRelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsSeverityOriginal": [
{
"Comparison": "string",
"Value": "string"
}
],
"FindingProviderFieldsTypes": [
{
"Comparison": "string",
"Value": "string"
}
],
"FirstObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"GeneratorId": [
{
"Comparison": "string",
"Value": "string"
}
],
"Id": [
{
"Comparison": "string",
"Value": "string"
}
],
"Keyword": [
{
"Value": "string"
}
],
"LastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"MalwareName": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwarePath": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareState": [
{
"Comparison": "string",
"Value": "string"
}
],
"MalwareType": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkDestinationIpV4": [
{
"Cidr": "string"
}
],
"NetworkDestinationIpV6": [
{
"Cidr": "string"
}
],
"NetworkDestinationPort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NetworkDirection": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkProtocol": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceDomain": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourceIpV4": [
{
"Cidr": "string"
}
],
"NetworkSourceIpV6": [
{
"Cidr": "string"
}
],
"NetworkSourceMac": [
{
"Comparison": "string",
"Value": "string"
}
],
"NetworkSourcePort": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"NoteText": [
{
"Comparison": "string",
"Value": "string"
}
],
"NoteUpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"NoteUpdatedBy": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProcessName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessParentPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessPath": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProcessPid": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"ProcessTerminatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ProductFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ProductName": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecommendationText": [
{
"Comparison": "string",
"Value": "string"
}
],
"RecordState": [
{
"Comparison": "string",
"Value": "string"
}
],
"Region": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsId": [
{
"Comparison": "string",
"Value": "string"
}
],
"RelatedFindingsProductArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceApplicationName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIamInstanceProfileArn": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceIpV4Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceIpV6Addresses": [
{
"Cidr": "string"
}
],
"ResourceAwsEc2InstanceKeyName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsEc2InstanceSubnetId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsEc2InstanceVpcId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyCreatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceAwsIamAccessKeyPrincipalName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyStatus": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamAccessKeyUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsIamUserUserName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceAwsS3BucketOwnerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerImageName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceContainerLaunchedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ResourceContainerName": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceDetailsOther": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceId": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourcePartition": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceRegion": [
{
"Comparison": "string",
"Value": "string"
}
],
"ResourceTags": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"ResourceType": [
{
"Comparison": "string",
"Value": "string"
}
],
"Sample": [
{
"Value": boolean
}
],
"SeverityLabel": [
{
"Comparison": "string",
"Value": "string"
}
],
"SeverityNormalized": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SeverityProduct": [
{
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
],
"SourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorCategory": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorLastObservedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"ThreatIntelIndicatorSource": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorSourceUrl": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorType": [
{
"Comparison": "string",
"Value": "string"
}
],
"ThreatIntelIndicatorValue": [
{
"Comparison": "string",
"Value": "string"
}
],
"Title": [
{
"Comparison": "string",
"Value": "string"
}
],
"Type": [
{
"Comparison": "string",
"Value": "string"
}
],
"UpdatedAt": [
{
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
],
"UserDefinedFields": [
{
"Comparison": "string",
"Key": "string",
"Value": "string"
}
],
"VerificationState": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesExploitAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"VulnerabilitiesFixAvailable": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowState": [
{
"Comparison": "string",
"Value": "string"
}
],
"WorkflowStatus": [
{
"Comparison": "string",
"Value": "string"
}
]
},
"GroupByAttribute": "string",
"Name": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [InsightArn](#API_UpdateInsight_RequestSyntax) **
The ARN of the insight that you want to update.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Filters](#API_UpdateInsight_RequestSyntax) **
The updated filters that define this insight.
Type: [AwsSecurityFindingFilters](API_AwsSecurityFindingFilters.md) object
Required: No
** [GroupByAttribute](#API_UpdateInsight_RequestSyntax) **
The updated `GroupBy` attribute that defines this insight.
Type: String
Pattern: `.*\S.*`
Required: No
** [Name](#API_UpdateInsight_RequestSyntax) **
The updated name for the insight.
Type: String
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateInsight)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateInsight)
# UpdateOrganizationConfiguration
Updates the configuration of your organization in AWS Security Hub CSPM. Only the Security Hub CSPM administrator account can invoke this operation.
## Request Syntax
```
POST /organization/configuration HTTP/1.1
Content-type: application/json
{
"AutoEnable": boolean,
"AutoEnableStandards": "string",
"OrganizationConfiguration": {
"ConfigurationType": "string",
"Status": "string",
"StatusMessage": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AutoEnable](#API_UpdateOrganizationConfiguration_RequestSyntax) **
Whether to automatically enable Security Hub CSPM in new member accounts when they join the organization.
If set to `true`, then Security Hub CSPM is automatically enabled in new accounts. If set to `false`, then Security Hub CSPM isn't enabled in new accounts automatically. The default value is `false`.
If the `ConfigurationType` of your organization is set to `CENTRAL`, then this field is set to `false` and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub CSPM is enabled and associate the policy with new organization accounts.
Type: Boolean
Required: Yes
** [AutoEnableStandards](#API_UpdateOrganizationConfiguration_RequestSyntax) **
Whether to automatically enable Security Hub CSPM [default standards](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html) in new member accounts when they join the organization.
The default value of this parameter is equal to `DEFAULT`.
If equal to `DEFAULT`, then Security Hub CSPM default standards are automatically enabled for new member accounts. If equal to `NONE`, then default standards are not automatically enabled for new member accounts.
If the `ConfigurationType` of your organization is set to `CENTRAL`, then this field is set to `NONE` and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.
Type: String
Valid Values: `NONE | DEFAULT`
Required: No
** [OrganizationConfiguration](#API_UpdateOrganizationConfiguration_RequestSyntax) **
Provides information about the way an organization is configured in AWS Security Hub CSPM.
Type: [OrganizationConfiguration](API_OrganizationConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceConflictException **
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateOrganizationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateOrganizationConfiguration)
# UpdateSecurityControl
Updates the properties of a security control.
## Request Syntax
```
PATCH /securityControl/update HTTP/1.1
Content-type: application/json
{
"LastUpdateReason": "string",
"Parameters": {
"string" : {
"Value": { ... },
"ValueType": "string"
}
},
"SecurityControlId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [LastUpdateReason](#API_UpdateSecurityControl_RequestSyntax) **
The most recent reason for updating the properties of the security control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
Type: String
Pattern: `^([^\u0000-\u007F]|[-_ a-zA-Z0-9])+$`
Required: No
** [Parameters](#API_UpdateSecurityControl_RequestSyntax) **
An object that specifies which security control parameters to update.
Type: String to [ParameterConfiguration](API_ParameterConfiguration.md) object map
Key Pattern: `.*\S.*`
Required: Yes
** [SecurityControlId](#API_UpdateSecurityControl_RequestSyntax) **
The Amazon Resource Name (ARN) or ID of the control to update.
Type: String
Pattern: `.*\S.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceInUseException **
The request was rejected because it conflicts with the resource's availability. For example, you tried to update a security control that's currently in the `UPDATING` state.
HTTP Status Code: 400
** ResourceInUseException **
The request was rejected because it conflicts with the resource's availability. For example, you tried to update a security control that's currently in the `UPDATING` state.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateSecurityControl)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateSecurityControl)
# UpdateSecurityHubConfiguration
Updates configuration options for Security Hub CSPM.
## Request Syntax
```
PATCH /accounts HTTP/1.1
Content-type: application/json
{
"AutoEnableControls": boolean,
"ControlFindingGenerator": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [AutoEnableControls](#API_UpdateSecurityHubConfiguration_RequestSyntax) **
Whether to automatically enable new controls when they are added to standards that are enabled.
By default, this is set to `true`, and new controls are enabled automatically. To not automatically enable new controls, set this to `false`.
When you automatically enable new controls, you can interact with the controls in the console and programmatically immediately after release. However, automatically enabled controls have a temporary default status of `DISABLED`. It can take up to several days for Security Hub CSPM to process the control release and designate the control as `ENABLED` in your account. During the processing period, you can manually enable or disable a control, and Security Hub CSPM will maintain that designation regardless of whether you have `AutoEnableControls` set to `true`.
Type: Boolean
Required: No
** [ControlFindingGenerator](#API_UpdateSecurityHubConfiguration_RequestSyntax) **
Updates whether the calling account has consolidated control findings turned on. If the value for this field is set to `SECURITY_CONTROL`, Security Hub CSPM generates a single finding for a control check even when the check applies to multiple enabled standards.
If the value for this field is set to `STANDARD_CONTROL`, Security Hub CSPM generates separate findings for a control check when the check applies to multiple enabled standards.
For accounts that are part of an organization, this value can only be updated in the administrator account.
Type: String
Valid Values: `STANDARD_CONTROL | SECURITY_CONTROL`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** LimitExceededException **
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateSecurityHubConfiguration)
# UpdateStandardsControl
Used to control whether an individual security standard control is enabled or disabled.
Calls to this operation return a `RESOURCE_NOT_FOUND_EXCEPTION` error when the standard subscription for the control has `StandardsControlsUpdatable` value `NOT_READY_FOR_UPDATES`.
## Request Syntax
```
PATCH /standards/control/StandardsControlArn+ HTTP/1.1
Content-type: application/json
{
"ControlStatus": "string",
"DisabledReason": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [StandardsControlArn](#API_UpdateStandardsControl_RequestSyntax) **
The ARN of the security standard control to enable or disable.
Pattern: `.*\S.*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [ControlStatus](#API_UpdateStandardsControl_RequestSyntax) **
The updated status of the security standard control.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
** [DisabledReason](#API_UpdateStandardsControl_RequestSyntax) **
A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.
Type: String
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
** InternalException **
Internal server error.
HTTP Status Code: 500
** InvalidAccessException **
The account doesn't have permission to perform this action.
HTTP Status Code: 401
** InvalidInputException **
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityhub-2018-10-26/UpdateStandardsControl)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityhub-2018-10-26/UpdateStandardsControl)