SDK for PHP 3.x

Client: Aws\SecurityHub\SecurityHubClient
Service ID: securityhub
Version: 2018-10-26

This page describes the parameters and results for the operations of the AWS SecurityHub (2018-10-26), and shows how to use the Aws\SecurityHub\SecurityHubClient object to call the described operations. This documentation is specific to the 2018-10-26 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcceptAdministratorInvitation ( array $params = [] )
We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
AcceptInvitation ( array $params = [] )
This method is deprecated.
BatchDeleteAutomationRules ( array $params = [] )
Deletes one or more automation rules.
BatchDisableStandards ( array $params = [] )
Disables the standards specified by the provided StandardsSubscriptionArns.
BatchEnableStandards ( array $params = [] )
Enables the standards specified by the provided StandardsArn.
BatchGetAutomationRules ( array $params = [] )
Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
BatchGetConfigurationPolicyAssociations ( array $params = [] )
Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root.
BatchGetSecurityControls ( array $params = [] )
Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
BatchGetStandardsControlAssociations ( array $params = [] )
For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
BatchImportFindings ( array $params = [] )
Imports security findings generated by a finding provider into Security Hub.
BatchUpdateAutomationRules ( array $params = [] )
Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
BatchUpdateFindings ( array $params = [] )
Used by Security Hub customers to update information about their investigation into a finding.
BatchUpdateStandardsControlAssociations ( array $params = [] )
For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
CreateActionTarget ( array $params = [] )
Creates a custom action target in Security Hub.
CreateAutomationRule ( array $params = [] )
Creates an automation rule based on input parameters.
CreateConfigurationPolicy ( array $params = [] )
Creates a configuration policy with the defined configuration.
CreateFindingAggregator ( array $params = [] )
The aggregation Region is now called the home Region.
CreateInsight ( array $params = [] )
Creates a custom insight in Security Hub.
CreateMembers ( array $params = [] )
Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account.
DeclineInvitations ( array $params = [] )
We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
DeleteActionTarget ( array $params = [] )
Deletes a custom action target from Security Hub.
DeleteConfigurationPolicy ( array $params = [] )
Deletes a configuration policy.
DeleteFindingAggregator ( array $params = [] )
The aggregation Region is now called the home Region.
DeleteInsight ( array $params = [] )
Deletes the insight specified by the InsightArn.
DeleteInvitations ( array $params = [] )
We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
DeleteMembers ( array $params = [] )
Deletes the specified member accounts from Security Hub.
DescribeActionTargets ( array $params = [] )
Returns a list of the custom action targets in Security Hub in your account.
DescribeHub ( array $params = [] )
Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.
DescribeOrganizationConfiguration ( array $params = [] )
Returns information about the way your organization is configured in Security Hub.
DescribeProducts ( array $params = [] )
Returns information about product integrations in Security Hub.
DescribeStandards ( array $params = [] )
Returns a list of the available standards in Security Hub.
DescribeStandardsControls ( array $params = [] )
Returns a list of security standards controls.
DisableImportFindingsForProduct ( array $params = [] )
Disables the integration of the specified product with Security Hub.
DisableOrganizationAdminAccount ( array $params = [] )
Disables a Security Hub administrator account.
DisableSecurityHub ( array $params = [] )
Disables Security Hub in your account only in the current Amazon Web Services Region.
DisassociateFromAdministratorAccount ( array $params = [] )
Disassociates the current Security Hub member account from the associated administrator account.
DisassociateFromMasterAccount ( array $params = [] )
This method is deprecated.
DisassociateMembers ( array $params = [] )
Disassociates the specified member accounts from the associated administrator account.
EnableImportFindingsForProduct ( array $params = [] )
Enables the integration of a partner product with Security Hub.
EnableOrganizationAdminAccount ( array $params = [] )
Designates the Security Hub administrator account for an organization.
EnableSecurityHub ( array $params = [] )
Enables Security Hub for your account in the current Region or the Region you specify in the request.
GetAdministratorAccount ( array $params = [] )
Provides the details for the Security Hub administrator account for the current member account.
GetConfigurationPolicy ( array $params = [] )
Provides information about a configuration policy.
GetConfigurationPolicyAssociation ( array $params = [] )
Returns the association between a configuration and a target account, organizational unit, or the root.
GetEnabledStandards ( array $params = [] )
Returns a list of the standards that are currently enabled.
GetFindingAggregator ( array $params = [] )
The aggregation Region is now called the home Region.
GetFindingHistory ( array $params = [] )
Returns history for a Security Hub finding in the last 90 days.
GetFindings ( array $params = [] )
Returns a list of findings that match the specified criteria.
GetInsightResults ( array $params = [] )
Lists the results of the Security Hub insight specified by the insight ARN.
GetInsights ( array $params = [] )
Lists and describes insights for the specified insight ARNs.
GetInvitationsCount ( array $params = [] )
We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
GetMasterAccount ( array $params = [] )
This method is deprecated.
GetMembers ( array $params = [] )
Returns the details for the Security Hub member accounts for the specified account IDs.
GetSecurityControlDefinition ( array $params = [] )
Retrieves the definition of a security control.
InviteMembers ( array $params = [] )
We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
ListAutomationRules ( array $params = [] )
A list of automation rules and their metadata for the calling account.
ListConfigurationPolicies ( array $params = [] )
Lists the configuration policies that the Security Hub delegated administrator has created for your organization.
ListConfigurationPolicyAssociations ( array $params = [] )
Provides information about the associations for your configuration policies and self-managed behavior.
ListEnabledProductsForImport ( array $params = [] )
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
ListFindingAggregators ( array $params = [] )
If cross-Region aggregation is enabled, then ListFindingAggregators returns the Amazon Resource Name (ARN) of the finding aggregator.
ListInvitations ( array $params = [] )
We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
ListMembers ( array $params = [] )
Lists details about all member accounts for the current Security Hub administrator account.
ListOrganizationAdminAccounts ( array $params = [] )
Lists the Security Hub administrator accounts.
ListSecurityControlDefinitions ( array $params = [] )
Lists all of the security controls that apply to a specified standard.
ListStandardsControlAssociations ( array $params = [] )
Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
ListTagsForResource ( array $params = [] )
Returns a list of tags associated with a resource.
StartConfigurationPolicyAssociation ( array $params = [] )
Associates a target account, organizational unit, or the root with a specified configuration.
StartConfigurationPolicyDisassociation ( array $params = [] )
Disassociates a target account, organizational unit, or the root from a specified configuration.
TagResource ( array $params = [] )
Adds one or more tags to a resource.
UntagResource ( array $params = [] )
Removes one or more tags from a resource.
UpdateActionTarget ( array $params = [] )
Updates the name and description of a custom action target in Security Hub.
UpdateConfigurationPolicy ( array $params = [] )
Updates a configuration policy.
UpdateFindingAggregator ( array $params = [] )
The aggregation Region is now called the home Region.
UpdateFindings ( array $params = [] )
UpdateFindings is a deprecated operation.
UpdateInsight ( array $params = [] )
Updates the Security Hub insight identified by the specified insight ARN.
UpdateOrganizationConfiguration ( array $params = [] )
Updates the configuration of your organization in Security Hub.
UpdateSecurityControl ( array $params = [] )
Updates the properties of a security control.
UpdateSecurityHubConfiguration ( array $params = [] )
Updates configuration options for Security Hub.
UpdateStandardsControl ( array $params = [] )
Used to control whether an individual security standard control is enabled or disabled.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeActionTargets
DescribeProducts
DescribeStandards
DescribeStandardsControls
GetEnabledStandards
GetFindingHistory
GetFindings
GetInsights
ListConfigurationPolicies
ListConfigurationPolicyAssociations
ListEnabledProductsForImport
ListFindingAggregators
ListInvitations
ListMembers
ListOrganizationAdminAccounts
ListSecurityControlDefinitions
ListStandardsControlAssociations

Operations

AcceptAdministratorInvitation

$result = $client->acceptAdministratorInvitation([/* ... */]);
$promise = $client->acceptAdministratorInvitationAsync([/* ... */]);

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.

Accepts the invitation to be a member account and be monitored by the Security Hub 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.

Parameter Syntax

$result = $client->acceptAdministratorInvitation([
    'AdministratorId' => '<string>', // REQUIRED
    'InvitationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AdministratorId
Required: Yes
Type: string

The account ID of the Security Hub administrator account that sent the invitation.

InvitationId
Required: Yes
Type: string

The identifier of the invitation sent from the Security Hub administrator account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

InvalidAccessException:

The account doesn't have permission to perform this action.

Examples

Example 1: To accept an invitation be a member account

The following example demonstrates how an account can accept an invitation from the Security Hub administrator account to be a member account. This operation is applicable only to member accounts that are not added through AWS Organizations.

$result = $client->acceptAdministratorInvitation([
    'AdministratorId' => '123456789012',
    'InvitationId' => '7ab938c5d52d7904ad09f9e7c20cc4eb',
]);

AcceptInvitation

$result = $client->acceptInvitation([/* ... */]);
$promise = $client->acceptInvitationAsync([/* ... */]);

This method is deprecated. Instead, use AcceptAdministratorInvitation.

The Security Hub 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 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.

Parameter Syntax

$result = $client->acceptInvitation([
    'InvitationId' => '<string>', // REQUIRED
    'MasterId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InvitationId
Required: Yes
Type: string

The identifier of the invitation sent from the Security Hub administrator account.

MasterId
Required: Yes
Type: string

The account ID of the Security Hub administrator account that sent the invitation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

InvalidAccessException:

The account doesn't have permission to perform this action.

BatchDeleteAutomationRules

$result = $client->batchDeleteAutomationRules([/* ... */]);
$promise = $client->batchDeleteAutomationRulesAsync([/* ... */]);

Deletes one or more automation rules.

Parameter Syntax

$result = $client->batchDeleteAutomationRules([
    'AutomationRulesArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
AutomationRulesArns
Required: Yes
Type: Array of strings

A list of Amazon Resource Names (ARNs) for the rules that are to be deleted.

Result Syntax

[
    'ProcessedAutomationRules' => ['<string>', ...],
    'UnprocessedAutomationRules' => [
        [
            'ErrorCode' => <integer>,
            'ErrorMessage' => '<string>',
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ProcessedAutomationRules
Type: Array of strings

A list of properly processed rule ARNs.

UnprocessedAutomationRules
Type: Array of UnprocessedAutomationRule structures

A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn't delete and why.

Errors

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To delete one or more automation rules

The following example deletes the specified automation rules.

$result = $client->batchDeleteAutomationRules([
    'AutomationRulesArns' => [
        'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
    ],
]);

Result syntax:

[
    'ProcessedAutomationRules' => [
        'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    ],
    'UnprocessedAutomationRules' => [
        [
            'ErrorCode' => 500,
            'ErrorMessage' => 'InternalException',
            'RuleArn' => 'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
        ],
    ],
]

BatchDisableStandards

$result = $client->batchDisableStandards([/* ... */]);
$promise = $client->batchDisableStandardsAsync([/* ... */]);

Disables the standards specified by the provided StandardsSubscriptionArns.

For more information, see Security Standards section of the Security Hub User Guide.

Parameter Syntax

$result = $client->batchDisableStandards([
    'StandardsSubscriptionArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
StandardsSubscriptionArns
Required: Yes
Type: Array of strings

The ARNs of the standards subscriptions to disable.

Result Syntax

[
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => '<string>',
            'StandardsInput' => ['<string>', ...],
            'StandardsStatus' => 'PENDING|READY|FAILED|DELETING|INCOMPLETE',
            'StandardsStatusReason' => [
                'StatusReasonCode' => 'NO_AVAILABLE_CONFIGURATION_RECORDER|INTERNAL_ERROR',
            ],
            'StandardsSubscriptionArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
StandardsSubscriptions
Type: Array of StandardsSubscription structures

The details of the standards subscriptions that were disabled.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To disable one or more security standards

The following example disables a security standard in Security Hub.

$result = $client->batchDisableStandards([
    'StandardsSubscriptionArns' => [
        'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1',
    ],
]);

Result syntax:

[
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => 'arn:aws:securityhub:eu-central-1::standards/pci-dss/v/3.2.1',
            'StandardsInput' => [
            ],
            'StandardsStatus' => 'DELETING',
            'StandardsSubscriptionArn' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1',
        ],
    ],
]

BatchEnableStandards

$result = $client->batchEnableStandards([/* ... */]);
$promise = $client->batchEnableStandardsAsync([/* ... */]);

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 section of the Security Hub User Guide.

Parameter Syntax

$result = $client->batchEnableStandards([
    'StandardsSubscriptionRequests' => [ // REQUIRED
        [
            'StandardsArn' => '<string>', // REQUIRED
            'StandardsInput' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members
StandardsSubscriptionRequests
Required: Yes
Type: Array of StandardsSubscriptionRequest structures

The list of standards checks to enable.

Result Syntax

[
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => '<string>',
            'StandardsInput' => ['<string>', ...],
            'StandardsStatus' => 'PENDING|READY|FAILED|DELETING|INCOMPLETE',
            'StandardsStatusReason' => [
                'StatusReasonCode' => 'NO_AVAILABLE_CONFIGURATION_RECORDER|INTERNAL_ERROR',
            ],
            'StandardsSubscriptionArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
StandardsSubscriptions
Type: Array of StandardsSubscription structures

The details of the standards subscriptions that were enabled.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To enable security standards

The following example enables the security standard specified by the StandardArn. You can use this operation to enable one or more Security Hub standards.

$result = $client->batchEnableStandards([
    'StandardsSubscriptionRequests' => [
        [
            'StandardsArn' => 'arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1',
        ],
    ],
]);

Result syntax:

[
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => 'arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1',
            'StandardsInput' => [
            ],
            'StandardsStatus' => 'PENDING',
            'StandardsSubscriptionArn' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1',
        ],
    ],
]

BatchGetAutomationRules

$result = $client->batchGetAutomationRules([/* ... */]);
$promise = $client->batchGetAutomationRulesAsync([/* ... */]);

Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).

Parameter Syntax

$result = $client->batchGetAutomationRules([
    'AutomationRulesArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
AutomationRulesArns
Required: Yes
Type: Array of strings

A list of rule ARNs to get details for.

Result Syntax

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'FindingFieldsUpdate' => [
                        'Confidence' => <integer>,
                        'Criticality' => <integer>,
                        'Note' => [
                            'Text' => '<string>',
                            'UpdatedBy' => '<string>',
                        ],
                        'RelatedFindings' => [
                            [
                                'Id' => '<string>',
                                'ProductArn' => '<string>',
                            ],
                            // ...
                        ],
                        'Severity' => [
                            'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
                            'Normalized' => <integer>,
                            'Product' => <float>,
                        ],
                        'Types' => ['<string>', ...],
                        'UserDefinedFields' => ['<string>', ...],
                        'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
                        'Workflow' => [
                            'Status' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
                        ],
                    ],
                    'Type' => 'FINDING_FIELDS_UPDATE',
                ],
                // ...
            ],
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'Criteria' => [
                'AwsAccountId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'AwsAccountName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'CompanyName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ComplianceAssociatedStandardsId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ComplianceSecurityControlId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ComplianceStatus' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Confidence' => [
                    [
                        'Eq' => <float>,
                        'Gt' => <float>,
                        'Gte' => <float>,
                        'Lt' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'CreatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'Criticality' => [
                    [
                        'Eq' => <float>,
                        'Gt' => <float>,
                        'Gte' => <float>,
                        'Lt' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'Description' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'FirstObservedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'GeneratorId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Id' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'LastObservedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'NoteText' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NoteUpdatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'NoteUpdatedBy' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProductArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProductName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RecordState' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RelatedFindingsId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RelatedFindingsProductArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceApplicationArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceApplicationName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceDetailsOther' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourcePartition' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceRegion' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceTags' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceType' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'SeverityLabel' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'SourceUrl' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Title' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Type' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'UpdatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'UserDefinedFields' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VerificationState' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'WorkflowStatus' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Description' => '<string>',
            'IsTerminal' => true || false,
            'RuleArn' => '<string>',
            'RuleName' => '<string>',
            'RuleOrder' => <integer>,
            'RuleStatus' => 'ENABLED|DISABLED',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'UnprocessedAutomationRules' => [
        [
            'ErrorCode' => <integer>,
            'ErrorMessage' => '<string>',
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Rules
Type: Array of AutomationRulesConfig structures

A list of rule details for the provided rule ARNs.

UnprocessedAutomationRules
Type: Array of UnprocessedAutomationRule structures

A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn't retrieve and why.

Errors

AccessDeniedException:

You don't have permission to perform the action specified in the request.

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To update one ore more automation rules

The following example updates the specified automation rules.

$result = $client->batchGetAutomationRules([
    'AutomationRulesArns' => [
        'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
    ],
]);

Result syntax:

[
    'Rules' => [
        [
            'Actions' => [
                [
                    'FindingFieldsUpdate' => [
                        'Workflow' => [
                            'Status' => 'RESOLVED',
                        ],
                    ],
                    'Type' => 'FINDING_FIELDS_UPDATE',
                ],
            ],
            'CreatedAt' => ,
            'CreatedBy' => 'AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14',
            'Criteria' => [
                'AwsAccountId' => [
                    [
                        'Comparison' => 'EQUALS',
                        'Value' => '111122223333',
                    ],
                ],
                'FirstObservedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => 5,
                        ],
                    ],
                ],
                'Type' => [
                    [
                        'Comparison' => 'EQUALS',
                        'Value' => 'Software and Configuration Checks/Industry and Regulatory Standards',
                    ],
                ],
            ],
            'Description' => 'sample rule description 1',
            'RuleArn' => 'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
            'RuleName' => 'sample-rule-name-1',
            'RuleOrder' => 1,
            'RuleStatus' => 'ENABLED',
            'UpdatedAt' => ,
        ],
        [
            'Actions' => [
                [
                    'FindingFieldsUpdate' => [
                        'Workflow' => [
                            'Status' => 'RESOLVED',
                        ],
                    ],
                    'Type' => 'FINDING_FIELDS_UPDATE',
                ],
            ],
            'CreatedAt' => ,
            'CreatedBy' => 'AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14',
            'Criteria' => [
                'ResourceType' => [
                    [
                        'Comparison' => 'EQUALS',
                        'Value' => 'Ec2Instance',
                    ],
                ],
                'SeverityLabel' => [
                    [
                        'Comparison' => 'EQUALS',
                        'Value' => 'INFORMATIONAL',
                    ],
                ],
            ],
            'Description' => 'Sample rule description 2',
            'RuleArn' => 'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
            'RuleName' => 'sample-rule-name-2',
            'RuleOrder' => 2,
            'RuleStatus' => 'ENABLED',
            'UpdatedAt' => ,
        ],
    ],
]

BatchGetConfigurationPolicyAssociations

$result = $client->batchGetConfigurationPolicyAssociations([/* ... */]);
$promise = $client->batchGetConfigurationPolicyAssociationsAsync([/* ... */]);

Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.

Parameter Syntax

$result = $client->batchGetConfigurationPolicyAssociations([
    'ConfigurationPolicyAssociationIdentifiers' => [ // REQUIRED
        [
            'Target' => [
                'AccountId' => '<string>',
                'OrganizationalUnitId' => '<string>',
                'RootId' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigurationPolicyAssociationIdentifiers
Required: Yes
Type: Array of ConfigurationPolicyAssociation structures

Specifies one or more target account IDs, organizational unit (OU) IDs, or the root ID to retrieve associations for.

Result Syntax

[
    'ConfigurationPolicyAssociations' => [
        [
            'AssociationStatus' => 'PENDING|SUCCESS|FAILED',
            'AssociationStatusMessage' => '<string>',
            'AssociationType' => 'INHERITED|APPLIED',
            'ConfigurationPolicyId' => '<string>',
            'TargetId' => '<string>',
            'TargetType' => 'ACCOUNT|ORGANIZATIONAL_UNIT|ROOT',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'UnprocessedConfigurationPolicyAssociations' => [
        [
            'ConfigurationPolicyAssociationIdentifiers' => [
                'Target' => [
                    'AccountId' => '<string>',
                    'OrganizationalUnitId' => '<string>',
                    'RootId' => '<string>',
                ],
            ],
            'ErrorCode' => '<string>',
            'ErrorReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ConfigurationPolicyAssociations
Type: Array of ConfigurationPolicyAssociationSummary structures

Describes associations for the target accounts, OUs, or the root.

UnprocessedConfigurationPolicyAssociations
Type: Array of UnprocessedConfigurationPolicyAssociation structures

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.

Errors

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To get configuration associations for a batch of targets

This operation provides details about configuration associations for a batch of target accounts, organizational units, or the root.

$result = $client->batchGetConfigurationPolicyAssociations([
    'ConfigurationPolicyAssociationIdentifiers' => [
        [
            'Target' => [
                'AccountId' => '111122223333',
            ],
        ],
        [
            'Target' => [
                'RootId' => 'r-f6g7h8i9j0example',
            ],
        ],
    ],
]);

Result syntax:

[
    'ConfigurationPolicyAssociations' => [
        [
            'AssociationStatus' => 'SUCCESS',
            'AssociationStatusMessage' => 'This field is only populated for a failed association',
            'AssociationType' => 'INHERITED',
            'ConfigurationPolicyId' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
            'TargetId' => '111122223333',
            'TargetType' => 'ACCOUNT',
            'UpdatedAt' => ,
        ],
    ],
    'UnprocessedConfigurationPolicyAssociations' => [
        [
            'ConfigurationPolicyAssociationIdentifiers' => [
                'Target' => [
                    'RootId' => 'r-f6g7h8i9j0example',
                ],
            ],
            'ErrorCode' => '400',
            'ErrorReason' => 'You do not have sufficient access to perform this action.',
        ],
    ],
]

BatchGetSecurityControls

$result = $client->batchGetSecurityControls([/* ... */]);
$promise = $client->batchGetSecurityControlsAsync([/* ... */]);

Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.

Parameter Syntax

$result = $client->batchGetSecurityControls([
    'SecurityControlIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
SecurityControlIds
Required: Yes
Type: Array of strings

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.

Result Syntax

[
    'SecurityControls' => [
        [
            'Description' => '<string>',
            'LastUpdateReason' => '<string>',
            'Parameters' => [
                '<NonEmptyString>' => [
                    'Value' => [
                        'Boolean' => true || false,
                        'Double' => <float>,
                        'Enum' => '<string>',
                        'EnumList' => ['<string>', ...],
                        'Integer' => <integer>,
                        'IntegerList' => [<integer>, ...],
                        'String' => '<string>',
                        'StringList' => ['<string>', ...],
                    ],
                    'ValueType' => 'DEFAULT|CUSTOM',
                ],
                // ...
            ],
            'RemediationUrl' => '<string>',
            'SecurityControlArn' => '<string>',
            'SecurityControlId' => '<string>',
            'SecurityControlStatus' => 'ENABLED|DISABLED',
            'SeverityRating' => 'LOW|MEDIUM|HIGH|CRITICAL',
            'Title' => '<string>',
            'UpdateStatus' => 'READY|UPDATING',
        ],
        // ...
    ],
    'UnprocessedIds' => [
        [
            'ErrorCode' => 'INVALID_INPUT|ACCESS_DENIED|NOT_FOUND|LIMIT_EXCEEDED',
            'ErrorReason' => '<string>',
            'SecurityControlId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
SecurityControls
Required: Yes
Type: Array of SecurityControl structures

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.

UnprocessedIds
Type: Array of UnprocessedSecurityControl structures

A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which details cannot be returned.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

Examples

Example 1: To get security control details

The following example gets details for the specified controls in the current AWS account and AWS Region.

$result = $client->batchGetSecurityControls([
    'SecurityControlIds' => [
        'ACM.1',
        'APIGateway.1',
    ],
]);

Result syntax:

[
    'SecurityControls' => [
        [
            'Description' => 'This AWS control checks whether ACM Certificates in your account are marked for expiration within a specified time period. Certificates provided by ACM are automatically renewed. ACM does not automatically renew certificates that you import.',
            'LastUpdateReason' => 'Stayed with default value',
            'Parameters' => [
                'daysToExpiration' => [
                    'Value' => [
                        'Integer' => 30,
                    ],
                    'ValueType' => 'DEFAULT',
                ],
            ],
            'RemediationUrl' => 'https://docs.aws.amazon.com/console/securityhub/ACM.1/remediation',
            'SecurityControlArn' => 'arn:aws:securityhub:us-west-2:123456789012:security-control/ACM.1',
            'SecurityControlId' => 'ACM.1',
            'SecurityControlStatus' => 'ENABLED',
            'SeverityRating' => 'MEDIUM',
            'Title' => 'Imported and ACM-issued certificates should be renewed after a specified time period',
            'UpdateStatus' => 'UPDATING',
        ],
        [
            'Description' => 'This control checks whether all stages of Amazon API Gateway REST and WebSocket APIs have logging enabled. The control fails if logging is not enabled for all methods of a stage or if loggingLevel is neither ERROR nor INFO.',
            'LastUpdateReason' => 'Updated control parameters to comply with internal requirements',
            'Parameters' => [
                'loggingLevel' => [
                    'Value' => [
                        'Enum' => 'ERROR',
                    ],
                    'ValueType' => 'CUSTOM',
                ],
            ],
            'RemediationUrl' => 'https://docs.aws.amazon.com/console/securityhub/APIGateway.1/remediation',
            'SecurityControlArn' => 'arn:aws:securityhub:us-west-2:123456789012:security-control/APIGateway.1',
            'SecurityControlId' => 'APIGateway.1',
            'SecurityControlStatus' => 'ENABLED',
            'SeverityRating' => 'MEDIUM',
            'Title' => 'API Gateway REST and WebSocket API execution logging should be enabled',
            'UpdateStatus' => 'UPDATING',
        ],
    ],
]

BatchGetStandardsControlAssociations

$result = $client->batchGetStandardsControlAssociations([/* ... */]);
$promise = $client->batchGetStandardsControlAssociationsAsync([/* ... */]);

For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.

Parameter Syntax

$result = $client->batchGetStandardsControlAssociations([
    'StandardsControlAssociationIds' => [ // REQUIRED
        [
            'SecurityControlId' => '<string>', // REQUIRED
            'StandardsArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
StandardsControlAssociationIds
Required: Yes
Type: Array of StandardsControlAssociationId structures

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.

Result Syntax

[
    'StandardsControlAssociationDetails' => [
        [
            'AssociationStatus' => 'ENABLED|DISABLED',
            'RelatedRequirements' => ['<string>', ...],
            'SecurityControlArn' => '<string>',
            'SecurityControlId' => '<string>',
            'StandardsArn' => '<string>',
            'StandardsControlArns' => ['<string>', ...],
            'StandardsControlDescription' => '<string>',
            'StandardsControlTitle' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedReason' => '<string>',
        ],
        // ...
    ],
    'UnprocessedAssociations' => [
        [
            'ErrorCode' => 'INVALID_INPUT|ACCESS_DENIED|NOT_FOUND|LIMIT_EXCEEDED',
            'ErrorReason' => '<string>',
            'StandardsControlAssociationId' => [
                'SecurityControlId' => '<string>',
                'StandardsArn' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
StandardsControlAssociationDetails
Required: Yes
Type: Array of StandardsControlAssociationDetail structures

Provides the enablement status of a security control in a specified standard and other details for the control in relation to the specified standard.

UnprocessedAssociations
Type: Array of UnprocessedStandardsControlAssociation structures

A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement status in a specified standard cannot be returned.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

Examples

Example 1: To get enablement status of a batch of controls

The following example retrieves the enablement status of the specified controls in the specified standards.

$result = $client->batchGetStandardsControlAssociations([
    'StandardsControlAssociationIds' => [
        [
            'SecurityControlId' => 'CloudTrail.1',
            'StandardsArn' => 'arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
        ],
        [
            'SecurityControlId' => 'CloudWatch.12',
            'StandardsArn' => 'arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
        ],
    ],
]);

Result syntax:

[
    'StandardsControlAssociationDetails' => [
        [
            'AssociationStatus' => 'ENABLED',
            'RelatedRequirements' => [
                'CIS AWS Foundations 2.1',
            ],
            'SecurityControlArn' => 'arn:aws:securityhub:us-west-2:110479873537:security-control/CloudTrail.1',
            'SecurityControlId' => 'CloudTrail.1',
            'StandardsArn' => 'arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
            'StandardsControlDescription' => 'AWS CloudTrail is a web service that records AWS API calls for your account and delivers log files to you. The recorded information includes the identity of the API caller, the time of the API call, the source IP address of the API caller, the request parameters, and the response elements returned by the AWS service.',
            'StandardsControlTitle' => 'Ensure CloudTrail is enabled in all regions',
            'UpdatedAt' => ,
        ],
        [
            'AssociationStatus' => 'ENABLED',
            'RelatedRequirements' => [
                'CIS AWS Foundations 3.12',
            ],
            'SecurityControlArn' => 'arn:aws:securityhub:us-west-2:110479873537:security-control/CloudWatch.12',
            'SecurityControlId' => 'CloudWatch.12',
            'StandardsArn' => 'arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
            'StandardsControlDescription' => 'Real-time monitoring of API calls can be achieved by directing CloudTrail Logs to CloudWatch Logs and establishing corresponding metric filters and alarms. Network gateways are required to send/receive traffic to a destination outside of a VPC. It is recommended that a metric filter and alarm be established for changes to network gateways.',
            'StandardsControlTitle' => 'Ensure a log metric filter and alarm exist for changes to network gateways',
            'UpdatedAt' => ,
        ],
    ],
]

BatchImportFindings

$result = $client->batchImportFindings([/* ... */]);
$promise = $client->batchImportFindingsAsync([/* ... */]);

Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.

BatchImportFindings must be called by one of the following:

  • The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services 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 Amazon Web Services account that Security Hub 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 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.

Parameter Syntax

$result = $client->batchImportFindings([
    'Findings' => [ // REQUIRED
        [
            'Action' => [
                'ActionType' => '<string>',
                'AwsApiCallAction' => [
                    'AffectedResources' => ['<string>', ...],
                    'Api' => '<string>',
                    'CallerType' => '<string>',
                    'DomainDetails' => [
                        'Domain' => '<string>',
                    ],
                    'FirstSeen' => '<string>',
                    'LastSeen' => '<string>',
                    'RemoteIpDetails' => [
                        'City' => [
                            'CityName' => '<string>',
                        ],
                        'Country' => [
                            'CountryCode' => '<string>',
                            'CountryName' => '<string>',
                        ],
                        'GeoLocation' => [
                            'Lat' => <float>,
                            'Lon' => <float>,
                        ],
                        'IpAddressV4' => '<string>',
                        'Organization' => [
                            'Asn' => <integer>,
                            'AsnOrg' => '<string>',
                            'Isp' => '<string>',
                            'Org' => '<string>',
                        ],
                    ],
                    'ServiceName' => '<string>',
                ],
                'DnsRequestAction' => [
                    'Blocked' => true || false,
                    'Domain' => '<string>',
                    'Protocol' => '<string>',
                ],
                'NetworkConnectionAction' => [
                    'Blocked' => true || false,
                    'ConnectionDirection' => '<string>',
                    'LocalPortDetails' => [
                        'Port' => <integer>,
                        'PortName' => '<string>',
                    ],
                    'Protocol' => '<string>',
                    'RemoteIpDetails' => [
                        'City' => [
                            'CityName' => '<string>',
                        ],
                        'Country' => [
                            'CountryCode' => '<string>',
                            'CountryName' => '<string>',
                        ],
                        'GeoLocation' => [
                            'Lat' => <float>,
                            'Lon' => <float>,
                        ],
                        'IpAddressV4' => '<string>',
                        'Organization' => [
                            'Asn' => <integer>,
                            'AsnOrg' => '<string>',
                            'Isp' => '<string>',
                            'Org' => '<string>',
                        ],
                    ],
                    'RemotePortDetails' => [
                        'Port' => <integer>,
                        'PortName' => '<string>',
                    ],
                ],
                'PortProbeAction' => [
                    'Blocked' => true || false,
                    'PortProbeDetails' => [
                        [
                            'LocalIpDetails' => [
                                'IpAddressV4' => '<string>',
                            ],
                            'LocalPortDetails' => [
                                'Port' => <integer>,
                                'PortName' => '<string>',
                            ],
                            'RemoteIpDetails' => [
                                'City' => [
                                    'CityName' => '<string>',
                                ],
                                'Country' => [
                                    'CountryCode' => '<string>',
                                    'CountryName' => '<string>',
                                ],
                                'GeoLocation' => [
                                    'Lat' => <float>,
                                    'Lon' => <float>,
                                ],
                                'IpAddressV4' => '<string>',
                                'Organization' => [
                                    'Asn' => <integer>,
                                    'AsnOrg' => '<string>',
                                    'Isp' => '<string>',
                                    'Org' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'AwsAccountId' => '<string>', // REQUIRED
            'AwsAccountName' => '<string>',
            'CompanyName' => '<string>',
            'Compliance' => [
                'AssociatedStandards' => [
                    [
                        'StandardsId' => '<string>',
                    ],
                    // ...
                ],
                'RelatedRequirements' => ['<string>', ...],
                'SecurityControlId' => '<string>',
                'SecurityControlParameters' => [
                    [
                        'Name' => '<string>',
                        'Value' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Status' => 'PASSED|WARNING|FAILED|NOT_AVAILABLE',
                'StatusReasons' => [
                    [
                        'Description' => '<string>',
                        'ReasonCode' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Confidence' => <integer>,
            'CreatedAt' => '<string>', // REQUIRED
            'Criticality' => <integer>,
            'Description' => '<string>', // REQUIRED
            'FindingProviderFields' => [
                'Confidence' => <integer>,
                'Criticality' => <integer>,
                'RelatedFindings' => [
                    [
                        'Id' => '<string>', // REQUIRED
                        'ProductArn' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'Severity' => [
                    'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
                    'Original' => '<string>',
                ],
                'Types' => ['<string>', ...],
            ],
            'FirstObservedAt' => '<string>',
            'GeneratorDetails' => [
                'Description' => '<string>',
                'Labels' => ['<string>', ...],
                'Name' => '<string>',
            ],
            'GeneratorId' => '<string>', // REQUIRED
            'Id' => '<string>', // REQUIRED
            'LastObservedAt' => '<string>',
            'Malware' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Path' => '<string>',
                    'State' => 'OBSERVED|REMOVAL_FAILED|REMOVED',
                    'Type' => 'ADWARE|BLENDED_THREAT|BOTNET_AGENT|COIN_MINER|EXPLOIT_KIT|KEYLOGGER|MACRO|POTENTIALLY_UNWANTED|SPYWARE|RANSOMWARE|REMOTE_ACCESS|ROOTKIT|TROJAN|VIRUS|WORM',
                ],
                // ...
            ],
            'Network' => [
                'DestinationDomain' => '<string>',
                'DestinationIpV4' => '<string>',
                'DestinationIpV6' => '<string>',
                'DestinationPort' => <integer>,
                'Direction' => 'IN|OUT',
                'OpenPortRange' => [
                    'Begin' => <integer>,
                    'End' => <integer>,
                ],
                'Protocol' => '<string>',
                'SourceDomain' => '<string>',
                'SourceIpV4' => '<string>',
                'SourceIpV6' => '<string>',
                'SourceMac' => '<string>',
                'SourcePort' => <integer>,
            ],
            'NetworkPath' => [
                [
                    'ComponentId' => '<string>',
                    'ComponentType' => '<string>',
                    'Egress' => [
                        'Destination' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'Protocol' => '<string>',
                        'Source' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Ingress' => [
                        'Destination' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'Protocol' => '<string>',
                        'Source' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'Note' => [
                'Text' => '<string>', // REQUIRED
                'UpdatedAt' => '<string>', // REQUIRED
                'UpdatedBy' => '<string>', // REQUIRED
            ],
            'PatchSummary' => [
                'FailedCount' => <integer>,
                'Id' => '<string>', // REQUIRED
                'InstalledCount' => <integer>,
                'InstalledOtherCount' => <integer>,
                'InstalledPendingReboot' => <integer>,
                'InstalledRejectedCount' => <integer>,
                'MissingCount' => <integer>,
                'Operation' => '<string>',
                'OperationEndTime' => '<string>',
                'OperationStartTime' => '<string>',
                'RebootOption' => '<string>',
            ],
            'Process' => [
                'LaunchedAt' => '<string>',
                'Name' => '<string>',
                'ParentPid' => <integer>,
                'Path' => '<string>',
                'Pid' => <integer>,
                'TerminatedAt' => '<string>',
            ],
            'ProcessedAt' => '<string>',
            'ProductArn' => '<string>', // REQUIRED
            'ProductFields' => ['<string>', ...],
            'ProductName' => '<string>',
            'RecordState' => 'ACTIVE|ARCHIVED',
            'Region' => '<string>',
            'RelatedFindings' => [
                [
                    'Id' => '<string>', // REQUIRED
                    'ProductArn' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Remediation' => [
                'Recommendation' => [
                    'Text' => '<string>',
                    'Url' => '<string>',
                ],
            ],
            'Resources' => [ // REQUIRED
                [
                    'ApplicationArn' => '<string>',
                    'ApplicationName' => '<string>',
                    'DataClassification' => [
                        'DetailedResultsLocation' => '<string>',
                        'Result' => [
                            'AdditionalOccurrences' => true || false,
                            'CustomDataIdentifiers' => [
                                'Detections' => [
                                    [
                                        'Arn' => '<string>',
                                        'Count' => <integer>,
                                        'Name' => '<string>',
                                        'Occurrences' => [
                                            'Cells' => [
                                                [
                                                    'CellReference' => '<string>',
                                                    'Column' => <integer>,
                                                    'ColumnName' => '<string>',
                                                    'Row' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'LineRanges' => [
                                                [
                                                    'End' => <integer>,
                                                    'Start' => <integer>,
                                                    'StartColumn' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'OffsetRanges' => [
                                                [
                                                    'End' => <integer>,
                                                    'Start' => <integer>,
                                                    'StartColumn' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'Pages' => [
                                                [
                                                    'LineRange' => [
                                                        'End' => <integer>,
                                                        'Start' => <integer>,
                                                        'StartColumn' => <integer>,
                                                    ],
                                                    'OffsetRange' => [
                                                        'End' => <integer>,
                                                        'Start' => <integer>,
                                                        'StartColumn' => <integer>,
                                                    ],
                                                    'PageNumber' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'Records' => [
                                                [
                                                    'JsonPath' => '<string>',
                                                    'RecordIndex' => <integer>,
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    // ...
                                ],
                                'TotalCount' => <integer>,
                            ],
                            'MimeType' => '<string>',
                            'SensitiveData' => [
                                [
                                    'Category' => '<string>',
                                    'Detections' => [
                                        [
                                            'Count' => <integer>,
                                            'Occurrences' => [
                                                'Cells' => [
                                                    [
                                                        'CellReference' => '<string>',
                                                        'Column' => <integer>,
                                                        'ColumnName' => '<string>',
                                                        'Row' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                                'LineRanges' => [
                                                    [
                                                        'End' => <integer>,
                                                        'Start' => <integer>,
                                                        'StartColumn' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                                'OffsetRanges' => [
                                                    [
                                                        'End' => <integer>,
                                                        'Start' => <integer>,
                                                        'StartColumn' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                                'Pages' => [
                                                    [
                                                        'LineRange' => [
                                                            'End' => <integer>,
                                                            'Start' => <integer>,
                                                            'StartColumn' => <integer>,
                                                        ],
                                                        'OffsetRange' => [
                                                            'End' => <integer>,
                                                            'Start' => <integer>,
                                                            'StartColumn' => <integer>,
                                                        ],
                                                        'PageNumber' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                                'Records' => [
                                                    [
                                                        'JsonPath' => '<string>',
                                                        'RecordIndex' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                            'Type' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'TotalCount' => <integer>,
                                ],
                                // ...
                            ],
                            'SizeClassified' => <integer>,
                            'Status' => [
                                'Code' => '<string>',
                                'Reason' => '<string>',
                            ],
                        ],
                    ],
                    'Details' => [
                        'AwsAmazonMqBroker' => [
                            'AuthenticationStrategy' => '<string>',
                            'AutoMinorVersionUpgrade' => true || false,
                            'BrokerArn' => '<string>',
                            'BrokerId' => '<string>',
                            'BrokerName' => '<string>',
                            'DeploymentMode' => '<string>',
                            'EncryptionOptions' => [
                                'KmsKeyId' => '<string>',
                                'UseAwsOwnedKey' => true || false,
                            ],
                            'EngineType' => '<string>',
                            'EngineVersion' => '<string>',
                            'HostInstanceType' => '<string>',
                            'LdapServerMetadata' => [
                                'Hosts' => ['<string>', ...],
                                'RoleBase' => '<string>',
                                'RoleName' => '<string>',
                                'RoleSearchMatching' => '<string>',
                                'RoleSearchSubtree' => true || false,
                                'ServiceAccountUsername' => '<string>',
                                'UserBase' => '<string>',
                                'UserRoleName' => '<string>',
                                'UserSearchMatching' => '<string>',
                                'UserSearchSubtree' => true || false,
                            ],
                            'Logs' => [
                                'Audit' => true || false,
                                'AuditLogGroup' => '<string>',
                                'General' => true || false,
                                'GeneralLogGroup' => '<string>',
                                'Pending' => [
                                    'Audit' => true || false,
                                    'General' => true || false,
                                ],
                            ],
                            'MaintenanceWindowStartTime' => [
                                'DayOfWeek' => '<string>',
                                'TimeOfDay' => '<string>',
                                'TimeZone' => '<string>',
                            ],
                            'PubliclyAccessible' => true || false,
                            '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' => <integer>,
                            'Name' => '<string>',
                            'Version' => '<string>',
                        ],
                        'AwsApiGatewayStage' => [
                            'AccessLogSettings' => [
                                'DestinationArn' => '<string>',
                                'Format' => '<string>',
                            ],
                            'CacheClusterEnabled' => true || false,
                            'CacheClusterSize' => '<string>',
                            'CacheClusterStatus' => '<string>',
                            'CanarySettings' => [
                                'DeploymentId' => '<string>',
                                'PercentTraffic' => <float>,
                                'StageVariableOverrides' => ['<string>', ...],
                                'UseStageCache' => true || false,
                            ],
                            'ClientCertificateId' => '<string>',
                            'CreatedDate' => '<string>',
                            'DeploymentId' => '<string>',
                            'Description' => '<string>',
                            'DocumentationVersion' => '<string>',
                            'LastUpdatedDate' => '<string>',
                            'MethodSettings' => [
                                [
                                    'CacheDataEncrypted' => true || false,
                                    'CacheTtlInSeconds' => <integer>,
                                    'CachingEnabled' => true || false,
                                    'DataTraceEnabled' => true || false,
                                    'HttpMethod' => '<string>',
                                    'LoggingLevel' => '<string>',
                                    'MetricsEnabled' => true || false,
                                    'RequireAuthorizationForCacheControl' => true || false,
                                    'ResourcePath' => '<string>',
                                    'ThrottlingBurstLimit' => <integer>,
                                    'ThrottlingRateLimit' => <float>,
                                    'UnauthorizedCacheControlHeaderStrategy' => '<string>',
                                ],
                                // ...
                            ],
                            'StageName' => '<string>',
                            'TracingEnabled' => true || false,
                            'Variables' => ['<string>', ...],
                            'WebAclArn' => '<string>',
                        ],
                        'AwsApiGatewayV2Api' => [
                            'ApiEndpoint' => '<string>',
                            'ApiId' => '<string>',
                            'ApiKeySelectionExpression' => '<string>',
                            'CorsConfiguration' => [
                                'AllowCredentials' => true || false,
                                'AllowHeaders' => ['<string>', ...],
                                'AllowMethods' => ['<string>', ...],
                                'AllowOrigins' => ['<string>', ...],
                                'ExposeHeaders' => ['<string>', ...],
                                'MaxAge' => <integer>,
                            ],
                            'CreatedDate' => '<string>',
                            'Description' => '<string>',
                            'Name' => '<string>',
                            'ProtocolType' => '<string>',
                            'RouteSelectionExpression' => '<string>',
                            'Version' => '<string>',
                        ],
                        'AwsApiGatewayV2Stage' => [
                            'AccessLogSettings' => [
                                'DestinationArn' => '<string>',
                                'Format' => '<string>',
                            ],
                            'ApiGatewayManaged' => true || false,
                            'AutoDeploy' => true || false,
                            'ClientCertificateId' => '<string>',
                            'CreatedDate' => '<string>',
                            'DefaultRouteSettings' => [
                                'DataTraceEnabled' => true || false,
                                'DetailedMetricsEnabled' => true || false,
                                'LoggingLevel' => '<string>',
                                'ThrottlingBurstLimit' => <integer>,
                                'ThrottlingRateLimit' => <float>,
                            ],
                            'DeploymentId' => '<string>',
                            'Description' => '<string>',
                            'LastDeploymentStatusMessage' => '<string>',
                            'LastUpdatedDate' => '<string>',
                            'RouteSettings' => [
                                'DataTraceEnabled' => true || false,
                                'DetailedMetricsEnabled' => true || false,
                                'LoggingLevel' => '<string>',
                                'ThrottlingBurstLimit' => <integer>,
                                'ThrottlingRateLimit' => <float>,
                            ],
                            'StageName' => '<string>',
                            'StageVariables' => ['<string>', ...],
                        ],
                        'AwsAppSyncGraphQlApi' => [
                            'AdditionalAuthenticationProviders' => [
                                [
                                    'AuthenticationType' => '<string>',
                                    'LambdaAuthorizerConfig' => [
                                        'AuthorizerResultTtlInSeconds' => <integer>,
                                        'AuthorizerUri' => '<string>',
                                        'IdentityValidationExpression' => '<string>',
                                    ],
                                    'OpenIdConnectConfig' => [
                                        'AuthTtL' => <integer>,
                                        'ClientId' => '<string>',
                                        'IatTtL' => <integer>,
                                        'Issuer' => '<string>',
                                    ],
                                    'UserPoolConfig' => [
                                        'AppIdClientRegex' => '<string>',
                                        'AwsRegion' => '<string>',
                                        'DefaultAction' => '<string>',
                                        'UserPoolId' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'ApiId' => '<string>',
                            'Arn' => '<string>',
                            'AuthenticationType' => '<string>',
                            'Id' => '<string>',
                            'LambdaAuthorizerConfig' => [
                                'AuthorizerResultTtlInSeconds' => <integer>,
                                'AuthorizerUri' => '<string>',
                                'IdentityValidationExpression' => '<string>',
                            ],
                            'LogConfig' => [
                                'CloudWatchLogsRoleArn' => '<string>',
                                'ExcludeVerboseContent' => true || false,
                                'FieldLogLevel' => '<string>',
                            ],
                            'Name' => '<string>',
                            'OpenIdConnectConfig' => [
                                'AuthTtL' => <integer>,
                                'ClientId' => '<string>',
                                'IatTtL' => <integer>,
                                'Issuer' => '<string>',
                            ],
                            'UserPoolConfig' => [
                                'AppIdClientRegex' => '<string>',
                                'AwsRegion' => '<string>',
                                'DefaultAction' => '<string>',
                                'UserPoolId' => '<string>',
                            ],
                            'WafWebAclArn' => '<string>',
                            'XrayEnabled' => true || false,
                        ],
                        'AwsAthenaWorkGroup' => [
                            'Configuration' => [
                                'ResultConfiguration' => [
                                    'EncryptionConfiguration' => [
                                        'EncryptionOption' => '<string>',
                                        'KmsKey' => '<string>',
                                    ],
                                ],
                            ],
                            'Description' => '<string>',
                            'Name' => '<string>',
                            'State' => '<string>',
                        ],
                        'AwsAutoScalingAutoScalingGroup' => [
                            'AvailabilityZones' => [
                                [
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'CapacityRebalance' => true || false,
                            'CreatedTime' => '<string>',
                            'HealthCheckGracePeriod' => <integer>,
                            'HealthCheckType' => '<string>',
                            'LaunchConfigurationName' => '<string>',
                            'LaunchTemplate' => [
                                'LaunchTemplateId' => '<string>',
                                'LaunchTemplateName' => '<string>',
                                'Version' => '<string>',
                            ],
                            'LoadBalancerNames' => ['<string>', ...],
                            'MixedInstancesPolicy' => [
                                'InstancesDistribution' => [
                                    'OnDemandAllocationStrategy' => '<string>',
                                    'OnDemandBaseCapacity' => <integer>,
                                    'OnDemandPercentageAboveBaseCapacity' => <integer>,
                                    'SpotAllocationStrategy' => '<string>',
                                    'SpotInstancePools' => <integer>,
                                    'SpotMaxPrice' => '<string>',
                                ],
                                'LaunchTemplate' => [
                                    'LaunchTemplateSpecification' => [
                                        'LaunchTemplateId' => '<string>',
                                        'LaunchTemplateName' => '<string>',
                                        'Version' => '<string>',
                                    ],
                                    'Overrides' => [
                                        [
                                            'InstanceType' => '<string>',
                                            'WeightedCapacity' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                        ],
                        'AwsAutoScalingLaunchConfiguration' => [
                            'AssociatePublicIpAddress' => true || false,
                            'BlockDeviceMappings' => [
                                [
                                    'DeviceName' => '<string>',
                                    'Ebs' => [
                                        'DeleteOnTermination' => true || false,
                                        'Encrypted' => true || false,
                                        'Iops' => <integer>,
                                        'SnapshotId' => '<string>',
                                        'VolumeSize' => <integer>,
                                        'VolumeType' => '<string>',
                                    ],
                                    'NoDevice' => true || false,
                                    'VirtualName' => '<string>',
                                ],
                                // ...
                            ],
                            'ClassicLinkVpcId' => '<string>',
                            'ClassicLinkVpcSecurityGroups' => ['<string>', ...],
                            'CreatedTime' => '<string>',
                            'EbsOptimized' => true || false,
                            'IamInstanceProfile' => '<string>',
                            'ImageId' => '<string>',
                            'InstanceMonitoring' => [
                                'Enabled' => true || false,
                            ],
                            'InstanceType' => '<string>',
                            'KernelId' => '<string>',
                            'KeyName' => '<string>',
                            'LaunchConfigurationName' => '<string>',
                            'MetadataOptions' => [
                                'HttpEndpoint' => '<string>',
                                'HttpPutResponseHopLimit' => <integer>,
                                'HttpTokens' => '<string>',
                            ],
                            'PlacementTenancy' => '<string>',
                            'RamdiskId' => '<string>',
                            'SecurityGroups' => ['<string>', ...],
                            'SpotPrice' => '<string>',
                            'UserData' => '<string>',
                        ],
                        'AwsBackupBackupPlan' => [
                            'BackupPlan' => [
                                'AdvancedBackupSettings' => [
                                    [
                                        'BackupOptions' => ['<string>', ...],
                                        'ResourceType' => '<string>',
                                    ],
                                    // ...
                                ],
                                'BackupPlanName' => '<string>',
                                'BackupPlanRule' => [
                                    [
                                        'CompletionWindowMinutes' => <integer>,
                                        'CopyActions' => [
                                            [
                                                'DestinationBackupVaultArn' => '<string>',
                                                'Lifecycle' => [
                                                    'DeleteAfterDays' => <integer>,
                                                    'MoveToColdStorageAfterDays' => <integer>,
                                                ],
                                            ],
                                            // ...
                                        ],
                                        'EnableContinuousBackup' => true || false,
                                        'Lifecycle' => [
                                            'DeleteAfterDays' => <integer>,
                                            'MoveToColdStorageAfterDays' => <integer>,
                                        ],
                                        'RuleId' => '<string>',
                                        'RuleName' => '<string>',
                                        'ScheduleExpression' => '<string>',
                                        'StartWindowMinutes' => <integer>,
                                        'TargetBackupVault' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'BackupPlanArn' => '<string>',
                            'BackupPlanId' => '<string>',
                            'VersionId' => '<string>',
                        ],
                        'AwsBackupBackupVault' => [
                            'AccessPolicy' => '<string>',
                            'BackupVaultArn' => '<string>',
                            'BackupVaultName' => '<string>',
                            'EncryptionKeyArn' => '<string>',
                            'Notifications' => [
                                'BackupVaultEvents' => ['<string>', ...],
                                'SnsTopicArn' => '<string>',
                            ],
                        ],
                        'AwsBackupRecoveryPoint' => [
                            'BackupSizeInBytes' => <integer>,
                            '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' => true || false,
                            'LastRestoreTime' => '<string>',
                            'Lifecycle' => [
                                'DeleteAfterDays' => <integer>,
                                'MoveToColdStorageAfterDays' => <integer>,
                            ],
                            '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' => true || false,
                            'DriftInformation' => [
                                'StackDriftStatus' => '<string>',
                            ],
                            'EnableTerminationProtection' => true || false,
                            'LastUpdatedTime' => '<string>',
                            'NotificationArns' => ['<string>', ...],
                            'Outputs' => [
                                [
                                    'Description' => '<string>',
                                    'OutputKey' => '<string>',
                                    'OutputValue' => '<string>',
                                ],
                                // ...
                            ],
                            'RoleArn' => '<string>',
                            'StackId' => '<string>',
                            'StackName' => '<string>',
                            'StackStatus' => '<string>',
                            'StackStatusReason' => '<string>',
                            'TimeoutInMinutes' => <integer>,
                        ],
                        'AwsCloudFrontDistribution' => [
                            'CacheBehaviors' => [
                                'Items' => [
                                    [
                                        'ViewerProtocolPolicy' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'DefaultCacheBehavior' => [
                                'ViewerProtocolPolicy' => '<string>',
                            ],
                            'DefaultRootObject' => '<string>',
                            'DomainName' => '<string>',
                            'ETag' => '<string>',
                            'LastModifiedTime' => '<string>',
                            'Logging' => [
                                'Bucket' => '<string>',
                                'Enabled' => true || false,
                                'IncludeCookies' => true || false,
                                'Prefix' => '<string>',
                            ],
                            'OriginGroups' => [
                                'Items' => [
                                    [
                                        'FailoverCriteria' => [
                                            'StatusCodes' => [
                                                'Items' => [<integer>, ...],
                                                'Quantity' => <integer>,
                                            ],
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'Origins' => [
                                'Items' => [
                                    [
                                        'CustomOriginConfig' => [
                                            'HttpPort' => <integer>,
                                            'HttpsPort' => <integer>,
                                            'OriginKeepaliveTimeout' => <integer>,
                                            'OriginProtocolPolicy' => '<string>',
                                            'OriginReadTimeout' => <integer>,
                                            'OriginSslProtocols' => [
                                                'Items' => ['<string>', ...],
                                                'Quantity' => <integer>,
                                            ],
                                        ],
                                        'DomainName' => '<string>',
                                        'Id' => '<string>',
                                        'OriginPath' => '<string>',
                                        'S3OriginConfig' => [
                                            'OriginAccessIdentity' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'Status' => '<string>',
                            'ViewerCertificate' => [
                                'AcmCertificateArn' => '<string>',
                                'Certificate' => '<string>',
                                'CertificateSource' => '<string>',
                                'CloudFrontDefaultCertificate' => true || false,
                                'IamCertificateId' => '<string>',
                                'MinimumProtocolVersion' => '<string>',
                                'SslSupportMethod' => '<string>',
                            ],
                            'WebAclId' => '<string>',
                        ],
                        'AwsCloudTrailTrail' => [
                            'CloudWatchLogsLogGroupArn' => '<string>',
                            'CloudWatchLogsRoleArn' => '<string>',
                            'HasCustomEventSelectors' => true || false,
                            'HomeRegion' => '<string>',
                            'IncludeGlobalServiceEvents' => true || false,
                            'IsMultiRegionTrail' => true || false,
                            'IsOrganizationTrail' => true || false,
                            'KmsKeyId' => '<string>',
                            'LogFileValidationEnabled' => true || false,
                            'Name' => '<string>',
                            'S3BucketName' => '<string>',
                            'S3KeyPrefix' => '<string>',
                            'SnsTopicArn' => '<string>',
                            'SnsTopicName' => '<string>',
                            'TrailArn' => '<string>',
                        ],
                        'AwsCloudWatchAlarm' => [
                            'ActionsEnabled' => true || false,
                            'AlarmActions' => ['<string>', ...],
                            'AlarmArn' => '<string>',
                            'AlarmConfigurationUpdatedTimestamp' => '<string>',
                            'AlarmDescription' => '<string>',
                            'AlarmName' => '<string>',
                            'ComparisonOperator' => '<string>',
                            'DatapointsToAlarm' => <integer>,
                            'Dimensions' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'EvaluateLowSampleCountPercentile' => '<string>',
                            'EvaluationPeriods' => <integer>,
                            'ExtendedStatistic' => '<string>',
                            'InsufficientDataActions' => ['<string>', ...],
                            'MetricName' => '<string>',
                            'Namespace' => '<string>',
                            'OkActions' => ['<string>', ...],
                            'Period' => <integer>,
                            'Statistic' => '<string>',
                            'Threshold' => <float>,
                            'ThresholdMetricId' => '<string>',
                            'TreatMissingData' => '<string>',
                            'Unit' => '<string>',
                        ],
                        'AwsCodeBuildProject' => [
                            'Artifacts' => [
                                [
                                    'ArtifactIdentifier' => '<string>',
                                    'EncryptionDisabled' => true || false,
                                    'Location' => '<string>',
                                    'Name' => '<string>',
                                    'NamespaceType' => '<string>',
                                    'OverrideArtifactName' => true || false,
                                    'Packaging' => '<string>',
                                    'Path' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'EncryptionKey' => '<string>',
                            'Environment' => [
                                'Certificate' => '<string>',
                                'EnvironmentVariables' => [
                                    [
                                        'Name' => '<string>',
                                        'Type' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ImagePullCredentialsType' => '<string>',
                                'PrivilegedMode' => true || false,
                                'RegistryCredential' => [
                                    'Credential' => '<string>',
                                    'CredentialProvider' => '<string>',
                                ],
                                'Type' => '<string>',
                            ],
                            'LogsConfig' => [
                                'CloudWatchLogs' => [
                                    'GroupName' => '<string>',
                                    'Status' => '<string>',
                                    'StreamName' => '<string>',
                                ],
                                'S3Logs' => [
                                    'EncryptionDisabled' => true || false,
                                    'Location' => '<string>',
                                    'Status' => '<string>',
                                ],
                            ],
                            'Name' => '<string>',
                            'SecondaryArtifacts' => [
                                [
                                    'ArtifactIdentifier' => '<string>',
                                    'EncryptionDisabled' => true || false,
                                    'Location' => '<string>',
                                    'Name' => '<string>',
                                    'NamespaceType' => '<string>',
                                    'OverrideArtifactName' => true || false,
                                    'Packaging' => '<string>',
                                    'Path' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'ServiceRole' => '<string>',
                            'Source' => [
                                'GitCloneDepth' => <integer>,
                                'InsecureSsl' => true || false,
                                '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' => <integer>,
                            'ServerName' => '<string>',
                            'SslMode' => '<string>',
                            'Username' => '<string>',
                        ],
                        'AwsDmsReplicationInstance' => [
                            'AllocatedStorage' => <integer>,
                            'AutoMinorVersionUpgrade' => true || false,
                            'AvailabilityZone' => '<string>',
                            'EngineVersion' => '<string>',
                            'KmsKeyId' => '<string>',
                            'MultiAZ' => true || false,
                            'PreferredMaintenanceWindow' => '<string>',
                            'PubliclyAccessible' => true || false,
                            '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' => true || false,
                            'GlobalSecondaryIndexes' => [
                                [
                                    'Backfilling' => true || false,
                                    'IndexArn' => '<string>',
                                    'IndexName' => '<string>',
                                    'IndexSizeBytes' => <integer>,
                                    'IndexStatus' => '<string>',
                                    'ItemCount' => <integer>,
                                    'KeySchema' => [
                                        [
                                            'AttributeName' => '<string>',
                                            'KeyType' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Projection' => [
                                        'NonKeyAttributes' => ['<string>', ...],
                                        'ProjectionType' => '<string>',
                                    ],
                                    'ProvisionedThroughput' => [
                                        'LastDecreaseDateTime' => '<string>',
                                        'LastIncreaseDateTime' => '<string>',
                                        'NumberOfDecreasesToday' => <integer>,
                                        'ReadCapacityUnits' => <integer>,
                                        'WriteCapacityUnits' => <integer>,
                                    ],
                                ],
                                // ...
                            ],
                            'GlobalTableVersion' => '<string>',
                            'ItemCount' => <integer>,
                            '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' => <integer>,
                                'ReadCapacityUnits' => <integer>,
                                'WriteCapacityUnits' => <integer>,
                            ],
                            'Replicas' => [
                                [
                                    'GlobalSecondaryIndexes' => [
                                        [
                                            'IndexName' => '<string>',
                                            'ProvisionedThroughputOverride' => [
                                                'ReadCapacityUnits' => <integer>,
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'KmsMasterKeyId' => '<string>',
                                    'ProvisionedThroughputOverride' => [
                                        'ReadCapacityUnits' => <integer>,
                                    ],
                                    'RegionName' => '<string>',
                                    'ReplicaStatus' => '<string>',
                                    'ReplicaStatusDescription' => '<string>',
                                ],
                                // ...
                            ],
                            'RestoreSummary' => [
                                'RestoreDateTime' => '<string>',
                                'RestoreInProgress' => true || false,
                                'SourceBackupArn' => '<string>',
                                'SourceTableArn' => '<string>',
                            ],
                            'SseDescription' => [
                                'InaccessibleEncryptionDateTime' => '<string>',
                                'KmsMasterKeyArn' => '<string>',
                                'SseType' => '<string>',
                                'Status' => '<string>',
                            ],
                            'StreamSpecification' => [
                                'StreamEnabled' => true || false,
                                'StreamViewType' => '<string>',
                            ],
                            'TableId' => '<string>',
                            'TableName' => '<string>',
                            'TableSizeBytes' => <integer>,
                            'TableStatus' => '<string>',
                        ],
                        'AwsEc2ClientVpnEndpoint' => [
                            'AuthenticationOptions' => [
                                [
                                    'ActiveDirectory' => [
                                        'DirectoryId' => '<string>',
                                    ],
                                    'FederatedAuthentication' => [
                                        'SamlProviderArn' => '<string>',
                                        'SelfServiceSamlProviderArn' => '<string>',
                                    ],
                                    'MutualAuthentication' => [
                                        'ClientRootCertificateChain' => '<string>',
                                    ],
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'ClientCidrBlock' => '<string>',
                            'ClientConnectOptions' => [
                                'Enabled' => true || false,
                                'LambdaFunctionArn' => '<string>',
                                'Status' => [
                                    'Code' => '<string>',
                                    'Message' => '<string>',
                                ],
                            ],
                            'ClientLoginBannerOptions' => [
                                'BannerText' => '<string>',
                                'Enabled' => true || false,
                            ],
                            'ClientVpnEndpointId' => '<string>',
                            'ConnectionLogOptions' => [
                                'CloudwatchLogGroup' => '<string>',
                                'CloudwatchLogStream' => '<string>',
                                'Enabled' => true || false,
                            ],
                            'Description' => '<string>',
                            'DnsServer' => ['<string>', ...],
                            'SecurityGroupIdSet' => ['<string>', ...],
                            'SelfServicePortalUrl' => '<string>',
                            'ServerCertificateArn' => '<string>',
                            'SessionTimeoutHours' => <integer>,
                            'SplitTunnel' => true || false,
                            'TransportProtocol' => '<string>',
                            'VpcId' => '<string>',
                            'VpnPort' => <integer>,
                        ],
                        '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' => <integer>,
                                'HttpTokens' => '<string>',
                                'InstanceMetadataTags' => '<string>',
                            ],
                            'Monitoring' => [
                                'State' => '<string>',
                            ],
                            'NetworkInterfaces' => [
                                [
                                    'NetworkInterfaceId' => '<string>',
                                ],
                                // ...
                            ],
                            'SubnetId' => '<string>',
                            'Type' => '<string>',
                            'VirtualizationType' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2LaunchTemplate' => [
                            'DefaultVersionNumber' => <integer>,
                            'Id' => '<string>',
                            'LatestVersionNumber' => <integer>,
                            'LaunchTemplateData' => [
                                'BlockDeviceMappingSet' => [
                                    [
                                        'DeviceName' => '<string>',
                                        'Ebs' => [
                                            'DeleteOnTermination' => true || false,
                                            'Encrypted' => true || false,
                                            'Iops' => <integer>,
                                            'KmsKeyId' => '<string>',
                                            'SnapshotId' => '<string>',
                                            'Throughput' => <integer>,
                                            'VolumeSize' => <integer>,
                                            'VolumeType' => '<string>',
                                        ],
                                        'NoDevice' => '<string>',
                                        'VirtualName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'CapacityReservationSpecification' => [
                                    'CapacityReservationPreference' => '<string>',
                                    'CapacityReservationTarget' => [
                                        'CapacityReservationId' => '<string>',
                                        'CapacityReservationResourceGroupArn' => '<string>',
                                    ],
                                ],
                                'CpuOptions' => [
                                    'CoreCount' => <integer>,
                                    'ThreadsPerCore' => <integer>,
                                ],
                                'CreditSpecification' => [
                                    'CpuCredits' => '<string>',
                                ],
                                'DisableApiStop' => true || false,
                                'DisableApiTermination' => true || false,
                                'EbsOptimized' => true || false,
                                'ElasticGpuSpecificationSet' => [
                                    [
                                        'Type' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ElasticInferenceAcceleratorSet' => [
                                    [
                                        'Count' => <integer>,
                                        'Type' => '<string>',
                                    ],
                                    // ...
                                ],
                                'EnclaveOptions' => [
                                    'Enabled' => true || false,
                                ],
                                'HibernationOptions' => [
                                    'Configured' => true || false,
                                ],
                                'IamInstanceProfile' => [
                                    'Arn' => '<string>',
                                    'Name' => '<string>',
                                ],
                                'ImageId' => '<string>',
                                'InstanceInitiatedShutdownBehavior' => '<string>',
                                'InstanceMarketOptions' => [
                                    'MarketType' => '<string>',
                                    'SpotOptions' => [
                                        'BlockDurationMinutes' => <integer>,
                                        'InstanceInterruptionBehavior' => '<string>',
                                        'MaxPrice' => '<string>',
                                        'SpotInstanceType' => '<string>',
                                        'ValidUntil' => '<string>',
                                    ],
                                ],
                                'InstanceRequirements' => [
                                    'AcceleratorCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'AcceleratorManufacturers' => ['<string>', ...],
                                    'AcceleratorNames' => ['<string>', ...],
                                    'AcceleratorTotalMemoryMiB' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'AcceleratorTypes' => ['<string>', ...],
                                    'BareMetal' => '<string>',
                                    'BaselineEbsBandwidthMbps' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'BurstablePerformance' => '<string>',
                                    'CpuManufacturers' => ['<string>', ...],
                                    'ExcludedInstanceTypes' => ['<string>', ...],
                                    'InstanceGenerations' => ['<string>', ...],
                                    'LocalStorage' => '<string>',
                                    'LocalStorageTypes' => ['<string>', ...],
                                    'MemoryGiBPerVCpu' => [
                                        'Max' => <float>,
                                        'Min' => <float>,
                                    ],
                                    'MemoryMiB' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'NetworkInterfaceCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'OnDemandMaxPricePercentageOverLowestPrice' => <integer>,
                                    'RequireHibernateSupport' => true || false,
                                    'SpotMaxPricePercentageOverLowestPrice' => <integer>,
                                    'TotalLocalStorageGB' => [
                                        'Max' => <float>,
                                        'Min' => <float>,
                                    ],
                                    'VCpuCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                ],
                                'InstanceType' => '<string>',
                                'KernelId' => '<string>',
                                'KeyName' => '<string>',
                                'LicenseSet' => [
                                    [
                                        'LicenseConfigurationArn' => '<string>',
                                    ],
                                    // ...
                                ],
                                'MaintenanceOptions' => [
                                    'AutoRecovery' => '<string>',
                                ],
                                'MetadataOptions' => [
                                    'HttpEndpoint' => '<string>',
                                    'HttpProtocolIpv6' => '<string>',
                                    'HttpPutResponseHopLimit' => <integer>,
                                    'HttpTokens' => '<string>',
                                    'InstanceMetadataTags' => '<string>',
                                ],
                                'Monitoring' => [
                                    'Enabled' => true || false,
                                ],
                                'NetworkInterfaceSet' => [
                                    [
                                        'AssociateCarrierIpAddress' => true || false,
                                        'AssociatePublicIpAddress' => true || false,
                                        'DeleteOnTermination' => true || false,
                                        'Description' => '<string>',
                                        'DeviceIndex' => <integer>,
                                        'Groups' => ['<string>', ...],
                                        'InterfaceType' => '<string>',
                                        'Ipv4PrefixCount' => <integer>,
                                        'Ipv4Prefixes' => [
                                            [
                                                'Ipv4Prefix' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'Ipv6AddressCount' => <integer>,
                                        'Ipv6Addresses' => [
                                            [
                                                'Ipv6Address' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'Ipv6PrefixCount' => <integer>,
                                        'Ipv6Prefixes' => [
                                            [
                                                'Ipv6Prefix' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'NetworkCardIndex' => <integer>,
                                        'NetworkInterfaceId' => '<string>',
                                        'PrivateIpAddress' => '<string>',
                                        'PrivateIpAddresses' => [
                                            [
                                                'Primary' => true || false,
                                                'PrivateIpAddress' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'SecondaryPrivateIpAddressCount' => <integer>,
                                        'SubnetId' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Placement' => [
                                    'Affinity' => '<string>',
                                    'AvailabilityZone' => '<string>',
                                    'GroupName' => '<string>',
                                    'HostId' => '<string>',
                                    'HostResourceGroupArn' => '<string>',
                                    'PartitionNumber' => <integer>,
                                    'SpreadDomain' => '<string>',
                                    'Tenancy' => '<string>',
                                ],
                                'PrivateDnsNameOptions' => [
                                    'EnableResourceNameDnsAAAARecord' => true || false,
                                    'EnableResourceNameDnsARecord' => true || false,
                                    'HostnameType' => '<string>',
                                ],
                                'RamDiskId' => '<string>',
                                'SecurityGroupIdSet' => ['<string>', ...],
                                'SecurityGroupSet' => ['<string>', ...],
                                'UserData' => '<string>',
                            ],
                            'LaunchTemplateName' => '<string>',
                        ],
                        'AwsEc2NetworkAcl' => [
                            'Associations' => [
                                [
                                    'NetworkAclAssociationId' => '<string>',
                                    'NetworkAclId' => '<string>',
                                    'SubnetId' => '<string>',
                                ],
                                // ...
                            ],
                            'Entries' => [
                                [
                                    'CidrBlock' => '<string>',
                                    'Egress' => true || false,
                                    'IcmpTypeCode' => [
                                        'Code' => <integer>,
                                        'Type' => <integer>,
                                    ],
                                    'Ipv6CidrBlock' => '<string>',
                                    'PortRange' => [
                                        'From' => <integer>,
                                        'To' => <integer>,
                                    ],
                                    'Protocol' => '<string>',
                                    'RuleAction' => '<string>',
                                    'RuleNumber' => <integer>,
                                ],
                                // ...
                            ],
                            'IsDefault' => true || false,
                            'NetworkAclId' => '<string>',
                            'OwnerId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2NetworkInterface' => [
                            'Attachment' => [
                                'AttachTime' => '<string>',
                                'AttachmentId' => '<string>',
                                'DeleteOnTermination' => true || false,
                                'DeviceIndex' => <integer>,
                                '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' => true || false,
                        ],
                        'AwsEc2RouteTable' => [
                            'AssociationSet' => [
                                [
                                    'AssociationState' => [
                                        'State' => '<string>',
                                        'StatusMessage' => '<string>',
                                    ],
                                    'GatewayId' => '<string>',
                                    'Main' => true || false,
                                    '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' => <integer>,
                                    'IpProtocol' => '<string>',
                                    'IpRanges' => [
                                        [
                                            'CidrIp' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ipv6Ranges' => [
                                        [
                                            'CidrIpv6' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'PrefixListIds' => [
                                        [
                                            'PrefixListId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ToPort' => <integer>,
                                    'UserIdGroupPairs' => [
                                        [
                                            'GroupId' => '<string>',
                                            'GroupName' => '<string>',
                                            'PeeringStatus' => '<string>',
                                            'UserId' => '<string>',
                                            'VpcId' => '<string>',
                                            'VpcPeeringConnectionId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'IpPermissionsEgress' => [
                                [
                                    'FromPort' => <integer>,
                                    'IpProtocol' => '<string>',
                                    'IpRanges' => [
                                        [
                                            'CidrIp' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ipv6Ranges' => [
                                        [
                                            'CidrIpv6' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'PrefixListIds' => [
                                        [
                                            'PrefixListId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ToPort' => <integer>,
                                    'UserIdGroupPairs' => [
                                        [
                                            'GroupId' => '<string>',
                                            'GroupName' => '<string>',
                                            'PeeringStatus' => '<string>',
                                            'UserId' => '<string>',
                                            'VpcId' => '<string>',
                                            'VpcPeeringConnectionId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OwnerId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2Subnet' => [
                            'AssignIpv6AddressOnCreation' => true || false,
                            'AvailabilityZone' => '<string>',
                            'AvailabilityZoneId' => '<string>',
                            'AvailableIpAddressCount' => <integer>,
                            'CidrBlock' => '<string>',
                            'DefaultForAz' => true || false,
                            'Ipv6CidrBlockAssociationSet' => [
                                [
                                    'AssociationId' => '<string>',
                                    'CidrBlockState' => '<string>',
                                    'Ipv6CidrBlock' => '<string>',
                                ],
                                // ...
                            ],
                            'MapPublicIpOnLaunch' => true || false,
                            'OwnerId' => '<string>',
                            'State' => '<string>',
                            'SubnetArn' => '<string>',
                            'SubnetId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2TransitGateway' => [
                            'AmazonSideAsn' => <integer>,
                            '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' => true || false,
                                    'InstanceId' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateTime' => '<string>',
                            'DeviceName' => '<string>',
                            'Encrypted' => true || false,
                            'KmsKeyId' => '<string>',
                            'Size' => <integer>,
                            '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' => true || false,
                            'AvailabilityZones' => ['<string>', ...],
                            'BaseEndpointDnsNames' => ['<string>', ...],
                            'GatewayLoadBalancerArns' => ['<string>', ...],
                            'ManagesVpcEndpoints' => true || false,
                            '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' => true || false,
                                    'AllowEgressFromLocalClassicLinkToRemoteVpc' => true || false,
                                    'AllowEgressFromLocalVpcToRemoteClassicLink' => true || false,
                                ],
                                'Region' => '<string>',
                                'VpcId' => '<string>',
                            ],
                            'ExpirationTime' => '<string>',
                            'RequesterVpcInfo' => [
                                'CidrBlock' => '<string>',
                                'CidrBlockSet' => [
                                    [
                                        'CidrBlock' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Ipv6CidrBlockSet' => [
                                    [
                                        'Ipv6CidrBlock' => '<string>',
                                    ],
                                    // ...
                                ],
                                'OwnerId' => '<string>',
                                'PeeringOptions' => [
                                    'AllowDnsResolutionFromRemoteVpc' => true || false,
                                    'AllowEgressFromLocalClassicLinkToRemoteVpc' => true || false,
                                    'AllowEgressFromLocalVpcToRemoteClassicLink' => true || false,
                                ],
                                'Region' => '<string>',
                                'VpcId' => '<string>',
                            ],
                            'Status' => [
                                'Code' => '<string>',
                                'Message' => '<string>',
                            ],
                            'VpcPeeringConnectionId' => '<string>',
                        ],
                        'AwsEc2VpnConnection' => [
                            'Category' => '<string>',
                            'CustomerGatewayConfiguration' => '<string>',
                            'CustomerGatewayId' => '<string>',
                            'Options' => [
                                'StaticRoutesOnly' => true || false,
                                'TunnelOptions' => [
                                    [
                                        'DpdTimeoutSeconds' => <integer>,
                                        'IkeVersions' => ['<string>', ...],
                                        'OutsideIpAddress' => '<string>',
                                        'Phase1DhGroupNumbers' => [<integer>, ...],
                                        'Phase1EncryptionAlgorithms' => ['<string>', ...],
                                        'Phase1IntegrityAlgorithms' => ['<string>', ...],
                                        'Phase1LifetimeSeconds' => <integer>,
                                        'Phase2DhGroupNumbers' => [<integer>, ...],
                                        'Phase2EncryptionAlgorithms' => ['<string>', ...],
                                        'Phase2IntegrityAlgorithms' => ['<string>', ...],
                                        'Phase2LifetimeSeconds' => <integer>,
                                        'PreSharedKey' => '<string>',
                                        'RekeyFuzzPercentage' => <integer>,
                                        'RekeyMarginTimeSeconds' => <integer>,
                                        'ReplayWindowSize' => <integer>,
                                        'TunnelInsideCidr' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'Routes' => [
                                [
                                    'DestinationCidrBlock' => '<string>',
                                    'State' => '<string>',
                                ],
                                // ...
                            ],
                            'State' => '<string>',
                            'TransitGatewayId' => '<string>',
                            'Type' => '<string>',
                            'VgwTelemetry' => [
                                [
                                    'AcceptedRouteCount' => <integer>,
                                    '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' => true || false,
                            ],
                            'ImageTagMutability' => '<string>',
                            'LifecyclePolicy' => [
                                'LifecyclePolicyText' => '<string>',
                                'RegistryId' => '<string>',
                            ],
                            'RepositoryName' => '<string>',
                            'RepositoryPolicyText' => '<string>',
                        ],
                        'AwsEcsCluster' => [
                            'ActiveServicesCount' => <integer>,
                            'CapacityProviders' => ['<string>', ...],
                            'ClusterArn' => '<string>',
                            'ClusterName' => '<string>',
                            'ClusterSettings' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'Configuration' => [
                                'ExecuteCommandConfiguration' => [
                                    'KmsKeyId' => '<string>',
                                    'LogConfiguration' => [
                                        'CloudWatchEncryptionEnabled' => true || false,
                                        'CloudWatchLogGroupName' => '<string>',
                                        'S3BucketName' => '<string>',
                                        'S3EncryptionEnabled' => true || false,
                                        'S3KeyPrefix' => '<string>',
                                    ],
                                    'Logging' => '<string>',
                                ],
                            ],
                            'DefaultCapacityProviderStrategy' => [
                                [
                                    'Base' => <integer>,
                                    'CapacityProvider' => '<string>',
                                    'Weight' => <integer>,
                                ],
                                // ...
                            ],
                            'RegisteredContainerInstancesCount' => <integer>,
                            'RunningTasksCount' => <integer>,
                            'Status' => '<string>',
                        ],
                        'AwsEcsContainer' => [
                            'Image' => '<string>',
                            'MountPoints' => [
                                [
                                    'ContainerPath' => '<string>',
                                    'SourceVolume' => '<string>',
                                ],
                                // ...
                            ],
                            'Name' => '<string>',
                            'Privileged' => true || false,
                        ],
                        'AwsEcsService' => [
                            'CapacityProviderStrategy' => [
                                [
                                    'Base' => <integer>,
                                    'CapacityProvider' => '<string>',
                                    'Weight' => <integer>,
                                ],
                                // ...
                            ],
                            'Cluster' => '<string>',
                            'DeploymentConfiguration' => [
                                'DeploymentCircuitBreaker' => [
                                    'Enable' => true || false,
                                    'Rollback' => true || false,
                                ],
                                'MaximumPercent' => <integer>,
                                'MinimumHealthyPercent' => <integer>,
                            ],
                            'DeploymentController' => [
                                'Type' => '<string>',
                            ],
                            'DesiredCount' => <integer>,
                            'EnableEcsManagedTags' => true || false,
                            'EnableExecuteCommand' => true || false,
                            'HealthCheckGracePeriodSeconds' => <integer>,
                            'LaunchType' => '<string>',
                            'LoadBalancers' => [
                                [
                                    'ContainerName' => '<string>',
                                    'ContainerPort' => <integer>,
                                    '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' => <integer>,
                                    'Port' => <integer>,
                                    'RegistryArn' => '<string>',
                                ],
                                // ...
                            ],
                            'TaskDefinition' => '<string>',
                        ],
                        'AwsEcsTask' => [
                            'ClusterArn' => '<string>',
                            'Containers' => [
                                [
                                    'Image' => '<string>',
                                    'MountPoints' => [
                                        [
                                            'ContainerPath' => '<string>',
                                            'SourceVolume' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Name' => '<string>',
                                    'Privileged' => true || false,
                                ],
                                // ...
                            ],
                            'CreatedAt' => '<string>',
                            'Group' => '<string>',
                            'StartedAt' => '<string>',
                            'StartedBy' => '<string>',
                            'TaskDefinitionArn' => '<string>',
                            'Version' => '<string>',
                            'Volumes' => [
                                [
                                    'Host' => [
                                        'SourcePath' => '<string>',
                                    ],
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsEcsTaskDefinition' => [
                            'ContainerDefinitions' => [
                                [
                                    'Command' => ['<string>', ...],
                                    'Cpu' => <integer>,
                                    'DependsOn' => [
                                        [
                                            'Condition' => '<string>',
                                            'ContainerName' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'DisableNetworking' => true || false,
                                    'DnsSearchDomains' => ['<string>', ...],
                                    'DnsServers' => ['<string>', ...],
                                    'DockerLabels' => ['<string>', ...],
                                    'DockerSecurityOptions' => ['<string>', ...],
                                    'EntryPoint' => ['<string>', ...],
                                    'Environment' => [
                                        [
                                            'Name' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'EnvironmentFiles' => [
                                        [
                                            'Type' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Essential' => true || false,
                                    'ExtraHosts' => [
                                        [
                                            'Hostname' => '<string>',
                                            'IpAddress' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'FirelensConfiguration' => [
                                        'Options' => ['<string>', ...],
                                        'Type' => '<string>',
                                    ],
                                    'HealthCheck' => [
                                        'Command' => ['<string>', ...],
                                        'Interval' => <integer>,
                                        'Retries' => <integer>,
                                        'StartPeriod' => <integer>,
                                        'Timeout' => <integer>,
                                    ],
                                    'Hostname' => '<string>',
                                    'Image' => '<string>',
                                    'Interactive' => true || false,
                                    'Links' => ['<string>', ...],
                                    'LinuxParameters' => [
                                        'Capabilities' => [
                                            'Add' => ['<string>', ...],
                                            'Drop' => ['<string>', ...],
                                        ],
                                        'Devices' => [
                                            [
                                                'ContainerPath' => '<string>',
                                                'HostPath' => '<string>',
                                                'Permissions' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'InitProcessEnabled' => true || false,
                                        'MaxSwap' => <integer>,
                                        'SharedMemorySize' => <integer>,
                                        'Swappiness' => <integer>,
                                        'Tmpfs' => [
                                            [
                                                'ContainerPath' => '<string>',
                                                'MountOptions' => ['<string>', ...],
                                                'Size' => <integer>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'LogConfiguration' => [
                                        'LogDriver' => '<string>',
                                        'Options' => ['<string>', ...],
                                        'SecretOptions' => [
                                            [
                                                'Name' => '<string>',
                                                'ValueFrom' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'Memory' => <integer>,
                                    'MemoryReservation' => <integer>,
                                    'MountPoints' => [
                                        [
                                            'ContainerPath' => '<string>',
                                            'ReadOnly' => true || false,
                                            'SourceVolume' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Name' => '<string>',
                                    'PortMappings' => [
                                        [
                                            'ContainerPort' => <integer>,
                                            'HostPort' => <integer>,
                                            'Protocol' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Privileged' => true || false,
                                    'PseudoTerminal' => true || false,
                                    'ReadonlyRootFilesystem' => true || false,
                                    'RepositoryCredentials' => [
                                        'CredentialsParameter' => '<string>',
                                    ],
                                    'ResourceRequirements' => [
                                        [
                                            'Type' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Secrets' => [
                                        [
                                            'Name' => '<string>',
                                            'ValueFrom' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'StartTimeout' => <integer>,
                                    'StopTimeout' => <integer>,
                                    'SystemControls' => [
                                        [
                                            'Namespace' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ulimits' => [
                                        [
                                            'HardLimit' => <integer>,
                                            'Name' => '<string>',
                                            'SoftLimit' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'User' => '<string>',
                                    'VolumesFrom' => [
                                        [
                                            'ReadOnly' => true || false,
                                            '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' => true || false,
                                        'Driver' => '<string>',
                                        'DriverOpts' => ['<string>', ...],
                                        'Labels' => ['<string>', ...],
                                        'Scope' => '<string>',
                                    ],
                                    'EfsVolumeConfiguration' => [
                                        'AuthorizationConfig' => [
                                            'AccessPointId' => '<string>',
                                            'Iam' => '<string>',
                                        ],
                                        'FilesystemId' => '<string>',
                                        'RootDirectory' => '<string>',
                                        'TransitEncryption' => '<string>',
                                        'TransitEncryptionPort' => <integer>,
                                    ],
                                    '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' => true || false,
                                        'Types' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            'Name' => '<string>',
                            'ResourcesVpcConfig' => [
                                'EndpointPublicAccess' => true || false,
                                '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' => true || false,
                                'TLSSecurityPolicy' => '<string>',
                            ],
                            'DomainId' => '<string>',
                            'DomainName' => '<string>',
                            'ElasticsearchClusterConfig' => [
                                'DedicatedMasterCount' => <integer>,
                                'DedicatedMasterEnabled' => true || false,
                                'DedicatedMasterType' => '<string>',
                                'InstanceCount' => <integer>,
                                'InstanceType' => '<string>',
                                'ZoneAwarenessConfig' => [
                                    'AvailabilityZoneCount' => <integer>,
                                ],
                                'ZoneAwarenessEnabled' => true || false,
                            ],
                            'ElasticsearchVersion' => '<string>',
                            'EncryptionAtRestOptions' => [
                                'Enabled' => true || false,
                                'KmsKeyId' => '<string>',
                            ],
                            'Endpoint' => '<string>',
                            'Endpoints' => ['<string>', ...],
                            'LogPublishingOptions' => [
                                'AuditLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                                'IndexSlowLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                                'SearchSlowLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                            ],
                            'NodeToNodeEncryptionOptions' => [
                                'Enabled' => true || false,
                            ],
                            'ServiceSoftwareOptions' => [
                                'AutomatedUpdateDate' => '<string>',
                                'Cancellable' => true || false,
                                'CurrentVersion' => '<string>',
                                'Description' => '<string>',
                                'NewVersion' => '<string>',
                                'UpdateAvailable' => true || false,
                                'UpdateStatus' => '<string>',
                            ],
                            'VPCOptions' => [
                                'AvailabilityZones' => ['<string>', ...],
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                                'VPCId' => '<string>',
                            ],
                        ],
                        'AwsElbLoadBalancer' => [
                            'AvailabilityZones' => ['<string>', ...],
                            'BackendServerDescriptions' => [
                                [
                                    'InstancePort' => <integer>,
                                    'PolicyNames' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'CanonicalHostedZoneName' => '<string>',
                            'CanonicalHostedZoneNameID' => '<string>',
                            'CreatedTime' => '<string>',
                            'DnsName' => '<string>',
                            'HealthCheck' => [
                                'HealthyThreshold' => <integer>,
                                'Interval' => <integer>,
                                'Target' => '<string>',
                                'Timeout' => <integer>,
                                'UnhealthyThreshold' => <integer>,
                            ],
                            'Instances' => [
                                [
                                    'InstanceId' => '<string>',
                                ],
                                // ...
                            ],
                            'ListenerDescriptions' => [
                                [
                                    'Listener' => [
                                        'InstancePort' => <integer>,
                                        'InstanceProtocol' => '<string>',
                                        'LoadBalancerPort' => <integer>,
                                        'Protocol' => '<string>',
                                        'SslCertificateId' => '<string>',
                                    ],
                                    'PolicyNames' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'LoadBalancerAttributes' => [
                                'AccessLog' => [
                                    'EmitInterval' => <integer>,
                                    'Enabled' => true || false,
                                    'S3BucketName' => '<string>',
                                    'S3BucketPrefix' => '<string>',
                                ],
                                'AdditionalAttributes' => [
                                    [
                                        'Key' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ConnectionDraining' => [
                                    'Enabled' => true || false,
                                    'Timeout' => <integer>,
                                ],
                                'ConnectionSettings' => [
                                    'IdleTimeout' => <integer>,
                                ],
                                'CrossZoneLoadBalancing' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'LoadBalancerName' => '<string>',
                            'Policies' => [
                                'AppCookieStickinessPolicies' => [
                                    [
                                        'CookieName' => '<string>',
                                        'PolicyName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'LbCookieStickinessPolicies' => [
                                    [
                                        'CookieExpirationPeriod' => <integer>,
                                        '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' => true || false,
                                ],
                                'SessionIssuer' => [
                                    'AccountId' => '<string>',
                                    'Arn' => '<string>',
                                    'PrincipalId' => '<string>',
                                    'Type' => '<string>',
                                    'UserName' => '<string>',
                                ],
                            ],
                            'Status' => 'Active|Inactive',
                            'UserName' => '<string>',
                        ],
                        'AwsIamGroup' => [
                            'AttachedManagedPolicies' => [
                                [
                                    'PolicyArn' => '<string>',
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateDate' => '<string>',
                            'GroupId' => '<string>',
                            'GroupName' => '<string>',
                            'GroupPolicyList' => [
                                [
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'Path' => '<string>',
                        ],
                        'AwsIamPolicy' => [
                            'AttachmentCount' => <integer>,
                            'CreateDate' => '<string>',
                            'DefaultVersionId' => '<string>',
                            'Description' => '<string>',
                            'IsAttachable' => true || false,
                            'Path' => '<string>',
                            'PermissionsBoundaryUsageCount' => <integer>,
                            'PolicyId' => '<string>',
                            'PolicyName' => '<string>',
                            'PolicyVersionList' => [
                                [
                                    'CreateDate' => '<string>',
                                    'IsDefaultVersion' => true || false,
                                    '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' => <integer>,
                            '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' => <integer>,
                            'ShardCount' => <integer>,
                            'StreamEncryption' => [
                                'EncryptionType' => '<string>',
                                'KeyId' => '<string>',
                            ],
                        ],
                        'AwsKmsKey' => [
                            'AWSAccountId' => '<string>',
                            'CreationDate' => <float>,
                            'Description' => '<string>',
                            'KeyId' => '<string>',
                            'KeyManager' => '<string>',
                            'KeyRotationStatus' => true || false,
                            '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>', ...],
                            ],
                            'FunctionName' => '<string>',
                            'Handler' => '<string>',
                            'KmsKeyArn' => '<string>',
                            'LastModified' => '<string>',
                            'Layers' => [
                                [
                                    'Arn' => '<string>',
                                    'CodeSize' => <integer>,
                                ],
                                // ...
                            ],
                            'MasterArn' => '<string>',
                            'MemorySize' => <integer>,
                            'PackageType' => '<string>',
                            'RevisionId' => '<string>',
                            'Role' => '<string>',
                            'Runtime' => '<string>',
                            'Timeout' => <integer>,
                            'TracingConfig' => [
                                'Mode' => '<string>',
                            ],
                            'Version' => '<string>',
                            'VpcConfig' => [
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                                'VpcId' => '<string>',
                            ],
                        ],
                        'AwsLambdaLayerVersion' => [
                            'CompatibleRuntimes' => ['<string>', ...],
                            'CreatedDate' => '<string>',
                            'Version' => <integer>,
                        ],
                        'AwsMskCluster' => [
                            'ClusterInfo' => [
                                'ClientAuthentication' => [
                                    'Sasl' => [
                                        'Iam' => [
                                            'Enabled' => true || false,
                                        ],
                                        'Scram' => [
                                            'Enabled' => true || false,
                                        ],
                                    ],
                                    'Tls' => [
                                        'CertificateAuthorityArnList' => ['<string>', ...],
                                        'Enabled' => true || false,
                                    ],
                                    'Unauthenticated' => [
                                        'Enabled' => true || false,
                                    ],
                                ],
                                'ClusterName' => '<string>',
                                'CurrentVersion' => '<string>',
                                'EncryptionInfo' => [
                                    'EncryptionAtRest' => [
                                        'DataVolumeKMSKeyId' => '<string>',
                                    ],
                                    'EncryptionInTransit' => [
                                        'ClientBroker' => '<string>',
                                        'InCluster' => true || false,
                                    ],
                                ],
                                'EnhancedMonitoring' => '<string>',
                                'NumberOfBrokerNodes' => <integer>,
                            ],
                        ],
                        'AwsNetworkFirewallFirewall' => [
                            'DeleteProtection' => true || false,
                            'Description' => '<string>',
                            'FirewallArn' => '<string>',
                            'FirewallId' => '<string>',
                            'FirewallName' => '<string>',
                            'FirewallPolicyArn' => '<string>',
                            'FirewallPolicyChangeProtection' => true || false,
                            'SubnetChangeProtection' => true || false,
                            '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' => <integer>,
                                        'ResourceArn' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'FirewallPolicyArn' => '<string>',
                            'FirewallPolicyId' => '<string>',
                            'FirewallPolicyName' => '<string>',
                        ],
                        'AwsNetworkFirewallRuleGroup' => [
                            'Capacity' => <integer>,
                            'Description' => '<string>',
                            'RuleGroup' => [
                                'RuleVariables' => [
                                    'IpSets' => [
                                        'Definition' => ['<string>', ...],
                                    ],
                                    'PortSets' => [
                                        'Definition' => ['<string>', ...],
                                    ],
                                ],
                                'RulesSource' => [
                                    'RulesSourceList' => [
                                        'GeneratedRulesType' => '<string>',
                                        'TargetTypes' => ['<string>', ...],
                                        'Targets' => ['<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' => <integer>,
                                                'RuleDefinition' => [
                                                    'Actions' => ['<string>', ...],
                                                    'MatchAttributes' => [
                                                        'DestinationPorts' => [
                                                            [
                                                                'FromPort' => <integer>,
                                                                'ToPort' => <integer>,
                                                            ],
                                                            // ...
                                                        ],
                                                        'Destinations' => [
                                                            [
                                                                'AddressDefinition' => '<string>',
                                                            ],
                                                            // ...
                                                        ],
                                                        'Protocols' => [<integer>, ...],
                                                        'SourcePorts' => [
                                                            [
                                                                'FromPort' => <integer>,
                                                                'ToPort' => <integer>,
                                                            ],
                                                            // ...
                                                        ],
                                                        'Sources' => [
                                                            [
                                                                'AddressDefinition' => '<string>',
                                                            ],
                                                            // ...
                                                        ],
                                                        'TcpFlags' => [
                                                            [
                                                                'Flags' => ['<string>', ...],
                                                                'Masks' => ['<string>', ...],
                                                            ],
                                                            // ...
                                                        ],
                                                    ],
                                                ],
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                            ],
                            'RuleGroupArn' => '<string>',
                            'RuleGroupId' => '<string>',
                            'RuleGroupName' => '<string>',
                            'Type' => '<string>',
                        ],
                        'AwsOpenSearchServiceDomain' => [
                            'AccessPolicies' => '<string>',
                            'AdvancedSecurityOptions' => [
                                'Enabled' => true || false,
                                'InternalUserDatabaseEnabled' => true || false,
                                'MasterUserOptions' => [
                                    'MasterUserArn' => '<string>',
                                    'MasterUserName' => '<string>',
                                    'MasterUserPassword' => '<string>',
                                ],
                            ],
                            'Arn' => '<string>',
                            'ClusterConfig' => [
                                'DedicatedMasterCount' => <integer>,
                                'DedicatedMasterEnabled' => true || false,
                                'DedicatedMasterType' => '<string>',
                                'InstanceCount' => <integer>,
                                'InstanceType' => '<string>',
                                'WarmCount' => <integer>,
                                'WarmEnabled' => true || false,
                                'WarmType' => '<string>',
                                'ZoneAwarenessConfig' => [
                                    'AvailabilityZoneCount' => <integer>,
                                ],
                                'ZoneAwarenessEnabled' => true || false,
                            ],
                            'DomainEndpoint' => '<string>',
                            'DomainEndpointOptions' => [
                                'CustomEndpoint' => '<string>',
                                'CustomEndpointCertificateArn' => '<string>',
                                'CustomEndpointEnabled' => true || false,
                                'EnforceHTTPS' => true || false,
                                'TLSSecurityPolicy' => '<string>',
                            ],
                            'DomainEndpoints' => ['<string>', ...],
                            'DomainName' => '<string>',
                            'EncryptionAtRestOptions' => [
                                'Enabled' => true || false,
                                'KmsKeyId' => '<string>',
                            ],
                            'EngineVersion' => '<string>',
                            'Id' => '<string>',
                            'LogPublishingOptions' => [
                                'AuditLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                                'IndexSlowLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                                'SearchSlowLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                            ],
                            'NodeToNodeEncryptionOptions' => [
                                'Enabled' => true || false,
                            ],
                            'ServiceSoftwareOptions' => [
                                'AutomatedUpdateDate' => '<string>',
                                'Cancellable' => true || false,
                                'CurrentVersion' => '<string>',
                                'Description' => '<string>',
                                'NewVersion' => '<string>',
                                'OptionalDeployment' => true || false,
                                'UpdateAvailable' => true || false,
                                'UpdateStatus' => '<string>',
                            ],
                            'VpcOptions' => [
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                            ],
                        ],
                        'AwsRdsDbCluster' => [
                            'ActivityStreamStatus' => '<string>',
                            'AllocatedStorage' => <integer>,
                            'AssociatedRoles' => [
                                [
                                    'RoleArn' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'AutoMinorVersionUpgrade' => true || false,
                            'AvailabilityZones' => ['<string>', ...],
                            'BackupRetentionPeriod' => <integer>,
                            'ClusterCreateTime' => '<string>',
                            'CopyTagsToSnapshot' => true || false,
                            'CrossAccountClone' => true || false,
                            'CustomEndpoints' => ['<string>', ...],
                            'DatabaseName' => '<string>',
                            'DbClusterIdentifier' => '<string>',
                            'DbClusterMembers' => [
                                [
                                    'DbClusterParameterGroupStatus' => '<string>',
                                    'DbInstanceIdentifier' => '<string>',
                                    'IsClusterWriter' => true || false,
                                    'PromotionTier' => <integer>,
                                ],
                                // ...
                            ],
                            'DbClusterOptionGroupMemberships' => [
                                [
                                    'DbClusterOptionGroupName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'DbClusterParameterGroup' => '<string>',
                            'DbClusterResourceId' => '<string>',
                            'DbSubnetGroup' => '<string>',
                            'DeletionProtection' => true || false,
                            'DomainMemberships' => [
                                [
                                    'Domain' => '<string>',
                                    'Fqdn' => '<string>',
                                    'IamRoleName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'EnabledCloudWatchLogsExports' => ['<string>', ...],
                            'Endpoint' => '<string>',
                            'Engine' => '<string>',
                            'EngineMode' => '<string>',
                            'EngineVersion' => '<string>',
                            'HostedZoneId' => '<string>',
                            'HttpEndpointEnabled' => true || false,
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'KmsKeyId' => '<string>',
                            'MasterUsername' => '<string>',
                            'MultiAz' => true || false,
                            'Port' => <integer>,
                            'PreferredBackupWindow' => '<string>',
                            'PreferredMaintenanceWindow' => '<string>',
                            'ReadReplicaIdentifiers' => ['<string>', ...],
                            'ReaderEndpoint' => '<string>',
                            'Status' => '<string>',
                            'StorageEncrypted' => true || false,
                            'VpcSecurityGroups' => [
                                [
                                    'Status' => '<string>',
                                    'VpcSecurityGroupId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsRdsDbClusterSnapshot' => [
                            'AllocatedStorage' => <integer>,
                            'AvailabilityZones' => ['<string>', ...],
                            'ClusterCreateTime' => '<string>',
                            'DbClusterIdentifier' => '<string>',
                            'DbClusterSnapshotAttributes' => [
                                [
                                    'AttributeName' => '<string>',
                                    'AttributeValues' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'DbClusterSnapshotIdentifier' => '<string>',
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'KmsKeyId' => '<string>',
                            'LicenseModel' => '<string>',
                            'MasterUsername' => '<string>',
                            'PercentProgress' => <integer>,
                            'Port' => <integer>,
                            'SnapshotCreateTime' => '<string>',
                            'SnapshotType' => '<string>',
                            'Status' => '<string>',
                            'StorageEncrypted' => true || false,
                            'VpcId' => '<string>',
                        ],
                        'AwsRdsDbInstance' => [
                            'AllocatedStorage' => <integer>,
                            'AssociatedRoles' => [
                                [
                                    'FeatureName' => '<string>',
                                    'RoleArn' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'AutoMinorVersionUpgrade' => true || false,
                            'AvailabilityZone' => '<string>',
                            'BackupRetentionPeriod' => <integer>,
                            'CACertificateIdentifier' => '<string>',
                            'CharacterSetName' => '<string>',
                            'CopyTagsToSnapshot' => true || false,
                            'DBClusterIdentifier' => '<string>',
                            'DBInstanceClass' => '<string>',
                            'DBInstanceIdentifier' => '<string>',
                            'DBName' => '<string>',
                            'DbInstancePort' => <integer>,
                            'DbInstanceStatus' => '<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>',
                            ],
                            'DbiResourceId' => '<string>',
                            'DeletionProtection' => true || false,
                            'DomainMemberships' => [
                                [
                                    'Domain' => '<string>',
                                    'Fqdn' => '<string>',
                                    'IamRoleName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'EnabledCloudWatchLogsExports' => ['<string>', ...],
                            'Endpoint' => [
                                'Address' => '<string>',
                                'HostedZoneId' => '<string>',
                                'Port' => <integer>,
                            ],
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'EnhancedMonitoringResourceArn' => '<string>',
                            'IAMDatabaseAuthenticationEnabled' => true || false,
                            'InstanceCreateTime' => '<string>',
                            'Iops' => <integer>,
                            'KmsKeyId' => '<string>',
                            'LatestRestorableTime' => '<string>',
                            'LicenseModel' => '<string>',
                            'ListenerEndpoint' => [
                                'Address' => '<string>',
                                'HostedZoneId' => '<string>',
                                'Port' => <integer>,
                            ],
                            'MasterUsername' => '<string>',
                            'MaxAllocatedStorage' => <integer>,
                            'MonitoringInterval' => <integer>,
                            'MonitoringRoleArn' => '<string>',
                            'MultiAz' => true || false,
                            'OptionGroupMemberships' => [
                                [
                                    'OptionGroupName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'PendingModifiedValues' => [
                                'AllocatedStorage' => <integer>,
                                'BackupRetentionPeriod' => <integer>,
                                'CaCertificateIdentifier' => '<string>',
                                'DbInstanceClass' => '<string>',
                                'DbInstanceIdentifier' => '<string>',
                                'DbSubnetGroupName' => '<string>',
                                'EngineVersion' => '<string>',
                                'Iops' => <integer>,
                                'LicenseModel' => '<string>',
                                'MasterUserPassword' => '<string>',
                                'MultiAZ' => true || false,
                                'PendingCloudWatchLogsExports' => [
                                    'LogTypesToDisable' => ['<string>', ...],
                                    'LogTypesToEnable' => ['<string>', ...],
                                ],
                                'Port' => <integer>,
                                'ProcessorFeatures' => [
                                    [
                                        'Name' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'StorageType' => '<string>',
                            ],
                            'PerformanceInsightsEnabled' => true || false,
                            'PerformanceInsightsKmsKeyId' => '<string>',
                            'PerformanceInsightsRetentionPeriod' => <integer>,
                            'PreferredBackupWindow' => '<string>',
                            'PreferredMaintenanceWindow' => '<string>',
                            'ProcessorFeatures' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'PromotionTier' => <integer>,
                            'PubliclyAccessible' => true || false,
                            'ReadReplicaDBClusterIdentifiers' => ['<string>', ...],
                            'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
                            'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
                            'SecondaryAvailabilityZone' => '<string>',
                            'StatusInfos' => [
                                [
                                    'Message' => '<string>',
                                    'Normal' => true || false,
                                    'Status' => '<string>',
                                    'StatusType' => '<string>',
                                ],
                                // ...
                            ],
                            'StorageEncrypted' => true || false,
                            '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' => <integer>,
                            'AvailabilityZone' => '<string>',
                            'DbInstanceIdentifier' => '<string>',
                            'DbSnapshotIdentifier' => '<string>',
                            'DbiResourceId' => '<string>',
                            'Encrypted' => true || false,
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'InstanceCreateTime' => '<string>',
                            'Iops' => <integer>,
                            'KmsKeyId' => '<string>',
                            'LicenseModel' => '<string>',
                            'MasterUsername' => '<string>',
                            'OptionGroupName' => '<string>',
                            'PercentProgress' => <integer>,
                            'Port' => <integer>,
                            'ProcessorFeatures' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'SnapshotCreateTime' => '<string>',
                            'SnapshotType' => '<string>',
                            'SourceDbSnapshotIdentifier' => '<string>',
                            'SourceRegion' => '<string>',
                            'Status' => '<string>',
                            'StorageType' => '<string>',
                            'TdeCredentialArn' => '<string>',
                            'Timezone' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsRdsEventSubscription' => [
                            'CustSubscriptionId' => '<string>',
                            'CustomerAwsId' => '<string>',
                            'Enabled' => true || false,
                            'EventCategoriesList' => ['<string>', ...],
                            'EventSubscriptionArn' => '<string>',
                            'SnsTopicArn' => '<string>',
                            'SourceIdsList' => ['<string>', ...],
                            'SourceType' => '<string>',
                            'Status' => '<string>',
                            'SubscriptionCreationTime' => '<string>',
                        ],
                        'AwsRedshiftCluster' => [
                            'AllowVersionUpgrade' => true || false,
                            'AutomatedSnapshotRetentionPeriod' => <integer>,
                            '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' => <integer>,
                                'RetentionPeriod' => <integer>,
                                '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' => true || false,
                            'Endpoint' => [
                                'Address' => '<string>',
                                'Port' => <integer>,
                            ],
                            'EnhancedVpcRouting' => true || false,
                            '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' => true || false,
                                'S3KeyPrefix' => '<string>',
                            ],
                            'MaintenanceTrackName' => '<string>',
                            'ManualSnapshotRetentionPeriod' => <integer>,
                            'MasterUsername' => '<string>',
                            'NextMaintenanceWindowStartTime' => '<string>',
                            'NodeType' => '<string>',
                            'NumberOfNodes' => <integer>,
                            'PendingActions' => ['<string>', ...],
                            'PendingModifiedValues' => [
                                'AutomatedSnapshotRetentionPeriod' => <integer>,
                                'ClusterIdentifier' => '<string>',
                                'ClusterType' => '<string>',
                                'ClusterVersion' => '<string>',
                                'EncryptionType' => '<string>',
                                'EnhancedVpcRouting' => true || false,
                                'MaintenanceTrackName' => '<string>',
                                'MasterUserPassword' => '<string>',
                                'NodeType' => '<string>',
                                'NumberOfNodes' => <integer>,
                                'PubliclyAccessible' => true || false,
                            ],
                            'PreferredMaintenanceWindow' => '<string>',
                            'PubliclyAccessible' => true || false,
                            'ResizeInfo' => [
                                'AllowCancelResize' => true || false,
                                'ResizeType' => '<string>',
                            ],
                            'RestoreStatus' => [
                                'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
                                'ElapsedTimeInSeconds' => <integer>,
                                'EstimatedTimeToCompletionInSeconds' => <integer>,
                                'ProgressInMegaBytes' => <integer>,
                                'SnapshotSizeInMegaBytes' => <integer>,
                                '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' => true || false,
                                'BlockPublicPolicy' => true || false,
                                'IgnorePublicAcls' => true || false,
                                'RestrictPublicBuckets' => true || false,
                            ],
                            'VpcConfiguration' => [
                                'VpcId' => '<string>',
                            ],
                        ],
                        'AwsS3AccountPublicAccessBlock' => [
                            'BlockPublicAcls' => true || false,
                            'BlockPublicPolicy' => true || false,
                            'IgnorePublicAcls' => true || false,
                            'RestrictPublicBuckets' => true || false,
                        ],
                        'AwsS3Bucket' => [
                            'AccessControlList' => '<string>',
                            'BucketLifecycleConfiguration' => [
                                'Rules' => [
                                    [
                                        'AbortIncompleteMultipartUpload' => [
                                            'DaysAfterInitiation' => <integer>,
                                        ],
                                        'ExpirationDate' => '<string>',
                                        'ExpirationInDays' => <integer>,
                                        'ExpiredObjectDeleteMarker' => true || false,
                                        'Filter' => [
                                            'Predicate' => [
                                                'Operands' => [
                                                    [
                                                        'Prefix' => '<string>',
                                                        'Tag' => [
                                                            'Key' => '<string>',
                                                            'Value' => '<string>',
                                                        ],
                                                        'Type' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'Prefix' => '<string>',
                                                'Tag' => [
                                                    'Key' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                'Type' => '<string>',
                                            ],
                                        ],
                                        'ID' => '<string>',
                                        'NoncurrentVersionExpirationInDays' => <integer>,
                                        'NoncurrentVersionTransitions' => [
                                            [
                                                'Days' => <integer>,
                                                'StorageClass' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'Prefix' => '<string>',
                                        'Status' => '<string>',
                                        'Transitions' => [
                                            [
                                                'Date' => '<string>',
                                                'Days' => <integer>,
                                                'StorageClass' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'BucketLoggingConfiguration' => [
                                'DestinationBucketName' => '<string>',
                                'LogFilePrefix' => '<string>',
                            ],
                            'BucketNotificationConfiguration' => [
                                'Configurations' => [
                                    [
                                        'Destination' => '<string>',
                                        'Events' => ['<string>', ...],
                                        'Filter' => [
                                            'S3KeyFilter' => [
                                                'FilterRules' => [
                                                    [
                                                        'Name' => 'Prefix|Suffix',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'Type' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'BucketVersioningConfiguration' => [
                                'IsMfaDeleteEnabled' => true || false,
                                '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' => <integer>,
                                        'Mode' => '<string>',
                                        'Years' => <integer>,
                                    ],
                                ],
                            ],
                            'OwnerAccountId' => '<string>',
                            'OwnerId' => '<string>',
                            'OwnerName' => '<string>',
                            'PublicAccessBlockConfiguration' => [
                                'BlockPublicAcls' => true || false,
                                'BlockPublicPolicy' => true || false,
                                'IgnorePublicAcls' => true || false,
                                'RestrictPublicBuckets' => true || false,
                            ],
                            'ServerSideEncryptionConfiguration' => [
                                'Rules' => [
                                    [
                                        'ApplyServerSideEncryptionByDefault' => [
                                            'KMSMasterKeyID' => '<string>',
                                            'SSEAlgorithm' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'AwsS3Object' => [
                            'ContentType' => '<string>',
                            'ETag' => '<string>',
                            'LastModified' => '<string>',
                            'SSEKMSKeyId' => '<string>',
                            'ServerSideEncryption' => '<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' => <integer>,
                        ],
                        'AwsSecretsManagerSecret' => [
                            'Deleted' => true || false,
                            'Description' => '<string>',
                            'KmsKeyId' => '<string>',
                            'Name' => '<string>',
                            'RotationEnabled' => true || false,
                            'RotationLambdaArn' => '<string>',
                            'RotationOccurredWithinFrequency' => true || false,
                            'RotationRules' => [
                                'AutomaticallyAfterDays' => <integer>,
                            ],
                        ],
                        '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' => <integer>,
                            'KmsMasterKeyId' => '<string>',
                            'QueueName' => '<string>',
                        ],
                        'AwsSsmPatchCompliance' => [
                            'Patch' => [
                                'ComplianceSummary' => [
                                    'ComplianceType' => '<string>',
                                    'CompliantCriticalCount' => <integer>,
                                    'CompliantHighCount' => <integer>,
                                    'CompliantInformationalCount' => <integer>,
                                    'CompliantLowCount' => <integer>,
                                    'CompliantMediumCount' => <integer>,
                                    'CompliantUnspecifiedCount' => <integer>,
                                    'ExecutionType' => '<string>',
                                    'NonCompliantCriticalCount' => <integer>,
                                    'NonCompliantHighCount' => <integer>,
                                    'NonCompliantInformationalCount' => <integer>,
                                    'NonCompliantLowCount' => <integer>,
                                    'NonCompliantMediumCount' => <integer>,
                                    'NonCompliantUnspecifiedCount' => <integer>,
                                    'OverallSeverity' => '<string>',
                                    'PatchBaselineId' => '<string>',
                                    'PatchGroup' => '<string>',
                                    'Status' => '<string>',
                                ],
                            ],
                        ],
                        'AwsStepFunctionStateMachine' => [
                            'Label' => '<string>',
                            'LoggingConfiguration' => [
                                'Destinations' => [
                                    [
                                        'CloudWatchLogsLogGroup' => [
                                            'LogGroupArn' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                                'IncludeExecutionData' => true || false,
                                'Level' => '<string>',
                            ],
                            'Name' => '<string>',
                            'RoleArn' => '<string>',
                            'StateMachineArn' => '<string>',
                            'Status' => '<string>',
                            'TracingConfiguration' => [
                                'Enabled' => true || false,
                            ],
                            'Type' => '<string>',
                        ],
                        'AwsWafRateBasedRule' => [
                            'MatchPredicates' => [
                                [
                                    'DataId' => '<string>',
                                    'Negated' => true || false,
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'MetricName' => '<string>',
                            'Name' => '<string>',
                            'RateKey' => '<string>',
                            'RateLimit' => <integer>,
                            'RuleId' => '<string>',
                        ],
                        'AwsWafRegionalRateBasedRule' => [
                            'MatchPredicates' => [
                                [
                                    'DataId' => '<string>',
                                    'Negated' => true || false,
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'MetricName' => '<string>',
                            'Name' => '<string>',
                            'RateKey' => '<string>',
                            'RateLimit' => <integer>,
                            'RuleId' => '<string>',
                        ],
                        'AwsWafRegionalRule' => [
                            'MetricName' => '<string>',
                            'Name' => '<string>',
                            'PredicateList' => [
                                [
                                    'DataId' => '<string>',
                                    'Negated' => true || false,
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'RuleId' => '<string>',
                        ],
                        'AwsWafRegionalRuleGroup' => [
                            'MetricName' => '<string>',
                            'Name' => '<string>',
                            'RuleGroupId' => '<string>',
                            'Rules' => [
                                [
                                    'Action' => [
                                        'Type' => '<string>',
                                    ],
                                    'Priority' => <integer>,
                                    'RuleId' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsWafRegionalWebAcl' => [
                            'DefaultAction' => '<string>',
                            'MetricName' => '<string>',
                            'Name' => '<string>',
                            'RulesList' => [
                                [
                                    'Action' => [
                                        'Type' => '<string>',
                                    ],
                                    'OverrideAction' => [
                                        'Type' => '<string>',
                                    ],
                                    'Priority' => <integer>,
                                    'RuleId' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'WebAclId' => '<string>',
                        ],
                        'AwsWafRule' => [
                            'MetricName' => '<string>',
                            'Name' => '<string>',
                            'PredicateList' => [
                                [
                                    'DataId' => '<string>',
                                    'Negated' => true || false,
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'RuleId' => '<string>',
                        ],
                        'AwsWafRuleGroup' => [
                            'MetricName' => '<string>',
                            'Name' => '<string>',
                            'RuleGroupId' => '<string>',
                            'Rules' => [
                                [
                                    'Action' => [
                                        'Type' => '<string>',
                                    ],
                                    'Priority' => <integer>,
                                    'RuleId' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsWafWebAcl' => [
                            'DefaultAction' => '<string>',
                            'Name' => '<string>',
                            'Rules' => [
                                [
                                    'Action' => [
                                        'Type' => '<string>',
                                    ],
                                    'ExcludedRules' => [
                                        [
                                            'RuleId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'OverrideAction' => [
                                        'Type' => '<string>',
                                    ],
                                    'Priority' => <integer>,
                                    'RuleId' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'WebAclId' => '<string>',
                        ],
                        'AwsWafv2RuleGroup' => [
                            'Arn' => '<string>',
                            'Capacity' => <integer>,
                            'Description' => '<string>',
                            'Id' => '<string>',
                            'Name' => '<string>',
                            'Rules' => [
                                [
                                    'Action' => [
                                        'Allow' => [
                                            'CustomRequestHandling' => [
                                                'InsertHeaders' => [
                                                    [
                                                        'Name' => '<string>',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'Block' => [
                                            'CustomResponse' => [
                                                'CustomResponseBodyKey' => '<string>',
                                                'ResponseCode' => <integer>,
                                                'ResponseHeaders' => [
                                                    [
                                                        'Name' => '<string>',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'Captcha' => [
                                            'CustomRequestHandling' => [
                                                'InsertHeaders' => [
                                                    [
                                                        'Name' => '<string>',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'Count' => [
                                            'CustomRequestHandling' => [
                                                'InsertHeaders' => [
                                                    [
                                                        'Name' => '<string>',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                    ],
                                    'Name' => '<string>',
                                    'OverrideAction' => '<string>',
                                    'Priority' => <integer>,
                                    'VisibilityConfig' => [
                                        'CloudWatchMetricsEnabled' => true || false,
                                        'MetricName' => '<string>',
                                        'SampledRequestsEnabled' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'Scope' => '<string>',
                            'VisibilityConfig' => [
                                'CloudWatchMetricsEnabled' => true || false,
                                'MetricName' => '<string>',
                                'SampledRequestsEnabled' => true || false,
                            ],
                        ],
                        'AwsWafv2WebAcl' => [
                            'Arn' => '<string>',
                            'Capacity' => <integer>,
                            'CaptchaConfig' => [
                                'ImmunityTimeProperty' => [
                                    'ImmunityTime' => <integer>,
                                ],
                            ],
                            'DefaultAction' => [
                                'Allow' => [
                                    'CustomRequestHandling' => [
                                        'InsertHeaders' => [
                                            [
                                                'Name' => '<string>',
                                                'Value' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                'Block' => [
                                    'CustomResponse' => [
                                        'CustomResponseBodyKey' => '<string>',
                                        'ResponseCode' => <integer>,
                                        'ResponseHeaders' => [
                                            [
                                                'Name' => '<string>',
                                                'Value' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                            ],
                            'Description' => '<string>',
                            'Id' => '<string>',
                            'ManagedbyFirewallManager' => true || false,
                            'Name' => '<string>',
                            'Rules' => [
                                [
                                    'Action' => [
                                        'Allow' => [
                                            'CustomRequestHandling' => [
                                                'InsertHeaders' => [
                                                    [
                                                        'Name' => '<string>',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'Block' => [
                                            'CustomResponse' => [
                                                'CustomResponseBodyKey' => '<string>',
                                                'ResponseCode' => <integer>,
                                                'ResponseHeaders' => [
                                                    [
                                                        'Name' => '<string>',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'Captcha' => [
                                            'CustomRequestHandling' => [
                                                'InsertHeaders' => [
                                                    [
                                                        'Name' => '<string>',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                        'Count' => [
                                            'CustomRequestHandling' => [
                                                'InsertHeaders' => [
                                                    [
                                                        'Name' => '<string>',
                                                        'Value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                        ],
                                    ],
                                    'Name' => '<string>',
                                    'OverrideAction' => '<string>',
                                    'Priority' => <integer>,
                                    'VisibilityConfig' => [
                                        'CloudWatchMetricsEnabled' => true || false,
                                        'MetricName' => '<string>',
                                        'SampledRequestsEnabled' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'VisibilityConfig' => [
                                'CloudWatchMetricsEnabled' => true || false,
                                'MetricName' => '<string>',
                                'SampledRequestsEnabled' => true || false,
                            ],
                        ],
                        'AwsXrayEncryptionConfig' => [
                            'KeyId' => '<string>',
                            'Status' => '<string>',
                            'Type' => '<string>',
                        ],
                        'Container' => [
                            'ContainerRuntime' => '<string>',
                            'ImageId' => '<string>',
                            'ImageName' => '<string>',
                            'LaunchedAt' => '<string>',
                            'Name' => '<string>',
                            'Privileged' => true || false,
                            'VolumeMounts' => [
                                [
                                    'MountPath' => '<string>',
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'Other' => ['<string>', ...],
                    ],
                    'Id' => '<string>', // REQUIRED
                    'Partition' => 'aws|aws-cn|aws-us-gov',
                    'Region' => '<string>',
                    'ResourceRole' => '<string>',
                    'Tags' => ['<string>', ...],
                    'Type' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Sample' => true || false,
            'SchemaVersion' => '<string>', // REQUIRED
            'Severity' => [
                'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
                'Normalized' => <integer>,
                'Original' => '<string>',
                'Product' => <float>,
            ],
            'SourceUrl' => '<string>',
            'ThreatIntelIndicators' => [
                [
                    'Category' => 'BACKDOOR|CARD_STEALER|COMMAND_AND_CONTROL|DROP_SITE|EXPLOIT_SITE|KEYLOGGER',
                    'LastObservedAt' => '<string>',
                    'Source' => '<string>',
                    'SourceUrl' => '<string>',
                    'Type' => 'DOMAIN|EMAIL_ADDRESS|HASH_MD5|HASH_SHA1|HASH_SHA256|HASH_SHA512|IPV4_ADDRESS|IPV6_ADDRESS|MUTEX|PROCESS|URL',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Threats' => [
                [
                    'FilePaths' => [
                        [
                            'FileName' => '<string>',
                            'FilePath' => '<string>',
                            'Hash' => '<string>',
                            'ResourceId' => '<string>',
                        ],
                        // ...
                    ],
                    'ItemCount' => <integer>,
                    'Name' => '<string>',
                    'Severity' => '<string>',
                ],
                // ...
            ],
            'Title' => '<string>', // REQUIRED
            'Types' => ['<string>', ...],
            'UpdatedAt' => '<string>', // REQUIRED
            'UserDefinedFields' => ['<string>', ...],
            'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
            'Vulnerabilities' => [
                [
                    'CodeVulnerabilities' => [
                        [
                            'Cwes' => ['<string>', ...],
                            'FilePath' => [
                                'EndLine' => <integer>,
                                'FileName' => '<string>',
                                'FilePath' => '<string>',
                                'StartLine' => <integer>,
                            ],
                            'SourceArn' => '<string>',
                        ],
                        // ...
                    ],
                    'Cvss' => [
                        [
                            'Adjustments' => [
                                [
                                    'Metric' => '<string>',
                                    'Reason' => '<string>',
                                ],
                                // ...
                            ],
                            'BaseScore' => <float>,
                            'BaseVector' => '<string>',
                            'Source' => '<string>',
                            'Version' => '<string>',
                        ],
                        // ...
                    ],
                    'EpssScore' => <float>,
                    'ExploitAvailable' => 'YES|NO',
                    'FixAvailable' => 'YES|NO|PARTIAL',
                    'Id' => '<string>', // REQUIRED
                    'LastKnownExploitAt' => '<string>',
                    'ReferenceUrls' => ['<string>', ...],
                    'RelatedVulnerabilities' => ['<string>', ...],
                    'Vendor' => [
                        'Name' => '<string>', // REQUIRED
                        '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' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
            ],
            'WorkflowState' => 'NEW|ASSIGNED|IN_PROGRESS|DEFERRED|RESOLVED',
        ],
        // ...
    ],
]);

Parameter Details

Members
Findings
Required: Yes
Type: Array of AwsSecurityFinding structures

A list of findings to import. To successfully import a finding, it must follow the Amazon Web Services Security Finding Format. Maximum of 100 findings per request.

Result Syntax

[
    'FailedCount' => <integer>,
    'FailedFindings' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'Id' => '<string>',
        ],
        // ...
    ],
    'SuccessCount' => <integer>,
]

Result Details

Members
FailedCount
Required: Yes
Type: int

The number of findings that failed to import.

FailedFindings
Type: Array of ImportFindingsError structures

The list of findings that failed to import.

SuccessCount
Required: Yes
Type: int

The number of findings that were successfully imported.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

Examples

Example 1: To import security findings from a third party provider to Security Hub

The following example imports findings from a third party provider to Security Hub.

$result = $client->batchImportFindings([
    'Findings' => [
        [
            'AwsAccountId' => '123456789012',
            'CreatedAt' => '2020-05-27T17:05:54.832Z',
            'Description' => 'Vulnerability in a CloudTrail trail',
            'FindingProviderFields' => [
                'Severity' => [
                    'Label' => 'LOW',
                    'Original' => '10',
                ],
                'Types' => [
                    'Software and Configuration Checks/Vulnerabilities/CVE',
                ],
            ],
            'GeneratorId' => 'TestGeneratorId',
            'Id' => 'Id1',
            'ProductArn' => 'arn:aws:securityhub:us-west-1:123456789012:product/123456789012/default',
            'Resources' => [
                [
                    'Id' => 'arn:aws:cloudtrail:us-west-1:123456789012:trail/TrailName',
                    'Partition' => 'aws',
                    'Region' => 'us-west-1',
                    'Type' => 'AwsCloudTrailTrail',
                ],
            ],
            'SchemaVersion' => '2018-10-08',
            'Title' => 'CloudTrail trail vulnerability',
            'UpdatedAt' => '2020-06-02T16:05:54.832Z',
        ],
    ],
]);

Result syntax:

[
    'FailedCount' => 123,
    'FailedFindings' => [
    ],
    'SuccessCount' => 123,
]

BatchUpdateAutomationRules

$result = $client->batchUpdateAutomationRules([/* ... */]);
$promise = $client->batchUpdateAutomationRulesAsync([/* ... */]);

Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.

Parameter Syntax

$result = $client->batchUpdateAutomationRules([
    'UpdateAutomationRulesRequestItems' => [ // REQUIRED
        [
            'Actions' => [
                [
                    'FindingFieldsUpdate' => [
                        'Confidence' => <integer>,
                        'Criticality' => <integer>,
                        'Note' => [
                            'Text' => '<string>', // REQUIRED
                            'UpdatedBy' => '<string>', // REQUIRED
                        ],
                        'RelatedFindings' => [
                            [
                                'Id' => '<string>', // REQUIRED
                                'ProductArn' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Severity' => [
                            'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
                            'Normalized' => <integer>,
                            'Product' => <float>,
                        ],
                        'Types' => ['<string>', ...],
                        'UserDefinedFields' => ['<string>', ...],
                        'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
                        'Workflow' => [
                            'Status' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
                        ],
                    ],
                    'Type' => 'FINDING_FIELDS_UPDATE',
                ],
                // ...
            ],
            'Criteria' => [
                'AwsAccountId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'AwsAccountName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'CompanyName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ComplianceAssociatedStandardsId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ComplianceSecurityControlId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ComplianceStatus' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Confidence' => [
                    [
                        'Eq' => <float>,
                        'Gt' => <float>,
                        'Gte' => <float>,
                        'Lt' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'CreatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'Criticality' => [
                    [
                        'Eq' => <float>,
                        'Gt' => <float>,
                        'Gte' => <float>,
                        'Lt' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'Description' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'FirstObservedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'GeneratorId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Id' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'LastObservedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'NoteText' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NoteUpdatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'NoteUpdatedBy' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProductArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProductName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RecordState' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RelatedFindingsId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RelatedFindingsProductArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceApplicationArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceApplicationName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceDetailsOther' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourcePartition' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceRegion' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceTags' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceType' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'SeverityLabel' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'SourceUrl' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Title' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Type' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'UpdatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'UserDefinedFields' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VerificationState' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'WorkflowStatus' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Description' => '<string>',
            'IsTerminal' => true || false,
            'RuleArn' => '<string>', // REQUIRED
            'RuleName' => '<string>',
            'RuleOrder' => <integer>,
            'RuleStatus' => 'ENABLED|DISABLED',
        ],
        // ...
    ],
]);

Parameter Details

Members
UpdateAutomationRulesRequestItems
Required: Yes
Type: Array of UpdateAutomationRulesRequestItem structures

An array of ARNs for the rules that are to be updated. Optionally, you can also include RuleStatus and RuleOrder.

Result Syntax

[
    'ProcessedAutomationRules' => ['<string>', ...],
    'UnprocessedAutomationRules' => [
        [
            'ErrorCode' => <integer>,
            'ErrorMessage' => '<string>',
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ProcessedAutomationRules
Type: Array of strings

A list of properly processed rule ARNs.

UnprocessedAutomationRules
Type: Array of UnprocessedAutomationRule structures

A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn't update and why.

Errors

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To update one ore more automation rules

The following example updates the specified automation rules.

$result = $client->batchUpdateAutomationRules([
    'UpdateAutomationRulesRequestItems' => [
        [
            'RuleArn' => 'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
            'RuleOrder' => 15,
            'RuleStatus' => 'ENABLED',
        ],
        [
            'RuleArn' => 'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
            'RuleStatus' => 'DISABLED',
        ],
    ],
]);

Result syntax:

[
    'ProcessedAutomationRules' => [
        'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
    ],
]

BatchUpdateFindings

$result = $client->batchUpdateFindings([/* ... */]);
$promise = $client->batchUpdateFindingsAsync([/* ... */]);

Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.

Updates from BatchUpdateFindings don't affect the value of UpdatedAt for a finding.

Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects.

  • Confidence

  • Criticality

  • Note

  • RelatedFindings

  • Severity

  • Types

  • UserDefinedFields

  • VerificationState

  • Workflow

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. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.

Parameter Syntax

$result = $client->batchUpdateFindings([
    'Confidence' => <integer>,
    'Criticality' => <integer>,
    'FindingIdentifiers' => [ // REQUIRED
        [
            'Id' => '<string>', // REQUIRED
            'ProductArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Note' => [
        'Text' => '<string>', // REQUIRED
        'UpdatedBy' => '<string>', // REQUIRED
    ],
    'RelatedFindings' => [
        [
            'Id' => '<string>', // REQUIRED
            'ProductArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Severity' => [
        'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
        'Normalized' => <integer>,
        'Product' => <float>,
    ],
    'Types' => ['<string>', ...],
    'UserDefinedFields' => ['<string>', ...],
    'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
    'Workflow' => [
        'Status' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
    ],
]);

Parameter Details

Members
Confidence
Type: int

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.

Criticality
Type: int

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.

FindingIdentifiers
Required: Yes
Type: Array of AwsSecurityFindingIdentifier structures

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.

Note
Type: NoteUpdate structure

The updated note.

RelatedFindings
Type: Array of RelatedFinding structures

A list of findings that are related to the updated findings.

Severity
Type: SeverityUpdate structure

Used to update the finding severity.

Types
Type: Array of strings

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

UserDefinedFields
Type: Associative array of custom strings keys (NonEmptyString) to strings

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

VerificationState
Type: string

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

Workflow
Type: WorkflowUpdate structure

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

Result Syntax

[
    'ProcessedFindings' => [
        [
            'Id' => '<string>',
            'ProductArn' => '<string>',
        ],
        // ...
    ],
    'UnprocessedFindings' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'FindingIdentifier' => [
                'Id' => '<string>',
                'ProductArn' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
ProcessedFindings
Required: Yes
Type: Array of AwsSecurityFindingIdentifier structures

The list of findings that were updated successfully.

UnprocessedFindings
Required: Yes
Type: Array of BatchUpdateFindingsUnprocessedFinding structures

The list of findings that were not updated.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

Examples

Example 1: To update Security Hub findings

The following example updates Security Hub findings. The finding identifier parameter specifies which findings to update. Only specific finding fields can be updated with this operation.

$result = $client->batchUpdateFindings([
    'Confidence' => 80,
    'Criticality' => 80,
    'FindingIdentifiers' => [
        [
            'Id' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
            'ProductArn' => 'arn:aws:securityhub:us-west-1::product/aws/securityhub',
        ],
        [
            'Id' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
            'ProductArn' => 'arn:aws:securityhub:us-west-1::product/aws/securityhub',
        ],
    ],
    'Note' => [
        'Text' => 'Known issue that is not a risk.',
        'UpdatedBy' => 'user1',
    ],
    'RelatedFindings' => [
        [
            'Id' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333',
            'ProductArn' => 'arn:aws:securityhub:us-west-1::product/aws/securityhub',
        ],
    ],
    'Severity' => [
        'Label' => 'LOW',
    ],
    'Types' => [
        'Software and Configuration Checks/Vulnerabilities/CVE',
    ],
    'UserDefinedFields' => [
        'reviewedByCio' => 'true',
    ],
    'VerificationState' => 'TRUE_POSITIVE',
    'Workflow' => [
        'Status' => 'RESOLVED',
    ],
]);

Result syntax:

[
    'ProcessedFindings' => [
        [
            'Id' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
            'ProductArn' => 'arn:aws:securityhub:us-west-1::product/aws/securityhub',
        ],
        [
            'Id' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
            'ProductArn' => 'arn:aws:securityhub:us-west-1::product/aws/securityhub',
        ],
    ],
    'UnprocessedFindings' => [
    ],
]

BatchUpdateStandardsControlAssociations

$result = $client->batchUpdateStandardsControlAssociations([/* ... */]);
$promise = $client->batchUpdateStandardsControlAssociationsAsync([/* ... */]);

For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.

Parameter Syntax

$result = $client->batchUpdateStandardsControlAssociations([
    'StandardsControlAssociationUpdates' => [ // REQUIRED
        [
            'AssociationStatus' => 'ENABLED|DISABLED', // REQUIRED
            'SecurityControlId' => '<string>', // REQUIRED
            'StandardsArn' => '<string>', // REQUIRED
            'UpdatedReason' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
StandardsControlAssociationUpdates
Required: Yes
Type: Array of StandardsControlAssociationUpdate structures

Updates the enablement status of a security control in a specified standard.

Result Syntax

[
    'UnprocessedAssociationUpdates' => [
        [
            'ErrorCode' => 'INVALID_INPUT|ACCESS_DENIED|NOT_FOUND|LIMIT_EXCEEDED',
            'ErrorReason' => '<string>',
            'StandardsControlAssociationUpdate' => [
                'AssociationStatus' => 'ENABLED|DISABLED',
                'SecurityControlId' => '<string>',
                'StandardsArn' => '<string>',
                'UpdatedReason' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAssociationUpdates

A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement status in a specified standard couldn't be updated.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To update enablement status of a batch of controls

The following example disables CloudWatch.12 in CIS AWS Foundations Benchmark v1.2.0. The example returns an error for CloudTrail.1 because an invalid standard ARN is provided.

$result = $client->batchUpdateStandardsControlAssociations([
    'StandardsControlAssociationUpdates' => [
        [
            'AssociationStatus' => 'DISABLED',
            'SecurityControlId' => 'CloudTrail.1',
            'StandardsArn' => 'arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0',
            'UpdatedReason' => 'Not relevant to environment',
        ],
        [
            'AssociationStatus' => 'DISABLED',
            'SecurityControlId' => 'CloudWatch.12',
            'StandardsArn' => 'arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
            'UpdatedReason' => 'Not relevant to environment',
        ],
    ],
]);

Result syntax:

[
    'UnprocessedAssociationUpdates' => [
        [
            'ErrorCode' => 'INVALID_INPUT',
            'ErrorReason' => 'Invalid Standards Arn: 'arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0'',
            'StandardsControlAssociationUpdate' => [
                'AssociationStatus' => 'DISABLED',
                'SecurityControlId' => 'CloudTrail.1',
                'StandardsArn' => 'arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0',
                'UpdatedReason' => 'Test Reason',
            ],
        ],
    ],
]

CreateActionTarget

$result = $client->createActionTarget([/* ... */]);
$promise = $client->createActionTargetAsync([/* ... */]);

Creates a custom action target in Security Hub.

You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

Parameter Syntax

$result = $client->createActionTarget([
    'Description' => '<string>', // REQUIRED
    'Id' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
Required: Yes
Type: string

The description for the custom action target.

Id
Required: Yes
Type: string

The ID for the custom action target. Can contain up to 20 alphanumeric characters.

Name
Required: Yes
Type: string

The name of the custom action target. Can contain up to 20 characters.

Result Syntax

[
    'ActionTargetArn' => '<string>',
]

Result Details

Members
ActionTargetArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the custom action target.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceConflictException:

The resource specified in the request conflicts with an existing resource.

Examples

Example 1: To create a custom action target

The following example creates a custom action target in Security Hub. Custom actions on findings and insights automatically trigger actions in Amazon CloudWatch Events.

$result = $client->createActionTarget([
    'Description' => 'Action to send the finding for remediation tracking',
    'Id' => 'Remediation',
    'Name' => 'Send to remediation',
]);

Result syntax:

[
    'ActionTargetArn' => 'arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation',
]

CreateAutomationRule

$result = $client->createAutomationRule([/* ... */]);
$promise = $client->createAutomationRuleAsync([/* ... */]);

Creates an automation rule based on input parameters.

Parameter Syntax

$result = $client->createAutomationRule([
    'Actions' => [ // REQUIRED
        [
            'FindingFieldsUpdate' => [
                'Confidence' => <integer>,
                'Criticality' => <integer>,
                'Note' => [
                    'Text' => '<string>', // REQUIRED
                    'UpdatedBy' => '<string>', // REQUIRED
                ],
                'RelatedFindings' => [
                    [
                        'Id' => '<string>', // REQUIRED
                        'ProductArn' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'Severity' => [
                    'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
                    'Normalized' => <integer>,
                    'Product' => <float>,
                ],
                'Types' => ['<string>', ...],
                'UserDefinedFields' => ['<string>', ...],
                'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
                'Workflow' => [
                    'Status' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
                ],
            ],
            'Type' => 'FINDING_FIELDS_UPDATE',
        ],
        // ...
    ],
    'Criteria' => [ // REQUIRED
        'AwsAccountId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'AwsAccountName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CompanyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceAssociatedStandardsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceSecurityControlId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Confidence' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'CreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'Criticality' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'Description' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FirstObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'GeneratorId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Id' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'LastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'NoteText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedBy' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceApplicationArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceApplicationName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceDetailsOther' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourcePartition' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceRegion' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceTags' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Title' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'UserDefinedFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VerificationState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'Description' => '<string>', // REQUIRED
    'IsTerminal' => true || false,
    'RuleName' => '<string>', // REQUIRED
    'RuleOrder' => <integer>, // REQUIRED
    'RuleStatus' => 'ENABLED|DISABLED',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Actions
Required: Yes
Type: Array of AutomationRulesAction structures

One or more actions to update finding fields if a finding matches the conditions specified in Criteria.

Criteria
Required: Yes
Type: AutomationRulesFindingFilters structure

A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.

Description
Required: Yes
Type: string

A description of the rule.

IsTerminal
Type: boolean

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 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.

RuleName
Required: Yes
Type: string

The name of the rule.

RuleOrder
Required: Yes
Type: int

An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.

RuleStatus
Type: string

Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub 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 BatchUpdateAutomationRules .

Tags
Type: Associative array of custom strings keys (TagKey) to strings

User-defined tags associated with an automation rule.

Result Syntax

[
    'RuleArn' => '<string>',
]

Result Details

Members
RuleArn
Type: string

The Amazon Resource Name (ARN) of the automation rule that you created.

Errors

AccessDeniedException:

You don't have permission to perform the action specified in the request.

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

Examples

Example 1: To create an automation rule

The following example creates an automation rule.

$result = $client->createAutomationRule([
    'Actions' => [
        [
            'FindingFieldsUpdate' => [
                'Note' => [
                    'Text' => 'This is a critical S3 bucket, please look into this ASAP',
                    'UpdatedBy' => 'test-user',
                ],
                'Severity' => [
                    'Label' => 'CRITICAL',
                ],
            ],
            'Type' => 'FINDING_FIELDS_UPDATE',
        ],
    ],
    'Criteria' => [
        'ComplianceStatus' => [
            [
                'Comparison' => 'EQUALS',
                'Value' => 'FAILED',
            ],
        ],
        'ProductName' => [
            [
                'Comparison' => 'EQUALS',
                'Value' => 'Security Hub',
            ],
        ],
        'RecordState' => [
            [
                'Comparison' => 'EQUALS',
                'Value' => 'ACTIVE',
            ],
        ],
        'ResourceId' => [
            [
                'Comparison' => 'EQUALS',
                'Value' => 'arn:aws:s3:::examplebucket/developers/design_info.doc',
            ],
        ],
        'WorkflowStatus' => [
            [
                'Comparison' => 'EQUALS',
                'Value' => 'NEW',
            ],
        ],
    ],
    'Description' => 'Elevate finding severity to Critical for important resources',
    'IsTerminal' => ,
    'RuleName' => 'Elevate severity for important resources',
    'RuleOrder' => 1,
    'RuleStatus' => 'ENABLED',
    'Tags' => [
        'important-resources-rule' => 's3-bucket',
    ],
]);

Result syntax:

[
    'RuleArn' => 'arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]

CreateConfigurationPolicy

$result = $client->createConfigurationPolicy([/* ... */]);
$promise = $client->createConfigurationPolicyAsync([/* ... */]);

Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region.

Parameter Syntax

$result = $client->createConfigurationPolicy([
    'ConfigurationPolicy' => [ // REQUIRED
        'SecurityHub' => [
            'EnabledStandardIdentifiers' => ['<string>', ...],
            'SecurityControlsConfiguration' => [
                'DisabledSecurityControlIdentifiers' => ['<string>', ...],
                'EnabledSecurityControlIdentifiers' => ['<string>', ...],
                'SecurityControlCustomParameters' => [
                    [
                        'Parameters' => [
                            '<NonEmptyString>' => [
                                'Value' => [
                                    'Boolean' => true || false,
                                    'Double' => <float>,
                                    'Enum' => '<string>',
                                    'EnumList' => ['<string>', ...],
                                    'Integer' => <integer>,
                                    'IntegerList' => [<integer>, ...],
                                    'String' => '<string>',
                                    'StringList' => ['<string>', ...],
                                ],
                                'ValueType' => 'DEFAULT|CUSTOM', // REQUIRED
                            ],
                            // ...
                        ],
                        'SecurityControlId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ServiceEnabled' => true || false,
        ],
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ConfigurationPolicy
Required: Yes
Type: Policy structure

An object that defines how Security Hub is configured. It includes whether Security Hub 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 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 enables all other controls (including newly released controls).

Description
Type: string

The description of the configuration policy.

Name
Required: Yes
Type: string

The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted: -, ., !, *, /.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

User-defined tags associated with a configuration policy. For more information, see Tagging Security Hub resources in the Security Hub user guide.

Result Syntax

[
    'Arn' => '<string>',
    'ConfigurationPolicy' => [
        'SecurityHub' => [
            'EnabledStandardIdentifiers' => ['<string>', ...],
            'SecurityControlsConfiguration' => [
                'DisabledSecurityControlIdentifiers' => ['<string>', ...],
                'EnabledSecurityControlIdentifiers' => ['<string>', ...],
                'SecurityControlCustomParameters' => [
                    [
                        'Parameters' => [
                            '<NonEmptyString>' => [
                                'Value' => [
                                    'Boolean' => true || false,
                                    'Double' => <float>,
                                    'Enum' => '<string>',
                                    'EnumList' => ['<string>', ...],
                                    'Integer' => <integer>,
                                    'IntegerList' => [<integer>, ...],
                                    'String' => '<string>',
                                    'StringList' => ['<string>', ...],
                                ],
                                'ValueType' => 'DEFAULT|CUSTOM',
                            ],
                            // ...
                        ],
                        'SecurityControlId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ServiceEnabled' => true || false,
        ],
    ],
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the configuration policy.

ConfigurationPolicy
Type: Policy structure

An object that defines how Security Hub is configured. It includes whether Security Hub 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 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 enables all other controls (including newly released controls).

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time, in UTC and ISO 8601 format, that the configuration policy was created.

Description
Type: string

The description of the configuration policy.

Id
Type: string

The universally unique identifier (UUID) of the configuration policy.

Name
Type: string

The name of the configuration policy.

UpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.

Errors

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

ResourceConflictException:

The resource specified in the request conflicts with an existing resource.

Examples

Example 1: To create a configuration policy

This operation creates a configuration policy in Security Hub.

$result = $client->createConfigurationPolicy([
    'ConfigurationPolicy' => [
        'SecurityHub' => [
            'EnabledStandardIdentifiers' => [
                'arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0',
                'arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
            ],
            'SecurityControlsConfiguration' => [
                'DisabledSecurityControlIdentifiers' => [
                    'CloudWatch.1',
                ],
                'SecurityControlCustomParameters' => [
                    [
                        'Parameters' => [
                            'daysToExpiration' => [
                                'Value' => [
                                    'Integer' => 14,
                                ],
                                'ValueType' => 'CUSTOM',
                            ],
                        ],
                        'SecurityControlId' => 'ACM.1',
                    ],
                ],
            ],
            'ServiceEnabled' => 1,
        ],
    ],
    'Description' => 'Configuration policy for testing FSBP and CIS',
    'Name' => 'TestConfigurationPolicy',
]);

Result syntax:

[
    'Arn' => 'arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'ConfigurationPolicy' => [
        'SecurityHub' => [
            'EnabledStandardIdentifiers' => [
                'arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0',
                'arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
            ],
            'SecurityControlsConfiguration' => [
                'DisabledSecurityControlIdentifiers' => [
                    'CloudWatch.1',
                ],
                'SecurityControlCustomParameters' => [
                    [
                        'Parameters' => [
                            'daysToExpiration' => [
                                'Value' => [
                                    'Integer' => 14,
                                ],
                                'ValueType' => 'CUSTOM',
                            ],
                        ],
                        'SecurityControlId' => 'ACM.1',
                    ],
                ],
            ],
            'ServiceEnabled' => 1,
        ],
    ],
    'CreatedAt' => ,
    'Description' => 'Configuration policy for testing FSBP and CIS',
    'Id' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'Name' => 'TestConfigurationPolicy',
    'UpdatedAt' => ,
]

CreateFindingAggregator

$result = $client->createFindingAggregator([/* ... */]);
$promise = $client->createFindingAggregatorAsync([/* ... */]);

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 in the Security Hub User Guide.

Parameter Syntax

$result = $client->createFindingAggregator([
    'RegionLinkingMode' => '<string>', // REQUIRED
    'Regions' => ['<string>', ...],
]);

Parameter Details

Members
RegionLinkingMode
Required: Yes
Type: string

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 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 is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.

  • ALL_REGIONS_EXCEPT_SPECIFIED - Aggregates findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.

  • SPECIFIED_REGIONS - Aggregates findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

  • NO_REGIONS - Aggregates no data because no Regions are selected as linked Regions.

Regions
Type: Array of strings

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.

Result Syntax

[
    'FindingAggregationRegion' => '<string>',
    'FindingAggregatorArn' => '<string>',
    'RegionLinkingMode' => '<string>',
    'Regions' => ['<string>', ...],
]

Result Details

Members
FindingAggregationRegion
Type: string

The home Region. Findings generated in linked Regions are replicated and sent to the home Region.

FindingAggregatorArn
Type: string

The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop cross-Region aggregation.

RegionLinkingMode
Type: string

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

Regions
Type: Array of strings

The list of excluded Regions or included Regions.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

Examples

Example 1: To enable cross-Region aggregation

The following example creates a finding aggregator. This is required to enable cross-Region aggregation.

$result = $client->createFindingAggregator([
    'RegionLinkingMode' => 'SPECIFIED_REGIONS',
    'Regions' => [
        'us-west-1',
        'us-west-2',
    ],
]);

Result syntax:

[
    'FindingAggregationRegion' => 'us-east-1',
    'FindingAggregatorArn' => 'arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'RegionLinkingMode' => 'SPECIFIED_REGIONS',
    'Regions' => [
        'us-west-1',
        'us-west-2',
    ],
]

CreateInsight

$result = $client->createInsight([/* ... */]);
$promise = $client->createInsightAsync([/* ... */]);

Creates a custom insight in Security Hub. 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.

Parameter Syntax

$result = $client->createInsight([
    'Filters' => [ // REQUIRED
        'AwsAccountId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'AwsAccountName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CompanyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceAssociatedStandardsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceSecurityControlId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceSecurityControlParametersName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceSecurityControlParametersValue' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Confidence' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'CreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'Criticality' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'Description' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsConfidence' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'FindingProviderFieldsCriticality' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'FindingProviderFieldsRelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsRelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsSeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsSeverityOriginal' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsTypes' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FirstObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'GeneratorId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Id' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Keyword' => [
            [
                'Value' => '<string>',
            ],
            // ...
        ],
        'LastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'MalwareName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwarePath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationPort' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NetworkDirection' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkProtocol' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceMac' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourcePort' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NoteText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedBy' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProcessName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessParentPid' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessPath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessPid' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessTerminatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecommendationText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Region' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceApplicationArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceApplicationName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV4Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV6Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceKeyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceSubnetId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceVpcId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyCreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyPrincipalName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyUserName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamUserUserName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceDetailsOther' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourcePartition' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceRegion' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceTags' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Sample' => [
            [
                'Value' => true || false,
            ],
            // ...
        ],
        'SeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityNormalized' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SeverityProduct' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorCategory' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorLastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSource' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorValue' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Title' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'UserDefinedFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VerificationState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VulnerabilitiesExploitAvailable' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VulnerabilitiesFixAvailable' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'GroupByAttribute' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Filters
Required: Yes
Type: AwsSecurityFindingFilters structure

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.

GroupByAttribute
Required: Yes
Type: string

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.

Name
Required: Yes
Type: string

The name of the custom insight to create.

Result Syntax

[
    'InsightArn' => '<string>',
]

Result Details

Members
InsightArn
Required: Yes
Type: string

The ARN of the insight created.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceConflictException:

The resource specified in the request conflicts with an existing resource.

Examples

Example 1: To create a custom insight

The following example creates a custom insight in Security Hub. An insight is a collection of findings that relate to a security issue.

$result = $client->createInsight([
    'Filters' => [
        'ResourceType' => [
            [
                'Comparison' => 'EQUALS',
                'Value' => 'AwsIamRole',
            ],
        ],
        'SeverityLabel' => [
            [
                'Comparison' => 'EQUALS',
                'Value' => 'CRITICAL',
            ],
        ],
    ],
    'GroupByAttribute' => 'ResourceId',
    'Name' => 'Critical role findings',
]);

Result syntax:

[
    'InsightArn' => 'arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]

CreateMembers

$result = $client->createMembers([/* ... */]);
$promise = $client->createMembersAsync([/* ... */]);

Creates a member association in Security Hub 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 is not configured to automatically add new organization accounts.

  • The account was disassociated or deleted in Security Hub.

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, 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.

Accounts that are managed using Organizations don't receive an invitation. They automatically become a member account in Security Hub.

  • If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

  • For organization accounts that already have Security Hub enabled, Security Hub 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.

Parameter Syntax

$result = $client->createMembers([
    'AccountDetails' => [ // REQUIRED
        [
            'AccountId' => '<string>', // REQUIRED
            'Email' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
AccountDetails
Required: Yes
Type: Array of AccountDetails structures

The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
Type: Array of Result structures

The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceConflictException:

The resource specified in the request conflicts with an existing resource.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To add a member account

The following example creates a member association between the specified accounts and the administrator account (the account that makes the request). This operation is used to add accounts that aren't part of an organization.

$result = $client->createMembers([
    'AccountDetails' => [
        [
            'AccountId' => '123456789012',
        ],
        [
            'AccountId' => '111122223333',
        ],
    ],
]);

Result syntax:

[
    'UnprocessedAccounts' => [
    ],
]

DeclineInvitations

$result = $client->declineInvitations([/* ... */]);
$promise = $client->declineInvitationsAsync([/* ... */]);

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.

Declines invitations to become a Security Hub 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 Amazon Web Services organization should use this operation. Organization accounts don't receive invitations.

Parameter Syntax

$result = $client->declineInvitations([
    'AccountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
AccountIds
Required: Yes
Type: Array of strings

The list of prospective member account IDs for which to decline an invitation.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
Type: Array of Result structures

The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To decline invitation to become a member account

The following example declines an invitation from the Security Hub administrator account to become a member account. The invited account makes the request.

$result = $client->declineInvitations([
    'AccountIds' => [
        '123456789012',
        '111122223333',
    ],
]);

Result syntax:

[
    'UnprocessedAccounts' => [
    ],
]

DeleteActionTarget

$result = $client->deleteActionTarget([/* ... */]);
$promise = $client->deleteActionTargetAsync([/* ... */]);

Deletes a custom action target from Security Hub.

Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.

Parameter Syntax

$result = $client->deleteActionTarget([
    'ActionTargetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ActionTargetArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the custom action target to delete.

Result Syntax

[
    'ActionTargetArn' => '<string>',
]

Result Details

Members
ActionTargetArn
Required: Yes
Type: string

The ARN of the custom action target that was deleted.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To delete a custom action target

The following example deletes a custom action target that triggers target actions in Amazon CloudWatch Events. Deleting a custom action target doesn't affect findings or insights that were already sent to CloudWatch Events based on the custom action.

$result = $client->deleteActionTarget([
    'ActionTargetArn' => 'arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation',
]);

Result syntax:

[
    'ActionTargetArn' => 'arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation',
]

DeleteConfigurationPolicy

$result = $client->deleteConfigurationPolicy([/* ... */]);
$promise = $client->deleteConfigurationPolicyAsync([/* ... */]);

Deletes a configuration policy. Only the Security Hub 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.

Parameter Syntax

$result = $client->deleteConfigurationPolicy([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have permission to perform the action specified in the request.

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

ResourceConflictException:

The resource specified in the request conflicts with an existing resource.

Examples

Example 1: To delete a configuration policy

This operation deletes the specified configuration policy.

$result = $client->deleteConfigurationPolicy([
    'Identifier' => 'arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]);

DeleteFindingAggregator

$result = $client->deleteFindingAggregator([/* ... */]);
$promise = $client->deleteFindingAggregatorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteFindingAggregator([
    'FindingAggregatorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
FindingAggregatorArn
Required: Yes
Type: string

The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To delete a finding aggregator

The following example deletes a finding aggregator in Security Hub. Deleting the finding aggregator stops cross-Region aggregation. This operation produces no output.

$result = $client->deleteFindingAggregator([
    'FindingAggregatorArn' => 'arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]);

DeleteInsight

$result = $client->deleteInsight([/* ... */]);
$promise = $client->deleteInsightAsync([/* ... */]);

Deletes the insight specified by the InsightArn.

Parameter Syntax

$result = $client->deleteInsight([
    'InsightArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
InsightArn
Required: Yes
Type: string

The ARN of the insight to delete.

Result Syntax

[
    'InsightArn' => '<string>',
]

Result Details

Members
InsightArn
Required: Yes
Type: string

The ARN of the insight that was deleted.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To delete a custom insight

The following example deletes a custom insight in Security Hub.

$result = $client->deleteInsight([
    'InsightArn' => 'arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]);

Result syntax:

[
    'InsightArn' => 'arn:aws:securityhub:eu-central-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]

DeleteInvitations

$result = $client->deleteInvitations([/* ... */]);
$promise = $client->deleteInvitationsAsync([/* ... */]);

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.

Deletes invitations to become a Security Hub member account.

A Security Hub 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 Amazon Web Services organization. Organization accounts don't receive invitations.

Parameter Syntax

$result = $client->deleteInvitations([
    'AccountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
AccountIds
Required: Yes
Type: Array of strings

The list of member account IDs that received the invitations you want to delete.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
Type: Array of Result structures

The list of Amazon Web Services accounts for which the invitations were not deleted. For each account, the list includes the account ID and the email address.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

InvalidAccessException:

The account doesn't have permission to perform this action.

Examples

Example 1: To delete a custom insight

The following example deletes an invitation sent by the Security Hub administrator account to a prospective member account. This operation is used only for invitations sent to accounts that aren't part of an organization. Organization accounts don't receive invitations.

$result = $client->deleteInvitations([
    'AccountIds' => [
        '123456789012',
    ],
]);

Result syntax:

[
    'UnprocessedAccounts' => [
    ],
]

DeleteMembers

$result = $client->deleteMembers([/* ... */]);
$promise = $client->deleteMembersAsync([/* ... */]);

Deletes the specified member accounts from Security Hub.

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 Organizations organization.

Parameter Syntax

$result = $client->deleteMembers([
    'AccountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
AccountIds
Required: Yes
Type: Array of strings

The list of account IDs for the member accounts to delete.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
Type: Array of Result structures

The list of Amazon Web Services accounts that were not deleted. For each account, the list includes the account ID and the email address.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To delete a member account

The following example deletes the specified member account from Security Hub. This operation can be used to delete member accounts that are part of an organization or that were invited manually.

$result = $client->deleteMembers([
    'AccountIds' => [
        '123456789111',
        '123456789222',
    ],
]);

Result syntax:

[
    'UnprocessedAccounts' => [
    ],
]

DescribeActionTargets

$result = $client->describeActionTargets([/* ... */]);
$promise = $client->describeActionTargetsAsync([/* ... */]);

Returns a list of the custom action targets in Security Hub in your account.

Parameter Syntax

$result = $client->describeActionTargets([
    'ActionTargetArns' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ActionTargetArns
Type: Array of strings

A list of custom action target ARNs for the custom action targets to retrieve.

MaxResults
Type: int

The maximum number of results to return.

NextToken
Type: string

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.

Result Syntax

[
    'ActionTargets' => [
        [
            'ActionTargetArn' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ActionTargets
Required: Yes
Type: Array of ActionTarget structures

A list of ActionTarget objects. Each object includes the ActionTargetArn, Description, and Name of a custom action target available in Security Hub.

NextToken
Type: string

The pagination token to use to request the next page of results.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To return custom action targets

The following example returns a list of custom action targets. You use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

$result = $client->describeActionTargets([
    'ActionTargetArns' => [
        'arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation',
    ],
]);

Result syntax:

[
    'ActionTargets' => [
        [
            'ActionTargetArn' => 'arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation',
            'Description' => 'Action to send the finding for remediation tracking',
            'Name' => 'Send to remediation',
        ],
    ],
]

DescribeHub

$result = $client->describeHub([/* ... */]);
$promise = $client->describeHubAsync([/* ... */]);

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

Parameter Syntax

$result = $client->describeHub([
    'HubArn' => '<string>',
]);

Parameter Details

Members
HubArn
Type: string

The ARN of the Hub resource to retrieve.

Result Syntax

[
    'AutoEnableControls' => true || false,
    'ControlFindingGenerator' => 'STANDARD_CONTROL|SECURITY_CONTROL',
    'HubArn' => '<string>',
    'SubscribedAt' => '<string>',
]

Result Details

Members
AutoEnableControls
Type: boolean

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.

ControlFindingGenerator
Type: string

Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub 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 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 on or after February 23, 2023.

HubArn
Type: string

The ARN of the Hub resource that was retrieved.

SubscribedAt
Type: string

The date and time when Security Hub was enabled in the account.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To return details about Hub resource

The following example returns details about the Hub resource in the calling account. The Hub resource represents the implementation of the AWS Security Hub service in the calling account.

$result = $client->describeHub([
    'HubArn' => 'arn:aws:securityhub:us-west-1:123456789012:hub/default',
]);

Result syntax:

[
    'AutoEnableControls' => 1,
    'ControlFindingGenerator' => 'SECURITY_CONTROL',
    'HubArn' => 'arn:aws:securityhub:us-west-1:123456789012:hub/default',
    'SubscribedAt' => '2019-11-19T23:15:10.046Z',
]

DescribeOrganizationConfiguration

$result = $client->describeOrganizationConfiguration([/* ... */]);
$promise = $client->describeOrganizationConfigurationAsync([/* ... */]);

Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.

Parameter Syntax

$result = $client->describeOrganizationConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'AutoEnable' => true || false,
    'AutoEnableStandards' => 'NONE|DEFAULT',
    'MemberAccountLimitReached' => true || false,
    'OrganizationConfiguration' => [
        'ConfigurationType' => 'CENTRAL|LOCAL',
        'Status' => 'PENDING|ENABLED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members
AutoEnable
Type: boolean

Whether to automatically enable Security Hub in new member accounts when they join the organization.

If set to true, then Security Hub is automatically enabled in new accounts. If set to false, then Security Hub 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 is enabled and associate the policy with new organization accounts.

AutoEnableStandards
Type: string

Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.

If equal to DEFAULT, then Security Hub 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.

MemberAccountLimitReached
Type: boolean

Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.

OrganizationConfiguration
Type: OrganizationConfiguration structure

Provides information about the way an organization is configured in Security Hub.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

Examples

Example 1: To get information about organization configuration

This operation provides information about the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke this operation.

$result = $client->describeOrganizationConfiguration([
]);

Result syntax:

[
    'AutoEnable' => ,
    'AutoEnableStandards' => 'NONE',
    'MemberAccountLimitReached' => ,
    'OrganizationConfiguration' => [
        'ConfigurationType' => 'CENTRAL',
        'Status' => 'ENABLED',
    ],
]

DescribeProducts

$result = $client->describeProducts([/* ... */]);
$promise = $client->describeProductsAsync([/* ... */]);

Returns information about product integrations in Security Hub.

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.

Parameter Syntax

$result = $client->describeProducts([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProductArn' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return.

NextToken
Type: string

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
Type: string

The ARN of the integration to return.

Result Syntax

[
    'NextToken' => '<string>',
    'Products' => [
        [
            'ActivationUrl' => '<string>',
            'Categories' => ['<string>', ...],
            'CompanyName' => '<string>',
            'Description' => '<string>',
            'IntegrationTypes' => ['<string>', ...],
            'MarketplaceUrl' => '<string>',
            'ProductArn' => '<string>',
            'ProductName' => '<string>',
            'ProductSubscriptionResourcePolicy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token to use to request the next page of results.

Products
Required: Yes
Type: Array of Product structures

A list of products, including details for each product.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

Examples

Example 1: To get information about Security Hub integrations

The following example returns details about AWS services and third-party products that Security Hub integrates with.

$result = $client->describeProducts([
    'MaxResults' => 1,
    'NextToken' => 'NULL',
    'ProductArn' => 'arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon',
]);

Result syntax:

[
    'NextToken' => 'U2FsdGVkX18vvPlOqb7RDrWRWVFBJI46MOIAb+nZmRJmR15NoRi2gm13sdQEn3O/pq/78dGs+bKpgA+7HMPHO0qX33/zoRI+uIG/F9yLNhcOrOWzFUdy36JcXLQji3Rpnn/cD1SVkGA98qI3zPOSDg==',
    'Products' => [
        [
            'ActivationUrl' => 'https://falcon.crowdstrike.com/support/documentation',
            'Categories' => [
                'Endpoint Detection and Response (EDR)',
                'AV Scanning and Sandboxing',
                'Threat Intelligence Feeds and Reports',
                'Endpoint Forensics',
                'Network Forensics',
            ],
            'CompanyName' => 'CrowdStrike',
            'Description' => 'CrowdStrike Falcon's single lightweight sensor unifies next-gen antivirus, endpoint detection and response, and 24/7 managed hunting, via the cloud.',
            'IntegrationTypes' => [
                'SEND_FINDINGS_TO_SECURITY_HUB',
            ],
            'MarketplaceUrl' => 'https://aws.amazon.com/marketplace/seller-profile?id=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
            'ProductArn' => 'arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon',
            'ProductName' => 'CrowdStrike Falcon',
            'ProductSubscriptionResourcePolicy' => '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":"123456789333"},"Action":["securityhub:BatchImportFindings"],"Resource":"arn:aws:securityhub:us-west-1:123456789012:product-subscription/crowdstrike/crowdstrike-falcon","Condition":{"StringEquals":{"securityhub:TargetAccount":"123456789012"}}},{"Effect":"Allow","Principal":{"AWS":"123456789012"},"Action":["securityhub:BatchImportFindings"],"Resource":"arn:aws:securityhub:us-west-1:123456789333:product/crowdstrike/crowdstrike-falcon","Condition":{"StringEquals":{"securityhub:TargetAccount":"123456789012"}}}]}',
        ],
    ],
]

DescribeStandards

$result = $client->describeStandards([/* ... */]);
$promise = $client->describeStandardsAsync([/* ... */]);

Returns a list of the available standards in Security Hub.

For each standard, the results include the standard ARN, the name, and a description.

Parameter Syntax

$result = $client->describeStandards([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of standards to return.

NextToken
Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'Standards' => [
        [
            'Description' => '<string>',
            'EnabledByDefault' => true || false,
            'Name' => '<string>',
            'StandardsArn' => '<string>',
            'StandardsManagedBy' => [
                'Company' => '<string>',
                'Product' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token to use to request the next page of results.

Standards
Type: Array of Standard structures

A list of available standards.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

Examples

Example 1: To get available Security Hub standards

The following example returns a list of available security standards in Security Hub.

$result = $client->describeStandards([
]);

Result syntax:

[
    'Standards' => [
        [
            'Description' => 'The AWS Foundational Security Best Practices standard is a set of automated security checks that detect when AWS accounts and deployed resources do not align to security best practices. The standard is defined by AWS security experts. This curated set of controls helps improve your security posture in AWS, and cover AWS's most popular and foundational services.',
            'EnabledByDefault' => 1,
            'Name' => 'AWS Foundational Security Best Practices v1.0.0',
            'StandardsArn' => 'arn:aws:securityhub:us-west-1::standards/aws-foundational-security-best-practices/v/1.0.0',
        ],
        [
            'Description' => 'The Center for Internet Security (CIS) AWS Foundations Benchmark v1.2.0 is a set of security configuration best practices for AWS. This Security Hub standard automatically checks for your compliance readiness against a subset of CIS requirements.',
            'EnabledByDefault' => 1,
            'Name' => 'CIS AWS Foundations Benchmark v1.2.0',
            'StandardsArn' => 'arn:aws:securityhub:us-west-1::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
        ],
        [
            'Description' => 'The Center for Internet Security (CIS) AWS Foundations Benchmark v1.4.0 is a set of security configuration best practices for AWS. This Security Hub standard automatically checks for your compliance readiness against a subset of CIS requirements.',
            'EnabledByDefault' => ,
            'Name' => 'CIS AWS Foundations Benchmark v1.4.0',
            'StandardsArn' => 'arn:aws::securityhub:us-west-1::standards/cis-aws-foundations-benchmark/v/1.4.0',
        ],
        [
            'Description' => 'The Payment Card Industry Data Security Standard (PCI DSS) v3.2.1 is an information security standard for entities that store, process, and/or transmit cardholder data. This Security Hub standard automatically checks for your compliance readiness against a subset of PCI DSS requirements.',
            'EnabledByDefault' => ,
            'Name' => 'PCI DSS v3.2.1',
            'StandardsArn' => 'arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1',
        ],
    ],
]

DescribeStandardsControls

$result = $client->describeStandardsControls([/* ... */]);
$promise = $client->describeStandardsControlsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeStandardsControls([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StandardsSubscriptionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of security standard controls to return.

NextToken
Type: string

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
Required: Yes
Type: string

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.

Result Syntax

[
    'Controls' => [
        [
            'ControlId' => '<string>',
            'ControlStatus' => 'ENABLED|DISABLED',
            'ControlStatusUpdatedAt' => <DateTime>,
            'Description' => '<string>',
            'DisabledReason' => '<string>',
            'RelatedRequirements' => ['<string>', ...],
            'RemediationUrl' => '<string>',
            'SeverityRating' => 'LOW|MEDIUM|HIGH|CRITICAL',
            'StandardsControlArn' => '<string>',
            'Title' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Controls
Type: Array of StandardsControl structures

A list of security standards controls.

NextToken
Type: string

The pagination token to use to request the next page of results.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To get a list of controls for a security standard

The following example returns a list of security controls and control details that apply to a specified security standard. The list includes controls that are enabled and disabled in the standard.

$result = $client->describeStandardsControls([
    'MaxResults' => 2,
    'NextToken' => 'NULL',
    'StandardsSubscriptionArn' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1',
]);

Result syntax:

[
    'Controls' => [
        [
            'ControlId' => 'PCI.AutoScaling.1',
            'ControlStatus' => 'ENABLED',
            'ControlStatusUpdatedAt' => ,
            'Description' => 'This AWS control checks whether your Auto Scaling groups that are associated with a load balancer are using Elastic Load Balancing health checks.',
            'RelatedRequirements' => [
                'PCI DSS 2.2',
            ],
            'RemediationUrl' => 'https://docs.aws.amazon.com/console/securityhub/PCI.AutoScaling.1/remediation',
            'SeverityRating' => 'LOW',
            'StandardsControlArn' => 'arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.AutoScaling.1',
            'Title' => 'Auto scaling groups associated with a load balancer should use health checks',
        ],
        [
            'ControlId' => 'PCI.CW.1',
            'ControlStatus' => 'ENABLED',
            'ControlStatusUpdatedAt' => ,
            'Description' => 'This control checks for the CloudWatch metric filters using the following pattern { $.userIdentity.type = "Root" && $.userIdentity.invokedBy NOT EXISTS && $.eventType != "AwsServiceEvent" } It checks that the log group name is configured for use with active multi-region CloudTrail, that there is at least one Event Selector for a Trail with IncludeManagementEvents set to true and ReadWriteType set to All, and that there is at least one active subscriber to an SNS topic associated with the alarm.',
            'RelatedRequirements' => [
                'PCI DSS 7.2.1',
            ],
            'RemediationUrl' => 'https://docs.aws.amazon.com/console/securityhub/PCI.CW.1/remediation',
            'SeverityRating' => 'MEDIUM',
            'StandardsControlArn' => 'arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.CW.1',
            'Title' => 'A log metric filter and alarm should exist for usage of the "root" user',
        ],
    ],
    'NextToken' => 'U2FsdGVkX1+eNkPoZHVl11ip5HUYQPWSWZGmftcmJiHL8JoKEsCDuaKayiPDyLK+LiTkShveoOdvfxXCkOBaGhohIXhsIedN+LSjQV/l7kfCfJcq4PziNC1N9xe9aq2pjlLVZnznTfSImrodT5bRNHe4fELCQq/z+5ka+5Lzmc11axcwTd5lKgQyQqmUVoeriHZhyIiBgWKf7oNYdBVG8OEortVWvSkoUTt+B2ThcnC7l43kI0UNxlkZ6sc64AsW',
]

DisableImportFindingsForProduct

$result = $client->disableImportFindingsForProduct([/* ... */]);
$promise = $client->disableImportFindingsForProductAsync([/* ... */]);

Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.

Parameter Syntax

$result = $client->disableImportFindingsForProduct([
    'ProductSubscriptionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ProductSubscriptionArn
Required: Yes
Type: string

The ARN of the integrated product to disable the integration for.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

Examples

Example 1: To end a Security Hub integration

The following example ends an integration between Security Hub and the specified product that sends findings to Security Hub. After the integration ends, the product no longer sends findings to Security Hub.

$result = $client->disableImportFindingsForProduct([
    'ProductSubscriptionArn' => 'arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon',
]);

DisableOrganizationAdminAccount

$result = $client->disableOrganizationAdminAccount([/* ... */]);
$promise = $client->disableOrganizationAdminAccountAsync([/* ... */]);

Disables a Security Hub administrator account. Can only be called by the organization management account.

Parameter Syntax

$result = $client->disableOrganizationAdminAccount([
    'AdminAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AdminAccountId
Required: Yes
Type: string

The Amazon Web Services account identifier of the Security Hub administrator account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To remove a Security Hub administrator account

The following example removes the Security Hub administrator account in the Region from which the operation was executed. This operation doesn't remove the delegated administrator account in AWS Organizations.

$result = $client->disableOrganizationAdminAccount([
    'AdminAccountId' => '123456789012',
]);

DisableSecurityHub

$result = $client->disableSecurityHub([/* ... */]);
$promise = $client->disableSecurityHubAsync([/* ... */]);

Disables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.

You can't disable Security Hub in an account that is currently the Security Hub administrator.

When you disable Security Hub, your existing findings and insights and any Security Hub 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.

Parameter Syntax

$result = $client->disableSecurityHub([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To deactivate Security Hub

The following example deactivates Security Hub for the current account and Region.

$result = $client->disableSecurityHub([
]);

DisassociateFromAdministratorAccount

$result = $client->disassociateFromAdministratorAccount([/* ... */]);
$promise = $client->disassociateFromAdministratorAccountAsync([/* ... */]);

Disassociates the current Security Hub 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.

Parameter Syntax

$result = $client->disassociateFromAdministratorAccount([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To disassociate requesting account from administrator account

The following example dissociates the requesting account from its associated administrator account.

$result = $client->disassociateFromAdministratorAccount([
]);

DisassociateFromMasterAccount

$result = $client->disassociateFromMasterAccount([/* ... */]);
$promise = $client->disassociateFromMasterAccountAsync([/* ... */]);

This method is deprecated. Instead, use DisassociateFromAdministratorAccount.

The Security Hub 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 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.

Parameter Syntax

$result = $client->disassociateFromMasterAccount([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

DisassociateMembers

$result = $client->disassociateMembers([/* ... */]);
$promise = $client->disassociateMembersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateMembers([
    'AccountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
AccountIds
Required: Yes
Type: Array of strings

The account IDs of the member accounts to disassociate from the administrator account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To disassociate member accounts from administrator account

The following example dissociates the specified member accounts from the associated administrator account.

$result = $client->disassociateMembers([
    'AccountIds' => [
        '123456789012',
        '111122223333',
    ],
]);

EnableImportFindingsForProduct

$result = $client->enableImportFindingsForProduct([/* ... */]);
$promise = $client->enableImportFindingsForProductAsync([/* ... */]);

Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub.

When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.

Parameter Syntax

$result = $client->enableImportFindingsForProduct([
    'ProductArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ProductArn
Required: Yes
Type: string

The ARN of the product to enable the integration for.

Result Syntax

[
    'ProductSubscriptionArn' => '<string>',
]

Result Details

Members
ProductSubscriptionArn
Type: string

The ARN of your subscription to the product to enable integrations for.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceConflictException:

The resource specified in the request conflicts with an existing resource.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

Examples

Example 1: To activate an integration

The following example activates an integration between Security Hub and a third party partner product that sends findings to Security Hub.

$result = $client->enableImportFindingsForProduct([
    'ProductArn' => 'arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon',
]);

Result syntax:

[
    'ProductSubscriptionArn' => 'arn:aws:securityhub:us-east-1:517716713836:product-subscription/crowdstrike/crowdstrike-falcon',
]

EnableOrganizationAdminAccount

$result = $client->enableOrganizationAdminAccount([/* ... */]);
$promise = $client->enableOrganizationAdminAccountAsync([/* ... */]);

Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.

Parameter Syntax

$result = $client->enableOrganizationAdminAccount([
    'AdminAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AdminAccountId
Required: Yes
Type: string

The Amazon Web Services account identifier of the account to designate as the Security Hub administrator account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To designate a Security Hub administrator

The following example designates the specified account as the Security Hub administrator account. The requesting account must be the organization management account.

$result = $client->enableOrganizationAdminAccount([
    'AdminAccountId' => '123456789012',
]);

EnableSecurityHub

$result = $client->enableSecurityHub([/* ... */]);
$promise = $client->enableSecurityHubAsync([/* ... */]);

Enables Security Hub for your account in the current Region or the Region you specify in the request.

When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.

When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards:

  • Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0

  • Amazon Web Services 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, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.

To learn more, see the setup information in the Security Hub User Guide.

Parameter Syntax

$result = $client->enableSecurityHub([
    'ControlFindingGenerator' => 'STANDARD_CONTROL|SECURITY_CONTROL',
    'EnableDefaultStandards' => true || false,
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ControlFindingGenerator
Type: string

This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub 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 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 on or after February 23, 2023.

EnableDefaultStandards
Type: boolean

Whether to enable the security standards that Security Hub 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.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the hub resource when you enable Security Hub.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

ResourceConflictException:

The resource specified in the request conflicts with an existing resource.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To activate Security Hub

The following example activates the Security Hub service in the requesting AWS account. The service is activated in the current AWS Region or the Region that you specify in the request. Some standards are automatically turned on in your account unless you opt out. To determine which standards are automatically turned on, see the Security Hub documentation.

$result = $client->enableSecurityHub([
    'EnableDefaultStandards' => 1,
    'Tags' => [
        'Department' => 'Security',
    ],
]);

GetAdministratorAccount

$result = $client->getAdministratorAccount([/* ... */]);
$promise = $client->getAdministratorAccountAsync([/* ... */]);

Provides the details for the Security Hub 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.

Parameter Syntax

$result = $client->getAdministratorAccount([
]);

Parameter Details

Members

Result Syntax

[
    'Administrator' => [
        'AccountId' => '<string>',
        'InvitationId' => '<string>',
        'InvitedAt' => <DateTime>,
        'MemberStatus' => '<string>',
    ],
]

Result Details

Members
Administrator
Type: Invitation structure

Details about an invitation.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To get details about the Security Hub administrator account

The following example provides details about the Security Hub administrator account for the requesting member account.

$result = $client->getAdministratorAccount([
]);

Result syntax:

[
    'Administrator' => [
        'AccountId' => '123456789012',
        'InvitationId' => '7ab938c5d52d7904ad09f9e7c20cc4eb',
        'InvitedAt' => ,
        'MemberStatus' => 'ASSOCIATED',
    ],
]

GetConfigurationPolicy

$result = $client->getConfigurationPolicy([/* ... */]);
$promise = $client->getConfigurationPolicyAsync([/* ... */]);

Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.

Parameter Syntax

$result = $client->getConfigurationPolicy([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.

Result Syntax

[
    'Arn' => '<string>',
    'ConfigurationPolicy' => [
        'SecurityHub' => [
            'EnabledStandardIdentifiers' => ['<string>', ...],
            'SecurityControlsConfiguration' => [
                'DisabledSecurityControlIdentifiers' => ['<string>', ...],
                'EnabledSecurityControlIdentifiers' => ['<string>', ...],
                'SecurityControlCustomParameters' => [
                    [
                        'Parameters' => [
                            '<NonEmptyString>' => [
                                'Value' => [
                                    'Boolean' => true || false,
                                    'Double' => <float>,
                                    'Enum' => '<string>',
                                    'EnumList' => ['<string>', ...],
                                    'Integer' => <integer>,
                                    'IntegerList' => [<integer>, ...],
                                    'String' => '<string>',
                                    'StringList' => ['<string>', ...],
                                ],
                                'ValueType' => 'DEFAULT|CUSTOM',
                            ],
                            // ...
                        ],
                        'SecurityControlId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ServiceEnabled' => true || false,
        ],
    ],
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
Type: string

The ARN of the configuration policy.

ConfigurationPolicy
Type: Policy structure

An object that defines how Security Hub is configured. It includes whether Security Hub 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 disables all other controls (including newly released controls). If the policy includes a list of security controls that are disabled, Security Hub enables all other controls (including newly released controls).

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time, in UTC and ISO 8601 format, that the configuration policy was created.

Description
Type: string

The description of the configuration policy.

Id
Type: string

The UUID of the configuration policy.

Name
Type: string

The name of the configuration policy.

UpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.

Errors

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To get details about a configuration policy

This operation provides details about the specified configuration policy.

$result = $client->getConfigurationPolicy([
    'Identifier' => 'arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]);

Result syntax:

[
    'Arn' => 'arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'ConfigurationPolicy' => [
        'SecurityHub' => [
            'EnabledStandardIdentifiers' => [
                'arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0',
                'arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0',
            ],
            'SecurityControlsConfiguration' => [
                'DisabledSecurityControlIdentifiers' => [
                    'CloudWatch.1',
                ],
                'SecurityControlCustomParameters' => [
                    [
                        'Parameters' => [
                            'daysToExpiration' => [
                                'Value' => [
                                    'Integer' => 14,
                                ],
                                'ValueType' => 'CUSTOM',
                            ],
                        ],
                        'SecurityControlId' => 'ACM.1',
                    ],
                ],
            ],
            'ServiceEnabled' => 1,
        ],
    ],
    'CreatedAt' => ,
    'Description' => 'Configuration policy for testing FSBP and CIS',
    'Id' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'Name' => 'TestConfigurationPolicy',
    'UpdatedAt' => ,
]

GetConfigurationPolicyAssociation

$result = $client->getConfigurationPolicyAssociation([/* ... */]);
$promise = $client->getConfigurationPolicyAssociationAsync([/* ... */]);

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 Security Hub delegated administrator can invoke this operation from the home Region.

Parameter Syntax

$result = $client->getConfigurationPolicyAssociation([
    'Target' => [ // REQUIRED
        'AccountId' => '<string>',
        'OrganizationalUnitId' => '<string>',
        'RootId' => '<string>',
    ],
]);

Parameter Details

Members
Target
Required: Yes
Type: Target structure

The target account ID, organizational unit ID, or the root ID to retrieve the association for.

Result Syntax

[
    'AssociationStatus' => 'PENDING|SUCCESS|FAILED',
    'AssociationStatusMessage' => '<string>',
    'AssociationType' => 'INHERITED|APPLIED',
    'ConfigurationPolicyId' => '<string>',
    'TargetId' => '<string>',
    'TargetType' => 'ACCOUNT|ORGANIZATIONAL_UNIT|ROOT',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
AssociationStatus
Type: string

The current status of the association between the specified target and the configuration.

AssociationStatusMessage
Type: string

The explanation for a FAILED value for AssociationStatus.

AssociationType
Type: string

Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent.

ConfigurationPolicyId
Type: string

The universally unique identifier (UUID) of a configuration policy. For self-managed behavior, the value is SELF_MANAGED_SECURITY_HUB.

TargetId
Type: string

The target account ID, organizational unit ID, or the root ID for which the association is retrieved.

TargetType
Type: string

Specifies whether the target is an Amazon Web Services account, organizational unit, or the organization root.

UpdatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.

Errors

InternalException:

Internal server error.

InvalidAccessException:

The account doesn't have permission to perform this action.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

Examples

Example 1: To get details about a configuration association

This operation provides details about configuration associations for a specific target account, organizational unit, or the root.

$result = $client->getConfigurationPolicyAssociation([
    'Target' => [
        'AccountId' => '111122223333',
    ],
]);

Result syntax:

[
    'AssociationStatus' => 'FAILED',
    'AssociationStatusMessage' => 'Configuration Policy a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 couldn’t be applied to account 111122223333 in us-east-1 Region. Retry your request.',
    'AssociationType' => 'INHERITED',
    'ConfigurationPolicyId' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'TargetId' => '111122223333',
    'TargetType' => 'ACCOUNT',
    'UpdatedAt' => ,
]

GetEnabledStandards

$result = $client->getEnabledStandards([/* ... */]);
$promise = $client->getEnabledStandardsAsync([/* ... */]);

Returns a list of the standards that are currently enabled.

Parameter Syntax

$result = $client->getEnabledStandards([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StandardsSubscriptionArns' => ['<string>', ...],
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in the response.

NextToken
Type: string

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.

StandardsSubscriptionArns
Type: Array of strings

The list of the standards subscription ARNs for the standards to retrieve.

Result Syntax

[
    'NextToken' => '<string>',
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => '<string>',
            'StandardsInput' => ['<string>', ...],
            'StandardsStatus' => 'PENDING|READY|FAILED|DELETING|INCOMPLETE',
            'StandardsStatusReason' => [
                'StatusReasonCode' => 'NO_AVAILABLE_CONFIGURATION_RECORDER|INTERNAL_ERROR',
            ],
            'StandardsSubscriptionArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token to use to request the next page of results.

StandardsSubscriptions
Type: Array of StandardsSubscription structures

The list of StandardsSubscriptions objects that include information about the enabled standards.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

Examples

Example 1: To return a list of enabled standards

The following example returns a list of Security Hub standards that are currently enabled in your account.

$result = $client->getEnabledStandards([
    'StandardsSubscriptionArns' => [
        'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1',
    ],
]);

Result syntax:

[
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => 'arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1',
            'StandardsInput' => [
            ],
            'StandardsStatus' => 'READY',
            'StandardsSubscriptionArn' => 'arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1',
        ],
    ],
]

GetFindingAggregator

$result = $client->getFindingAggregator([/* ... */]);
$promise = $client->getFindingAggregatorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getFindingAggregator([
    'FindingAggregatorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
FindingAggregatorArn
Required: Yes
Type: string

The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.

Result Syntax

[
    'FindingAggregationRegion' => '<string>',
    'FindingAggregatorArn' => '<string>',
    'RegionLinkingMode' => '<string>',
    'Regions' => ['<string>', ...],
]

Result Details

Members
FindingAggregationRegion
Type: string

The home Region. Findings generated in linked Regions are replicated and sent to the home Region.

FindingAggregatorArn
Type: string

The ARN of the finding aggregator.

RegionLinkingMode
Type: string

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

Regions
Type: Array of strings

The list of excluded Regions or included Regions.

Errors

InternalException:

Internal server error.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

InvalidAccessException:

The account doesn't have permission to perform this action.

AccessDeniedException:

You don't have permission to perform the action specified in the request.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

ResourceNotFoundException:

The request was rejected because we can't find the specified resource.

Examples

Example 1: To get cross-Region aggregation details

The following example returns cross-Region aggregation details for the requesting account.

$result = $client->getFindingAggregator([
    'FindingAggregatorArn' => 'arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
]);

Result syntax:

[
    'FindingAggregationRegion' => 'us-east-1',
    'FindingAggregatorArn' => 'arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'RegionLinkingMode' => 'SPECIFIED_REGIONS',
    'Regions' => [
        'us-west-1',
        'us-west-2',
    ],
]

GetFindingHistory

$result = $client->getFindingHistory([/* ... */]);
$promise = $client->getFindingHistoryAsync([/* ... */]);

Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).

Parameter Syntax

$result = $client->getFindingHistory([
    'EndTime' => <integer || string || DateTime>,
    'FindingIdentifier' => [ // REQUIRED
        'Id' => '<string>', // REQUIRED
        'ProductArn' => '<string>', // REQUIRED
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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 returns finding history for the specified time period. If you provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at which the API is called. If you provide a value for EndTime but not for StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you provide neither StartTime nor EndTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is limited to 90 days.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

FindingIdentifier
Required: Yes
Type: AwsSecurityFindingIdentifier structure

Identifies which finding to get the finding history for.

MaxResults
Type: int

The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.

NextToken
Type: string

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 returns up to 100 results of finding history for each request.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp that indicates the start time of the requested finding history.

If you provide values for both StartTime and EndTime, Security Hub returns finding history for the specified time period. If you provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at which the API is called. If you provide a value for EndTime but not for StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you provide neither StartTime nor EndTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is limited to 90 days.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Result Syntax

[
    'NextToken' => '<string>',
    'Records' => [
        [
            'FindingCreated' => true || false,
            'FindingIdentifier' => [
                'Id' => '<string>',
                'ProductArn' => '<string>',
            ],
            'NextToken' => '<string>',
            'UpdateSource' => [
                'Identity' => '<string>',
                'Type' => 'BATCH_UPDATE_FINDINGS|BATCH_IMPORT_FINDINGS',
            ],
            'UpdateTime' => <DateTime>,
            'Updates' => [
                [
                    'NewValue' => '<string>',
                    'OldValue' => '<string>',
                    'UpdatedField' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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.

Records
Type: Array of FindingHistoryRecord structures

A list of events that altered the specified finding during the specified time period.

Errors

InternalException:

Internal server error.

InvalidInputException:

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

InvalidAccessException:

The account doesn't have permission to perform this action.

LimitExceededException:

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

Examples

Example 1: To get finding history

The following example retrieves the history of the specified finding during the specified time frame. If the time frame permits, Security Hub returns finding history for the last 90 days.

$result = $client->getFindingHistory([
    'EndTime' => ,
    'FindingIdentifier' => [
        'Id' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'ProductArn' => 'arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default',
    ],
    'MaxResults' => 2,
    'StartTime' => ,
]);

Result syntax:

[
    'Records' => [
        [
            'FindingCreated' => ,
            'FindingIdentifier' => [
                'Id' => 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
                'ProductArn' => 'arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default',
            ],
            'UpdateSource' => [
                'Identity' => 'arn:aws:iam::444455556666:role/Admin',
                'Type' => 'BATCH_UPDATE_FINDINGS',
            ],
            'UpdateTime' => ,
            'Updates' => [
                [
                    'NewValue' => 'MEDIUM',
                    'OldValue' => 'HIGH',
                    'UpdatedField' => 'Severity',
                ],
            ],
        ],
    ],
]

GetFindings

$result = $client->getFindings([/* ... */]);
$promise = $client->getFindingsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getFindings([
    'Filters' => [
        'AwsAccountId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'AwsAccountName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CompanyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceAssociatedStandardsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceSecurityControlId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceSecurityControlParametersName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceSecurityControlParametersValue' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Confidence' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'CreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'Criticality' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'Description' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsConfidence' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'FindingProviderFieldsCriticality' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'FindingProviderFieldsRelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsRelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsSeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsSeverityOriginal' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FindingProviderFieldsTypes' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FirstObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'GeneratorId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Id' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Keyword' => [
            [
                'Value' => '<string>',
            ],
            // ...
        ],
        'LastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'MalwareName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwarePath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationPort' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NetworkDirection' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkProtocol' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceMac' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourcePort' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NoteText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedBy' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProcessName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessParentPid' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessPath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessPid' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessTerminatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecommendationText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Region' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceApplicationArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceApplicationName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV4Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV6Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceKeyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceSubnetId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceVpcId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyCreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyPrincipalName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyUserName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamUserUserName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceDetailsOther' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourcePartition' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceRegion' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceTags' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Sample' => [
            [
                'Value' => true || false,
            ],
            // ...
        ],
        'SeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityNormalized' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SeverityProduct' => [
            [
                'Eq' => <float>,
                'Gt' => <float>,
                'Gte' => <float>,
                'Lt' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorCategory' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorLastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSource' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorValue' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Title' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'UserDefinedFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VerificationState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VulnerabilitiesExploitAvailable' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VulnerabilitiesFixAvailable' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS|CONTAINS|NOT_CONTAINS',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortCriteria' => [
        [
            'Field' => '<string>',
            'SortOrder' => 'asc|desc',
        ],
        // ...
    ],
]);

Parameter Details

Members
Filters
Type: AwsSecurityFindingFilters structure

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.

MaxResults
Type: int

The maximum number of findings to return.

NextToken
Type: string

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.

SortCriteria
Type: Array of SortCriterion structures

The finding attributes used to sort the list of returned findings.

Result Syntax

[
    'Findings' => [
        [
            'Action' => [
                'ActionType' => '<string>',
                'AwsApiCallAction' => [
                    'AffectedResources' => ['<string>', ...],
                    'Api' => '<string>',
                    'CallerType' => '<string>',
                    'DomainDetails' => [
                        'Domain' => '<string>',
                    ],
                    'FirstSeen' => '<string>',
                    'LastSeen' => '<string>',
                    'RemoteIpDetails' => [
                        'City' => [
                            'CityName' => '<string>',
                        ],
                        'Country' => [
                            'CountryCode' => '<string>',
                            'CountryName' => '<string>',
                        ],
                        'GeoLocation' => [
                            'Lat' => <float>,
                            'Lon' => <float>,
                        ],
                        'IpAddressV4' => '<string>',
                        'Organization' => [
                            'Asn' => <integer>,
                            'AsnOrg' => '<string>',
                            'Isp' => '<string>',
                            'Org' => '<string>',
                        ],
                    ],
                    'ServiceName' => '<string>',
                ],
                'DnsRequestAction' => [
                    'Blocked' => true || false,
                    'Domain' => '<string>',
                    'Protocol' => '<string>',
                ],
                'NetworkConnectionAction' => [
                    'Blocked' => true || false,
                    'ConnectionDirection' => '<string>',
                    'LocalPortDetails' => [
                        'Port' => <integer>,
                        'PortName' => '<string>',
                    ],
                    'Protocol' => '<string>',
                    'RemoteIpDetails' => [
                        'City' => [
                            'CityName' => '<string>',
                        ],
                        'Country' => [
                            'CountryCode' => '<string>',
                            'CountryName' => '<string>',
                        ],
                        'GeoLocation' => [
                            'Lat' => <float>,
                            'Lon' => <float>,
                        ],
                        'IpAddressV4' => '<string>',
                        'Organization' => [
                            'Asn' => <integer>,
                            'AsnOrg' => '<string>',
                            'Isp' => '<string>',
                            'Org' => '<string>',
                        ],
                    ],
                    'RemotePortDetails' => [
                        'Port' => <integer>,
                        'PortName' => '<string>',
                    ],
                ],
                'PortProbeAction' => [
                    'Blocked' => true || false,
                    'PortProbeDetails' => [
                        [
                            'LocalIpDetails' => [
                                'IpAddressV4' => '<string>',
                            ],
                            'LocalPortDetails' => [
                                'Port' => <integer>,
                                'PortName' => '<string>',
                            ],
                            'RemoteIpDetails' => [
                                'City' => [
                                    'CityName' => '<string>',
                                ],
                                'Country' => [
                                    'CountryCode' => '<string>',
                                    'CountryName' => '<string>',
                                ],
                                'GeoLocation' => [
                                    'Lat' => <float>,
                                    'Lon' => <float>,
                                ],
                                'IpAddressV4' => '<string>',
                                'Organization' => [
                                    'Asn' => <integer>,
                                    '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' => 'PASSED|WARNING|FAILED|NOT_AVAILABLE',
                'StatusReasons' => [
                    [
                        'Description' => '<string>',
                        'ReasonCode' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Confidence' => <integer>,
            'CreatedAt' => '<string>',
            'Criticality' => <integer>,
            'Description' => '<string>',
            'FindingProviderFields' => [
                'Confidence' => <integer>,
                'Criticality' => <integer>,
                'RelatedFindings' => [
                    [
                        'Id' => '<string>',
                        'ProductArn' => '<string>',
                    ],
                    // ...
                ],
                'Severity' => [
                    'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
                    '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' => 'OBSERVED|REMOVAL_FAILED|REMOVED',
                    'Type' => 'ADWARE|BLENDED_THREAT|BOTNET_AGENT|COIN_MINER|EXPLOIT_KIT|KEYLOGGER|MACRO|POTENTIALLY_UNWANTED|SPYWARE|RANSOMWARE|REMOTE_ACCESS|ROOTKIT|TROJAN|VIRUS|WORM',
                ],
                // ...
            ],
            'Network' => [
                'DestinationDomain' => '<string>',
                'DestinationIpV4' => '<string>',
                'DestinationIpV6' => '<string>',
                'DestinationPort' => <integer>,
                'Direction' => 'IN|OUT',
                'OpenPortRange' => [
                    'Begin' => <integer>,
                    'End' => <integer>,
                ],
                'Protocol' => '<string>',
                'SourceDomain' => '<string>',
                'SourceIpV4' => '<string>',
                'SourceIpV6' => '<string>',
                'SourceMac' => '<string>',
                'SourcePort' => <integer>,
            ],
            'NetworkPath' => [
                [
                    'ComponentId' => '<string>',
                    'ComponentType' => '<string>',
                    'Egress' => [
                        'Destination' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'Protocol' => '<string>',
                        'Source' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Ingress' => [
                        'Destination' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'Protocol' => '<string>',
                        'Source' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'Note' => [
                'Text' => '<string>',
                'UpdatedAt' => '<string>',
                'UpdatedBy' => '<string>',
            ],
            'PatchSummary' => [
                'FailedCount' => <integer>,
                'Id' => '<string>',
                'InstalledCount' => <integer>,
                'InstalledOtherCount' => <integer>,
                'InstalledPendingReboot' => <integer>,
                'InstalledRejectedCount' => <integer>,
                'MissingCount' => <integer>,
                'Operation' => '<string>',
                'OperationEndTime' => '<string>',
                'OperationStartTime' => '<string>',
                'RebootOption' => '<string>',
            ],
            'Process' => [
                'LaunchedAt' => '<string>',
                'Name' => '<string>',
                'ParentPid' => <integer>,
                'Path' => '<string>',
                'Pid' => <integer>,
                'TerminatedAt' => '<string>',
            ],
            'ProcessedAt' => '<string>',
            'ProductArn' => '<string>',
            'ProductFields' => ['<string>', ...],
            'ProductName' => '<string>',
            'RecordState' => 'ACTIVE|ARCHIVED',
            'Region' => '<string>',
            'RelatedFindings' => [
                [
                    'Id' => '<string>',
                    'ProductArn' => '<string>',
                ],
                // ...
            ],
            'Remediation' => [
                'Recommendation' => [
                    'Text' => '<string>',
                    'Url' => '<string>',
                ],
            ],
            'Resources' => [
                [
                    'ApplicationArn' => '<string>',
                    'ApplicationName' => '<string>',
                    'DataClassification' => [
                        'DetailedResultsLocation' => '<string>',
                        'Result' => [
                            'AdditionalOccurrences' => true || false,
                            'CustomDataIdentifiers' => [
                                'Detections' => [
                                    [
                                        'Arn' => '<string>',
                                        'Count' => <integer>,
                                        'Name' => '<string>',
                                        'Occurrences' => [
                                            'Cells' => [
                                                [
                                                    'CellReference' => '<string>',
                                                    'Column' => <integer>,
                                                    'ColumnName' => '<string>',
                                                    'Row' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'LineRanges' => [
                                                [
                                                    'End' => <integer>,
                                                    'Start' => <integer>,
                                                    'StartColumn' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'OffsetRanges' => [
                                                [
                                                    'End' => <integer>,
                                                    'Start' => <integer>,
                                                    'StartColumn' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'Pages' => [
                                                [
                                                    'LineRange' => [
                                                        'End' => <integer>,
                                                        'Start' => <integer>,
                                                        'StartColumn' => <integer>,
                                                    ],
                                                    'OffsetRange' => [
                                                        'End' => <integer>,
                                                        'Start' => <integer>,
                                                        'StartColumn' => <integer>,
                                                    ],
                                                    'PageNumber' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'Records' => [
                                                [
                                                    'JsonPath' => '<string>',
                                                    'RecordIndex' => <integer>,
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    // ...
                                ],
                                'TotalCount' => <integer>,
                            ],
                            'MimeType' => '<string>',
                            'SensitiveData' => [
                                [
                                    'Category' => '<string>',
                                    'Detections' => [
                                        [
                                            'Count' => <integer>,
                                            'Occurrences' => [
                                                'Cells' => [
                                                    [
                                                        'CellReference' => '<string>',
                                                        'Column' => <integer>,
                                                        'ColumnName' => '<string>',
                                                        'Row' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                                'LineRanges' => [
                                                    [
                                                        'End' => <integer>,
                                                        'Start' => <integer>,
                                                        'StartColumn' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                                'OffsetRanges' => [
                                                    [
                                                        'End' => <integer>,
                                                        'Start' => <integer>,
                                                        'StartColumn' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                                'Pages' => [
                                                    [
                                                        'LineRange' => [
                                                            'End' => <integer>,
                                                            'Start' => <integer>,
                                                            'StartColumn' => <integer>,
                                                        ],
                                                        'OffsetRange' => [
                                                            'End' => <integer>,
                                                            'Start' => <integer>,
                                                            'StartColumn' => <integer>,
                                                        ],
                                                        'PageNumber' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                                'Records' => [
                                                    [
                                                        'JsonPath' => '<string>',
                                                        'RecordIndex' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                            'Type' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'TotalCount' => <integer>,
                                ],
                                // ...
                            ],
                            'SizeClassified' => <integer>,
                            'Status' => [
                                'Code' => '<string>',
                                'Reason' => '<string>',
                            ],
                        ],
                    ],
                    'Details' => [
                        'AwsAmazonMqBroker' => [
                            'AuthenticationStrategy' => '<string>',
                            'AutoMinorVersionUpgrade' => true || false,
                            'BrokerArn' => '<string>',
                            'BrokerId' => '<string>',
                            'BrokerName' => '<string>',
                            'DeploymentMode' => '<string>',
                            'EncryptionOptions' => [
                                'KmsKeyId' => '<string>',
                                'UseAwsOwnedKey' => true || false,
                            ],
                            'EngineType' => '<string>',
                            'EngineVersion' => '<string>',
                            'HostInstanceType' => '<string>',
                            'LdapServerMetadata' => [
                                'Hosts' => ['<string>', ...],
                                'RoleBase' => '<string>',
                                'RoleName' => '<string>',
                                'RoleSearchMatching' => '<string>',
                                'RoleSearchSubtree' => true || false,
                                'ServiceAccountUsername' => '<string>',
                                'UserBase' => '<string>',
                                'UserRoleName' => '<string>',
                                'UserSearchMatching' => '<string>',
                                'UserSearchSubtree' => true || false,
                            ],
                            'Logs' => [
                                'Audit' => true || false,
                                'AuditLogGroup' => '<string>',
                                'General' => true || false,
                                'GeneralLogGroup' => '<string>',
                                'Pending' => [
                                    'Audit' => true || false,
                                    'General' => true || false,
                                ],
                            ],
                            'MaintenanceWindowStartTime' => [
                                'DayOfWeek' => '<string>',
                                'TimeOfDay' => '<string>',
                                'TimeZone' => '<string>',
                            ],
                            'PubliclyAccessible' => true || false,
                            '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' => <integer>,
                            'Name' => '<string>',
                            'Version' => '<string>',
                        ],
                        'AwsApiGatewayStage' => [
                            'AccessLogSettings' => [
                                'DestinationArn' => '<string>',
                                'Format' => '<string>',
                            ],
                            'CacheClusterEnabled' => true || false,
                            'CacheClusterSize' => '<string>',
                            'CacheClusterStatus' => '<string>',
                            'CanarySettings' => [
                                'DeploymentId' => '<string>',
                                'PercentTraffic' => <float>,
                                'StageVariableOverrides' => ['<string>', ...],
                                'UseStageCache' => true || false,
                            ],
                            'ClientCertificateId' => '<string>',
                            'CreatedDate' => '<string>',
                            'DeploymentId' => '<string>',
                            'Description' => '<string>',
                            'DocumentationVersion' => '<string>',
                            'LastUpdatedDate' => '<string>',
                            'MethodSettings' => [
                                [
                                    'CacheDataEncrypted' => true || false,
                                    'CacheTtlInSeconds' => <integer>,
                                    'CachingEnabled' => true || false,
                                    'DataTraceEnabled' => true || false,
                                    'HttpMethod' => '<string>',
                                    'LoggingLevel' => '<string>',
                                    'MetricsEnabled' => true || false,
                                    'RequireAuthorizationForCacheControl' => true || false,
                                    'ResourcePath' => '<string>',
                                    'ThrottlingBurstLimit' => <integer>,
                                    'ThrottlingRateLimit' => <float>,
                                    'UnauthorizedCacheControlHeaderStrategy' => '<string>',
                                ],
                                // ...
                            ],
                            'StageName' => '<string>',
                            'TracingEnabled' => true || false,
                            'Variables' => ['<string>', ...],
                            'WebAclArn' => '<string>',
                        ],
                        'AwsApiGatewayV2Api' => [
                            'ApiEndpoint' => '<string>',
                            'ApiId' => '<string>',
                            'ApiKeySelectionExpression' => '<string>',
                            'CorsConfiguration' => [
                                'AllowCredentials' => true || false,
                                'AllowHeaders' => ['<string>', ...],
                                'AllowMethods' => ['<string>', ...],
                                'AllowOrigins' => ['<string>', ...],
                                'ExposeHeaders' => ['<string>', ...],
                                'MaxAge' => <integer>,
                            ],
                            'CreatedDate' => '<string>',
                            'Description' => '<string>',
                            'Name' => '<string>',
                            'ProtocolType' => '<string>',
                            'RouteSelectionExpression' => '<string>',
                            'Version' => '<string>',
                        ],
                        'AwsApiGatewayV2Stage' => [
                            'AccessLogSettings' => [
                                'DestinationArn' => '<string>',
                                'Format' => '<string>',
                            ],
                            'ApiGatewayManaged' => true || false,
                            'AutoDeploy' => true || false,
                            'ClientCertificateId' => '<string>',
                            'CreatedDate' => '<string>',
                            'DefaultRouteSettings' => [
                                'DataTraceEnabled' => true || false,
                                'DetailedMetricsEnabled' => true || false,
                                'LoggingLevel' => '<string>',
                                'ThrottlingBurstLimit' => <integer>,
                                'ThrottlingRateLimit' => <float>,
                            ],
                            'DeploymentId' => '<string>',
                            'Description' => '<string>',
                            'LastDeploymentStatusMessage' => '<string>',
                            'LastUpdatedDate' => '<string>',
                            'RouteSettings' => [
                                'DataTraceEnabled' => true || false,
                                'DetailedMetricsEnabled' => true || false,
                                'LoggingLevel' => '<string>',
                                'ThrottlingBurstLimit' => <integer>,
                                'ThrottlingRateLimit' => <float>,
                            ],
                            'StageName' => '<string>',
                            'StageVariables' => ['<string>', ...],
                        ],
                        'AwsAppSyncGraphQlApi' => [
                            'AdditionalAuthenticationProviders' => [
                                [
                                    'AuthenticationType' => '<string>',
                                    'LambdaAuthorizerConfig' => [
                                        'AuthorizerResultTtlInSeconds' => <integer>,
                                        'AuthorizerUri' => '<string>',
                                        'IdentityValidationExpression' => '<string>',
                                    ],
                                    'OpenIdConnectConfig' => [
                                        'AuthTtL' => <integer>,
                                        'ClientId' => '<string>',
                                        'IatTtL' => <integer>,
                                        'Issuer' => '<string>',
                                    ],
                                    'UserPoolConfig' => [
                                        'AppIdClientRegex' => '<string>',
                                        'AwsRegion' => '<string>',
                                        'DefaultAction' => '<string>',
                                        'UserPoolId' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'ApiId' => '<string>',
                            'Arn' => '<string>',
                            'AuthenticationType' => '<string>',
                            'Id' => '<string>',
                            'LambdaAuthorizerConfig' => [
                                'AuthorizerResultTtlInSeconds' => <integer>,
                                'AuthorizerUri' => '<string>',
                                'IdentityValidationExpression' => '<string>',
                            ],
                            'LogConfig' => [
                                'CloudWatchLogsRoleArn' => '<string>',
                                'ExcludeVerboseContent' => true || false,
                                'FieldLogLevel' => '<string>',
                            ],
                            'Name' => '<string>',
                            'OpenIdConnectConfig' => [
                                'AuthTtL' => <integer>,
                                'ClientId' => '<string>',
                                'IatTtL' => <integer>,
                                'Issuer' => '<string>',
                            ],
                            'UserPoolConfig' => [
                                'AppIdClientRegex' => '<string>',
                                'AwsRegion' => '<string>',
                                'DefaultAction' => '<string>',
                                'UserPoolId' => '<string>',
                            ],
                            'WafWebAclArn' => '<string>',
                            'XrayEnabled' => true || false,
                        ],
                        'AwsAthenaWorkGroup' => [
                            'Configuration' => [
                                'ResultConfiguration' => [
                                    'EncryptionConfiguration' => [
                                        'EncryptionOption' => '<string>',
                                        'KmsKey' => '<string>',
                                    ],
                                ],
                            ],
                            'Description' => '<string>',
                            'Name' => '<string>',
                            'State' => '<string>',
                        ],
                        'AwsAutoScalingAutoScalingGroup' => [
                            'AvailabilityZones' => [
                                [
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'CapacityRebalance' => true || false,
                            'CreatedTime' => '<string>',
                            'HealthCheckGracePeriod' => <integer>,
                            'HealthCheckType' => '<string>',
                            'LaunchConfigurationName' => '<string>',
                            'LaunchTemplate' => [
                                'LaunchTemplateId' => '<string>',
                                'LaunchTemplateName' => '<string>',
                                'Version' => '<string>',
                            ],
                            'LoadBalancerNames' => ['<string>', ...],
                            'MixedInstancesPolicy' => [
                                'InstancesDistribution' => [
                                    'OnDemandAllocationStrategy' => '<string>',
                                    'OnDemandBaseCapacity' => <integer>,
                                    'OnDemandPercentageAboveBaseCapacity' => <integer>,
                                    'SpotAllocationStrategy' => '<string>',
                                    'SpotInstancePools' => <integer>,
                                    'SpotMaxPrice' => '<string>',
                                ],
                                'LaunchTemplate' => [
                                    'LaunchTemplateSpecification' => [
                                        'LaunchTemplateId' => '<string>',
                                        'LaunchTemplateName' => '<string>',
                                        'Version' => '<string>',
                                    ],
                                    'Overrides' => [
                                        [
                                            'InstanceType' => '<string>',
                                            'WeightedCapacity' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                        ],
                        'AwsAutoScalingLaunchConfiguration' => [
                            'AssociatePublicIpAddress' => true || false,
                            'BlockDeviceMappings' => [
                                [
                                    'DeviceName' => '<string>',
                                    'Ebs' => [
                                        'DeleteOnTermination' => true || false,
                                        'Encrypted' => true || false,
                                        'Iops' => <integer>,
                                        'SnapshotId' => '<string>',
                                        'VolumeSize' => <integer>,
                                        'VolumeType' => '<string>',
                                    ],
                                    'NoDevice' => true || false,
                                    'VirtualName' => '<string>',
                                ],
                                // ...
                            ],
                            'ClassicLinkVpcId' => '<string>',
                            'ClassicLinkVpcSecurityGroups' => ['<string>', ...],
                            'CreatedTime' => '<string>',
                            'EbsOptimized' => true || false,
                            'IamInstanceProfile' => '<string>',
                            'ImageId' => '<string>',
                            'InstanceMonitoring' => [
                                'Enabled' => true || false,
                            ],
                            'InstanceType' => '<string>',
                            'KernelId' => '<string>',
                            'KeyName' => '<string>',
                            'LaunchConfigurationName' => '<string>',
                            'MetadataOptions' => [
                                'HttpEndpoint' => '<string>',
                                'HttpPutResponseHopLimit' => <integer>,
                                'HttpTokens' => '<string>',
                            ],
                            'PlacementTenancy' => '<string>',
                            'RamdiskId' => '<string>',
                            'SecurityGroups' => ['<string>', ...],
                            'SpotPrice' => '<string>',
                            'UserData' => '<string>',
                        ],
                        'AwsBackupBackupPlan' => [
                            'BackupPlan' => [
                                'AdvancedBackupSettings' => [
                                    [
                                        'BackupOptions' => ['<string>', ...],
                                        'ResourceType' => '<string>',
                                    ],
                                    // ...
                                ],
                                'BackupPlanName' => '<string>',
                                'BackupPlanRule' => [
                                    [
                                        'CompletionWindowMinutes' => <integer>,
                                        'CopyActions' => [
                                            [
                                                'DestinationBackupVaultArn' => '<string>',
                                                'Lifecycle' => [
                                                    'DeleteAfterDays' => <integer>,
                                                    'MoveToColdStorageAfterDays' => <integer>,
                                                ],
                                            ],
                                            // ...
                                        ],
                                        'EnableContinuousBackup' => true || false,
                                        'Lifecycle' => [
                                            'DeleteAfterDays' => <integer>,
                                            'MoveToColdStorageAfterDays' => <integer>,
                                        ],
                                        'RuleId' => '<string>',
                                        'RuleName' => '<string>',
                                        'ScheduleExpression' => '<string>',
                                        'StartWindowMinutes' => <integer>,
                                        'TargetBackupVault' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'BackupPlanArn' => '<string>',
                            'BackupPlanId' => '<string>',
                            'VersionId' => '<string>',
                        ],
                        'AwsBackupBackupVault' => [
                            'AccessPolicy' => '<string>',
                            'BackupVaultArn' => '<string>',
                            'BackupVaultName' => '<string>',
                            'EncryptionKeyArn' => '<string>',
                            'Notifications' => [
                                'BackupVaultEvents' => ['<string>', ...],
                                'SnsTopicArn' => '<string>',
                            ],
                        ],
                        'AwsBackupRecoveryPoint' => [
                            'BackupSizeInBytes' => <integer>,
                            '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' => true || false,
                            'LastRestoreTime' => '<string>',
                            'Lifecycle' => [
                                'DeleteAfterDays' => <integer>,
                                'MoveToColdStorageAfterDays' => <integer>,
                            ],
                            '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' => true || false,
                            'DriftInformation' => [
                                'StackDriftStatus' => '<string>',
                            ],
                            'EnableTerminationProtection' => true || false,
                            'LastUpdatedTime' => '<string>',
                            'NotificationArns' => ['<string>', ...],
                            'Outputs' => [
                                [
                                    'Description' => '<string>',
                                    'OutputKey' => '<string>',
                                    'OutputValue' => '<string>',
                                ],
                                // ...
                            ],
                            'RoleArn' => '<string>',
                            'StackId' => '<string>',
                            'StackName' => '<string>',
                            'StackStatus' => '<string>',
                            'StackStatusReason' => '<string>',
                            'TimeoutInMinutes' => <integer>,
                        ],
                        'AwsCloudFrontDistribution' => [
                            'CacheBehaviors' => [
                                'Items' => [
                                    [
                                        'ViewerProtocolPolicy' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'DefaultCacheBehavior' => [
                                'ViewerProtocolPolicy' => '<string>',
                            ],
                            'DefaultRootObject' => '<string>',
                            'DomainName' => '<string>',
                            'ETag' => '<string>',
                            'LastModifiedTime' => '<string>',
                            'Logging' => [
                                'Bucket' => '<string>',
                                'Enabled' => true || false,
                                'IncludeCookies' => true || false,
                                'Prefix' => '<string>',
                            ],
                            'OriginGroups' => [
                                'Items' => [
                                    [
                                        'FailoverCriteria' => [
                                            'StatusCodes' => [
                                                'Items' => [<integer>, ...],
                                                'Quantity' => <integer>,
                                            ],
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'Origins' => [
                                'Items' => [
                                    [
                                        'CustomOriginConfig' => [
                                            'HttpPort' => <integer>,
                                            'HttpsPort' => <integer>,
                                            'OriginKeepaliveTimeout' => <integer>,
                                            'OriginProtocolPolicy' => '<string>',
                                            'OriginReadTimeout' => <integer>,
                                            'OriginSslProtocols' => [
                                                'Items' => ['<string>', ...],
                                                'Quantity' => <integer>,
                                            ],
                                        ],
                                        'DomainName' => '<string>',
                                        'Id' => '<string>',
                                        'OriginPath' => '<string>',
                                        'S3OriginConfig' => [
                                            'OriginAccessIdentity' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'Status' => '<string>',
                            'ViewerCertificate' => [
                                'AcmCertificateArn' => '<string>',
                                'Certificate' => '<string>',
                                'CertificateSource' => '<string>',
                                'CloudFrontDefaultCertificate' => true || false,
                                'IamCertificateId' => '<string>',
                                'MinimumProtocolVersion' => '<string>',
                                'SslSupportMethod' => '<string>',
                            ],
                            'WebAclId' => '<string>',
                        ],
                        'AwsCloudTrailTrail' => [
                            'CloudWatchLogsLogGroupArn' => '<string>',
                            'CloudWatchLogsRoleArn' => '<string>',
                            'HasCustomEventSelectors' => true || false,
                            'HomeRegion' => '<string>',
                            'IncludeGlobalServiceEvents' => true || false,
                            'IsMultiRegionTrail' => true || false,
                            'IsOrganizationTrail' => true || false,
                            'KmsKeyId' => '<string>',
                            'LogFileValidationEnabled' => true || false,
                            'Name' => '<string>',
                            'S3BucketName' => '<string>',
                            'S3KeyPrefix' => '<string>',
                            'SnsTopicArn' => '<string>',
                            'SnsTopicName' => '<string>',
                            'TrailArn' => '<string>',
                        ],
                        'AwsCloudWatchAlarm' => [
                            'ActionsEnabled' => true || false,
                            'AlarmActions' => ['<string>', ...],
                            'AlarmArn' => '<string>',
                            'AlarmConfigurationUpdatedTimestamp' => '<string>',
                            'AlarmDescription' => '<string>',
                            'AlarmName' => '<string>',
                            'ComparisonOperator' => '<string>',
                            'DatapointsToAlarm' => <integer>,
                            'Dimensions' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'EvaluateLowSampleCountPercentile' => '<string>',
                            'EvaluationPeriods' => <integer>,
                            'ExtendedStatistic' => '<string>',
                            'InsufficientDataActions' => ['<string>', ...],
                            'MetricName' => '<string>',
                            'Namespace' => '<string>',
                            'OkActions' => ['<string>', ...],
                            'Period' => <integer>,
                            'Statistic' => '<string>',
                            'Threshold' => <float>,
                            'ThresholdMetricId' => '<string>',
                            'TreatMissingData' => '<string>',
                            'Unit' => '<string>',
                        ],
                        'AwsCodeBuildProject' => [
                            'Artifacts' => [
                                [
                                    'ArtifactIdentifier' => '<string>',
                                    'EncryptionDisabled' => true || false,
                                    'Location' => '<string>',
                                    'Name' => '<string>',
                                    'NamespaceType' => '<string>',
                                    'OverrideArtifactName' => true || false,
                                    'Packaging' => '<string>',
                                    'Path' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'EncryptionKey' => '<string>',
                            'Environment' => [
                                'Certificate' => '<string>',
                                'EnvironmentVariables' => [
                                    [
                                        'Name' => '<string>',
                                        'Type' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ImagePullCredentialsType' => '<string>',
                                'PrivilegedMode' => true || false,
                                'RegistryCredential' => [
                                    'Credential' => '<string>',
                                    'CredentialProvider' => '<string>',
                                ],
                                'Type' => '<string>',
                            ],
                            'LogsConfig' => [
                                'CloudWatchLogs' => [
                                    'GroupName' => '<string>',
                                    'Status' => '<string>',
                                    'StreamName' => '<string>',
                                ],
                                'S3Logs' => [
                                    'EncryptionDisabled' => true || false,
                                    'Location' => '<string>',
                                    'Status' => '<string>',
                                ],
                            ],
                            'Name' => '<string>',
                            'SecondaryArtifacts' => [
                                [
                                    'ArtifactIdentifier' => '<string>',
                                    'EncryptionDisabled' => true || false,
                                    'Location' => '<string>',
                                    'Name' => '<string>',
                                    'NamespaceType' => '<string>',
                                    'OverrideArtifactName' => true || false,
                                    'Packaging' => '<string>',
                                    'Path' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'ServiceRole' => '<string>',
                            'Source' => [
                                'GitCloneDepth' => <integer>,
                                'InsecureSsl' => true || false,
                                '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' => <integer>,
                            'ServerName' => '<string>',
                            'SslMode' => '<string>',
                            'Username' => '<string>',
                        ],
                        'AwsDmsReplicationInstance' => [
                            'AllocatedStorage' => <integer>,
                            'AutoMinorVersionUpgrade' => true || false,
                            'AvailabilityZone' => '<string>',
                            'EngineVersion' => '<string>',
                            'KmsKeyId' => '<string>',
                            'MultiAZ' => true || false,
                            'PreferredMaintenanceWindow' => '<string>',
                            'PubliclyAccessible' => true || false,
                            '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' => true || false,
                            'GlobalSecondaryIndexes' => [
                                [
                                    'Backfilling' => true || false,
                                    'IndexArn' => '<string>',
                                    'IndexName' => '<string>',
                                    'IndexSizeBytes' => <integer>,
                                    'IndexStatus' => '<string>',
                                    'ItemCount' => <integer>,
                                    'KeySchema' => [
                                        [
                                            'AttributeName' => '<string>',
                                            'KeyType' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Projection' => [
                                        'NonKeyAttributes' => ['<string>', ...],
                                        'ProjectionType' => '<string>',
                                    ],
                                    'ProvisionedThroughput' => [
                                        'LastDecreaseDateTime' => '<string>',
                                        'LastIncreaseDateTime' => '<string>',
                                        'NumberOfDecreasesToday' => <integer>,
                                        'ReadCapacityUnits' => <integer>,
                                        'WriteCapacityUnits' => <integer>,
                                    ],
                                ],
                                // ...
                            ],
                            'GlobalTableVersion' => '<string>',
                            'ItemCount' => <integer>,
                            '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' => <integer>,
                                'ReadCapacityUnits' => <integer>,
                                'WriteCapacityUnits' => <integer>,
                            ],
                            'Replicas' => [
                                [
                                    'GlobalSecondaryIndexes' => [
                                        [
                                            'IndexName' => '<string>',
                                            'ProvisionedThroughputOverride' => [
                                                'ReadCapacityUnits' => <integer>,
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'KmsMasterKeyId' => '<string>',
                                    'ProvisionedThroughputOverride' => [
                                        'ReadCapacityUnits' => <integer>,
                                    ],
                                    'RegionName' => '<string>',
                                    'ReplicaStatus' => '<string>',
                                    'ReplicaStatusDescription' => '<string>',
                                ],
                                // ...
                            ],
                            'RestoreSummary' => [
                                'RestoreDateTime' => '<string>',
                                'RestoreInProgress' => true || false,
                                'SourceBackupArn' => '<string>',
                                'SourceTableArn' => '<string>',
                            ],
                            'SseDescription' => [
                                'InaccessibleEncryptionDateTime' => '<string>',
                                'KmsMasterKeyArn' => '<string>',
                                'SseType' => '<string>',
                                'Status' => '<string>',
                            ],
                            'StreamSpecification' => [
                                'StreamEnabled' => true || false,
                                'StreamViewType' => '<string>',
                            ],
                            'TableId' => '<string>',
                            'TableName' => '<string>',
                            'TableSizeBytes' => <integer>,
                            'TableStatus' => '<string>',
                        ],
                        'AwsEc2ClientVpnEndpoint' => [
                            'AuthenticationOptions' => [
                                [
                                    'ActiveDirectory' => [
                                        'DirectoryId' => '<string>',
                                    ],
                                    'FederatedAuthentication' => [
                                        'SamlProviderArn' => '<string>',
                                        'SelfServiceSamlProviderArn' => '<string>',
                                    ],
                                    'MutualAuthentication' => [
                                        'ClientRootCertificateChain' => '<string>',
                                    ],
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'ClientCidrBlock' => '<string>',
                            'ClientConnectOptions' => [
                                'Enabled' => true || false,
                                'LambdaFunctionArn' => '<string>',
                                'Status' => [
                                    'Code' => '<string>',
                                    'Message' => '<string>',
                                ],
                            ],
                            'ClientLoginBannerOptions' => [
                                'BannerText' => '<string>',
                                'Enabled' => true || false,
                            ],
                            'ClientVpnEndpointId' => '<string>',
                            'ConnectionLogOptions' => [
                                'CloudwatchLogGroup' => '<string>',
                                'CloudwatchLogStream' => '<string>',
                                'Enabled' => true || false,
                            ],
                            'Description' => '<string>',
                            'DnsServer' => ['<string>', ...],
                            'SecurityGroupIdSet' => ['<string>', ...],
                            'SelfServicePortalUrl' => '<string>',
                            'ServerCertificateArn' => '<string>',
                            'SessionTimeoutHours' => <integer>,
                            'SplitTunnel' => true || false,
                            'TransportProtocol' => '<string>',
                            'VpcId' => '<string>',
                            'VpnPort' => <integer>,
                        ],
                        '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' => <integer>,
                                'HttpTokens' => '<string>',
                                'InstanceMetadataTags' => '<string>',
                            ],
                            'Monitoring' => [
                                'State' => '<string>',
                            ],
                            'NetworkInterfaces' => [
                                [
                                    'NetworkInterfaceId' => '<string>',
                                ],
                                // ...
                            ],
                            'SubnetId' => '<string>',
                            'Type' => '<string>',
                            'VirtualizationType' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2LaunchTemplate' => [
                            'DefaultVersionNumber' => <integer>,
                            'Id' => '<string>',
                            'LatestVersionNumber' => <integer>,
                            'LaunchTemplateData' => [
                                'BlockDeviceMappingSet' => [
                                    [
                                        'DeviceName' => '<string>',
                                        'Ebs' => [
                                            'DeleteOnTermination' => true || false,
                                            'Encrypted' => true || false,
                                            'Iops' => <integer>,
                                            'KmsKeyId' => '<string>',
                                            'SnapshotId' => '<string>',
                                            'Throughput' => <integer>,
                                            'VolumeSize' => <integer>,
                                            'VolumeType' => '<string>',
                                        ],
                                        'NoDevice' => '<string>',
                                        'VirtualName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'CapacityReservationSpecification' => [
                                    'CapacityReservationPreference' => '<string>',
                                    'CapacityReservationTarget' => [
                                        'CapacityReservationId' => '<string>',
                                        'CapacityReservationResourceGroupArn' => '<string>',
                                    ],
                                ],
                                'CpuOptions' => [
                                    'CoreCount' => <integer>,
                                    'ThreadsPerCore' => <integer>,
                                ],
                                'CreditSpecification' => [
                                    'CpuCredits' => '<string>',
                                ],
                                'DisableApiStop' => true || false,
                                'DisableApiTermination' => true || false,
                                'EbsOptimized' => true || false,
                                'ElasticGpuSpecificationSet' => [
                                    [
                                        'Type' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ElasticInferenceAcceleratorSet' => [
                                    [
                                        'Count' => <integer>,
                                        'Type' => '<string>',
                                    ],
                                    // ...
                                ],
                                'EnclaveOptions' => [
                                    'Enabled' => true || false,
                                ],
                                'HibernationOptions' => [
                                    'Configured' => true || false,
                                ],
                                'IamInstanceProfile' => [
                                    'Arn' => '<string>',
                                    'Name' => '<string>',
                                ],
                                'ImageId' => '<string>',
                                'InstanceInitiatedShutdownBehavior' => '<string>',
                                'InstanceMarketOptions' => [
                                    'MarketType' => '<string>',
                                    'SpotOptions' => [
                                        'BlockDurationMinutes' => <integer>,
                                        'InstanceInterruptionBehavior' => '<string>',
                                        'MaxPrice' => '<string>',
                                        'SpotInstanceType' => '<string>',
                                        'ValidUntil' => '<string>',
                                    ],
                                ],
                                'InstanceRequirements' => [
                                    'AcceleratorCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'AcceleratorManufacturers' => ['<string>', ...],
                                    'AcceleratorNames' => ['<string>', ...],
                                    'AcceleratorTotalMemoryMiB' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'AcceleratorTypes' => ['<string>', ...],
                                    'BareMetal' => '<string>',
                                    'BaselineEbsBandwidthMbps' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'BurstablePerformance' => '<string>',
                                    'CpuManufacturers' => ['<string>', ...],
                                    'ExcludedInstanceTypes' => ['<string>', ...],
                                    'InstanceGenerations' => ['<string>', ...],
                                    'LocalStorage' => '<string>',
                                    'LocalStorageTypes' => ['<string>', ...],
                                    'MemoryGiBPerVCpu' => [
                                        'Max' => <float>,
                                        'Min' => <float>,
                                    ],
                                    'MemoryMiB' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'NetworkInterfaceCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'OnDemandMaxPricePercentageOverLowestPrice' => <integer>,
                                    'RequireHibernateSupport' => true || false,
                                    'SpotMaxPricePercentageOverLowestPrice' => <integer>,
                                    'TotalLocalStorageGB' => [
                                        'Max' => <float>,
                                        'Min' => <float>,
                                    ],
                                    'VCpuCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                ],
                                'InstanceType' => '<string>',
                                'KernelId' => '<string>',
                                'KeyName' => '<string>',
                                'LicenseSet' => [
                                    [
                                        'LicenseConfigurationArn' => '<string>',
                                    ],
                                    // ...
                                ],
                                'MaintenanceOptions' => [
                                    'AutoRecovery' => '<string>',
                                ],
                                'MetadataOptions' => [
                                    'HttpEndpoint' => '<string>',
                                    'HttpProtocolIpv6' => '<string>',
                                    'HttpPutResponseHopLimit' => <integer>,
                                    'HttpTokens' => '<string>',
                                    'InstanceMetadataTags' => '<string>',
                                ],
                                'Monitoring' => [
                                    'Enabled' => true || false,
                                ],
                                'NetworkInterfaceSet' => [
                                    [
                                        'AssociateCarrierIpAddress' => true || false,
                                        'AssociatePublicIpAddress' => true || false,
                                        'DeleteOnTermination' => true || false,
                                        'Description' => '<string>',
                                        'DeviceIndex' => <integer>,
                                        'Groups' => ['<string>', ...],
                                        'InterfaceType' => '<string>',
                                        'Ipv4PrefixCount' => <integer>,
                                        'Ipv4Prefixes' => [
                                            [
                                                'Ipv4Prefix' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'Ipv6AddressCount' => <integer>,
                                        'Ipv6Addresses' => [
                                            [
                                                'Ipv6Address' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'Ipv6PrefixCount' => <integer>,
                                        'Ipv6Prefixes' => [
                                            [
                                                'Ipv6Prefix' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'NetworkCardIndex' => <integer>,
                                        'NetworkInterfaceId' => '<string>',
                                        'PrivateIpAddress' => '<string>',
                                        'PrivateIpAddresses' => [
                                            [
                                                'Primary' => true || false,
                                                'PrivateIpAddress' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'SecondaryPrivateIpAddressCount' => <integer>,
                                        'SubnetId' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Placement' => [
                                    'Affinity' => '<string>',
                                    'AvailabilityZone' => '<string>',
                                    'GroupName' => '<string>',
                                    'HostId' => '<string>',
                                    'HostResourceGroupArn' => '<string>',
                                    'PartitionNumber' => <integer>,
                                    'SpreadDomain' => '<string>',
                                    'Tenancy' => '<string>',
                                ],
                                'PrivateDnsNameOptions' => [
                                    'EnableResourceNameDnsAAAARecord' => true || false,
                                    'EnableResourceNameDnsARecord' => true || false,
                                    'HostnameType' => '<string>',
                                ],
                                'RamDiskId' => '<string>',
                                'SecurityGroupIdSet' => ['<string>', ...],
                                'SecurityGroupSet' => ['<string>', ...],
                                'UserData' => '<string>',
                            ],
                            'LaunchTemplateName' => '<string>',
                        ],
                        'AwsEc2NetworkAcl' => [
                            'Associations' => [
                                [
                                    'NetworkAclAssociationId' => '<string>',
                                    'NetworkAclId' => '<string>',
                                    'SubnetId' => '<string>',
                                ],
                                // ...
                            ],
                            'Entries' => [
                                [
                                    'CidrBlock' => '<string>',
                                    'Egress' => true || false,
                                    'IcmpTypeCode' => [
                                        'Code' => <integer>,
                                        'Type' => <integer>,
                                    ],
                                    'Ipv6CidrBlock' => '<string>',
                                    'PortRange' => [
                                        'From' => <integer>,
                                        'To' => <integer>,
                                    ],
                                    'Protocol' => '<string>',
                                    'RuleAction' => '<string>',
                                    'RuleNumber' => <integer>,
                                ],
                                // ...
                            ],
                            'IsDefault' => true || false,
                            'NetworkAclId' => '<string>',
                            'OwnerId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2NetworkInterface' => [
                            'Attachment' => [
                                'AttachTime' => '<string>',
                                'AttachmentId' => '<string>',
                                'DeleteOnTermination' => true || false,
                                'DeviceIndex' => <integer>,
                                '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' => true || false,
                        ],
                        'AwsEc2RouteTable' => [
                            'AssociationSet' => [
                                [
                                    'AssociationState' => [
                                        'State' => '<string>',
                                        'StatusMessage' => '<string>',
                                    ],
                                    'GatewayId' => '<string>',
                                    'Main' => true || false,
                                    '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' => <integer>,
                                    'IpProtocol' => '<string>',
                                    'IpRanges' => [
                                        [
                                            'CidrIp' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ipv6Ranges' => [
                                        [
                                            'CidrIpv6' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'PrefixListIds' => [
                                        [
                                            'PrefixListId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ToPort' => <integer>,
                                    'UserIdGroupPairs' => [
                                        [
                                            'GroupId' => '<string>',
                                            'GroupName' => '<string>',
                                            'PeeringStatus' => '<string>',
                                            'UserId' => '<string>',
                                            'VpcId' => '<string>',
                                            'VpcPeeringConnectionId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'IpPermissionsEgress' => [
                                [
                                    'FromPort' => <integer>,
                                    'IpProtocol' => '<string>',
                                    'IpRanges' => [
                                        [
                                            'CidrIp' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ipv6Ranges' => [
                                        [
                                            'CidrIpv6' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'PrefixListIds' => [
                                        [
                                            'PrefixListId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ToPort' => <integer>,
                                    'UserIdGroupPairs' => [
                                        [
                                            'GroupId' => '<string>',
                                            'GroupName' => '<string>',
                                            'PeeringStatus' => '<string>',
                                            'UserId' => '<string>',
                                            'VpcId' => '<string>',
                                            'VpcPeeringConnectionId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OwnerId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2Subnet' => [
                            'AssignIpv6AddressOnCreation' => true || false,
                            'AvailabilityZone' => '<string>',
                            'AvailabilityZoneId' => '<string>',
                            'AvailableIpAddressCount' => <integer>,
                            'CidrBlock' => '<string>',
                            'DefaultForAz' => true || false,
                            'Ipv6CidrBlockAssociationSet' => [
                                [
                                    'AssociationId' => '<string>',
                                    'CidrBlockState' => '<string>',
                                    'Ipv6CidrBlock' => '<string>',
                                ],
                                // ...
                            ],
                            'MapPublicIpOnLaunch' => true || false,
                            'OwnerId' => '<string>',
                            'State' => '<string>',
                            'SubnetArn' => '<string>',
                            'SubnetId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2TransitGateway' => [
                            'AmazonSideAsn' => <integer>,
                            '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' => true || false,
                                    'InstanceId' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateTime' => '<string>',
                            'DeviceName' => '<string>',
                            'Encrypted' => true || false,
                            'KmsKeyId' => '<string>',
                            'Size' => <integer>,
                            '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' => true || false,
                            'AvailabilityZones' => ['<string>', ...],
                            'BaseEndpointDnsNames' => ['<string>', ...],
                            'GatewayLoadBalancerArns' => ['<string>', ...],
                            'ManagesVpcEndpoints' => true || false,
                            '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' => true || false,
                                    'AllowEgressFromLocalClassicLinkToRemoteVpc' => true || false,
                                    'AllowEgressFromLocalVpcToRemoteClassicLink' => true || false,
                                ],
                                'Region' => '<string>',
                                'VpcId' => '<string>',
                            ],
                            'ExpirationTime' => '<string>',
                            'RequesterVpcInfo' => [
                                'CidrBlock' => '<string>',
                                'CidrBlockSet' => [
                                    [
                                        'CidrBlock' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Ipv6CidrBlockSet' => [
                                    [
                                        'Ipv6CidrBlock' => '<string>',
                                    ],
                                    // ...
                                ],
                                'OwnerId' => '<string>',
                                'PeeringOptions' => [
                                    'AllowDnsResolutionFromRemoteVpc' => true || false,
                                    'AllowEgressFromLocalClassicLinkToRemoteVpc' => true || false,
                                    'AllowEgressFromLocalVpcToRemoteClassicLink' => true || false,
                                ],
                                'Region' => '<string>',
                                'VpcId' => '<string>',
                            ],
                            'Status' => [
                                'Code' => '<string>',
                                'Message' => '<string>',
                            ],
                            'VpcPeeringConnectionId' => '<string>',
                        ],
                        'AwsEc2VpnConnection' => [
                            'Category' => '<string>',
                            'CustomerGatewayConfiguration' => '<string>',
                            'CustomerGatewayId' => '<string>',
                            'Options' => [
                                'StaticRoutesOnly' => true || false,
                                'TunnelOptions' => [
                                    [
                                        'DpdTimeoutSeconds' => <integer>,
                                        'IkeVersions' => ['<string>', ...],
                                        'OutsideIpAddress' => '<string>',
                                        'Phase1DhGroupNumbers' => [<integer>, ...],
                                        'Phase1EncryptionAlgorithms' => ['<string>', ...],
                                        'Phase1IntegrityAlgorithms' => ['<string>', ...],
                                        'Phase1LifetimeSeconds' => <integer>,
                                        'Phase2DhGroupNumbers' => [<integer>, ...],
                                        'Phase2EncryptionAlgorithms' => ['<string>', ...],
                                        'Phase2IntegrityAlgorithms' => ['<string>', ...],
                                        'Phase2LifetimeSeconds' => <integer>,
                                        'PreSharedKey' => '<string>',
                                        'RekeyFuzzPercentage' => <integer>,
                                        'RekeyMarginTimeSeconds' => <integer>,
                                        'ReplayWindowSize' => <integer>,
                                        'TunnelInsideCidr' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'Routes' => [
                                [
                                    'DestinationCidrBlock' => '<string>',
                                    'State' => '<string>',
                                ],
                                // ...
                            ],
                            'State' => '<string>',
                            'TransitGatewayId' => '<string>',
                            'Type' => '<string>',
                            'VgwTelemetry' => [
                                [
                                    'AcceptedRouteCount' => <integer>,
                                    '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' => true || false,
                            ],
                            'ImageTagMutability' => '<string>',
                            'LifecyclePolicy' => [
                                'LifecyclePolicyText' => '<string>',
                                'RegistryId' => '<string>',
                            ],
                            'RepositoryName' => '<string>',
                            'RepositoryPolicyText' => '<string>',
                        ],
                        'AwsEcsCluster' => [
                            'ActiveServicesCount' => <integer>,
                            'CapacityProviders' => ['<string>', ...],
                            'ClusterArn' => '<string>',
                            'ClusterName' => '<string>',
                            'ClusterSettings' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'Configuration' => [
                                'ExecuteCommandConfiguration' => [
                                    'KmsKeyId' => '<string>',
                                    'LogConfiguration' => [
                                        'CloudWatchEncryptionEnabled' => true || false,
                                        'CloudWatchLogGroupName' => '<string>',
                                        'S3BucketName' => '<string>',
                                        'S3EncryptionEnabled' => true || false,
                                        'S3KeyPrefix' => '<string>',
                                    ],
                                    'Logging' => '<string>',
                                ],
                            ],
                            'DefaultCapacityProviderStrategy' => [
                                [
                                    'Base' => <integer>,
                                    'CapacityProvider' => '<string>',
                                    'Weight' => <integer>,
                                ],
                                // ...
                            ],
                            'RegisteredContainerInstancesCount' => <integer>,
                            'RunningTasksCount' => <integer>,
                            'Status' => '<string>',
                        ],
                        'AwsEcsContainer' => [
                            'Image' => '<string>',
                            'MountPoints' => [
                                [
                                    'ContainerPath' => '<string>',
                                    'SourceVolume' => '<string>',
                                ],
                                // ...
                            ],
                            'Name' => '<string>',
                            'Privileged' => true || false,
                        ],
                        'AwsEcsService' => [
                            'CapacityProviderStrategy' => [
                                [
                                    'Base' => <integer>,
                                    'CapacityProvider' => '<string>',
                                    'Weight' => <integer>,
                                ],
                                // ...
                            ],
                            'Cluster' => '<string>',
                            'DeploymentConfiguration' => [
                                'DeploymentCircuitBreaker' => [
                                    'Enable' => true || false,
                                    'Rollback' => true || false,
                                ],
                                'MaximumPercent' => <integer>,
                                'MinimumHealthyPercent' => <integer>,
                            ],
                            'DeploymentController' => [
                                'Type' => '<string>',
                            ],
                            'DesiredCount' => <integer>,
                            'EnableEcsManagedTags' => true || false,
                            'EnableExecuteCommand' => true || false,
                            'HealthCheckGracePeriodSeconds' => <integer>,
                            'LaunchType' => '<string>',
                            'LoadBalancers' => [
                                [
                                    'ContainerName' => '<string>',
                                    'ContainerPort' => <integer>,
                                    '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' => <integer>,
                                    'Port' => <integer>,
                                    'RegistryArn' => '<string>',
                                ],
                                // ...
                            ],
                            'TaskDefinition' => '<string>',
                        ],
                        'AwsEcsTask' => [
                            'ClusterArn' => '<string>',
                            'Containers' => [
                                [
                                    'Image' => '<string>',
                                    'MountPoints' => [
                                        [
                                            'ContainerPath' => '<string>',
                                            'SourceVolume' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Name' => '<string>',
                                    'Privileged' => true || false,
                                ],
                                // ...
                            ],
                            'CreatedAt' => '<string>',
                            'Group' => '<string>',
                            'StartedAt' => '<string>',
                            'StartedBy' => '<string>',
                            'TaskDefinitionArn' => '<string>',
                            'Version' => '<string>',
                            'Volumes' => [
                                [
                                    'Host' => [
                                        'SourcePath' => '<string>',
                                    ],
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsEcsTaskDefinition' => [
                            'ContainerDefinitions' => [
                                [
                                    'Command' => ['<string>', ...],
                                    'Cpu' => <integer>,
                                    'DependsOn' => [
                                        [
                                            'Condition' => '<string>',
                                            'ContainerName' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'DisableNetworking' => true || false,
                                    'DnsSearchDomains' => ['<string>', ...],
                                    'DnsServers' => ['<string>', ...],
                                    'DockerLabels' => ['<string>', ...],
                                    'DockerSecurityOptions' => ['<string>', ...],
                                    'EntryPoint' => ['<string>', ...],
                                    'Environment' => [
                                        [
                                            'Name' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'EnvironmentFiles' => [
                                        [
                                            'Type' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Essential' => true || false,
                                    'ExtraHosts' => [
                                        [
                                            'Hostname' => '<string>',
                                            'IpAddress' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'FirelensConfiguration' => [
                                        'Options' => ['<string>', ...],
                                        'Type' => '<string>',
                                    ],
                                    'HealthCheck' => [
                                        'Command' => ['<string>', ...],
                                        'Interval' => <integer>,
                                        'Retries' => <integer>,
                                        'StartPeriod' => <integer>,
                                        'Timeout' => <integer>,
                                    ],
                                    'Hostname' => '<string>',
                                    'Image' => '<string>',
                                    'Interactive' => true || false,
                                    'Links' => ['<string>', ...],
                                    'LinuxParameters' => [
                                        'Capabilities' => [
                                            'Add' => ['<string>', ...],
                                            'Drop' => ['<string>', ...],
                                        ],
                                        'Devices' => [
                                            [
                                                'ContainerPath' => '<string>',
                                                'HostPath' => '<string>',
                                                'Permissions' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'InitProcessEnabled' => true || false,
                                        'MaxSwap' => <integer>,
                                        'SharedMemorySize' => <integer>,
                                        'Swappiness' => <integer>,
                                        'Tmpfs' => [
                                            [
                                                'ContainerPath' => '<string>',
                                                'MountOptions' => ['<string>', ...],
                                                'Size' => <integer>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'LogConfiguration' => [
                                        'LogDriver' => '<string>',
                                        'Options' => ['<string>', ...],
                                        'SecretOptions' => [
                                            [
                                                'Name' => '<string>',
                                                'ValueFrom' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'Memory' => <integer>,
                                    'MemoryReservation' => <integer>,
                                    'MountPoints' => [
                                        [
                                            'ContainerPath' => '<string>',
                                            'ReadOnly' => true || false,
                                            'SourceVolume' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Name' => '<string>',
                                    'PortMappings' => [
                                        [
                                            'ContainerPort' => <integer>,
                                            'HostPort' => <integer>,
                                            'Protocol' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Privileged' => true || false,
                                    'PseudoTerminal' => true || false,
                                    'ReadonlyRootFilesystem' => true || false,
                                    'RepositoryCredentials' => [
                                        'CredentialsParameter' => '<string>',
                                    ],
                                    'ResourceRequirements' => [
                                        [
                                            'Type' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Secrets' => [
                                        [
                                            'Name' => '<string>',
                                            'ValueFrom' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'StartTimeout' => <integer>,
                                    'StopTimeout' => <integer>,
                                    'SystemControls' => [
                                        [
                                            'Namespace' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ulimits' => [
                                        [
                                            'HardLimit' => <integer>,
                                            'Name' => '<string>',
                                            'SoftLimit' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'User' => '<string>',
                                    'VolumesFrom' => [
                                        [
                                            'ReadOnly' => true || false,
                                            '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' => true || false,
                                        'Driver' => '<string>',
                                        'DriverOpts' => ['<string>', ...],
                                        'Labels' => ['<string>', ...],
                                        'Scope' => '<string>',
                                    ],
                                    'EfsVolumeConfiguration' => [
                                        'AuthorizationConfig' => [
                                            'AccessPointId' => '<string>',
                                            'Iam' => '<string>',
                                        ],
                                        'FilesystemId' => '<string>',
                                        'RootDirectory' => '<string>',
                                        'TransitEncryption' => '<string>',
                                        'TransitEncryptionPort' => <integer>,
                                    ],
                                    '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' => true || false,
                                        'Types' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            'Name' => '<string>',
                            'ResourcesVpcConfig' => [
                                'EndpointPublicAccess' => true || false,
                                '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' => true || false,
                                'TLSSecurityPolicy' => '<string>',
                            ],
                            'DomainId' => '<string>',
                            'DomainName' => '<string>',
                            'ElasticsearchClusterConfig' => [
                                'DedicatedMasterCount' => <integer>,
                                'DedicatedMasterEnabled' => true || false,
                                'DedicatedMasterType' => '<string>',
                                'InstanceCount' => <integer>,
                                'InstanceType' => '<string>',
                                'ZoneAwarenessConfig' => [
                                    'AvailabilityZoneCount' => <integer>,
                                ],
                                'ZoneAwarenessEnabled' => true || false,
                            ],
                            'ElasticsearchVersion' => '<string>',
                            'EncryptionAtRestOptions' => [
                                'Enabled' => true || false,
                                'KmsKeyId' => '<string>',
                            ],
                            'Endpoint' => '<string>',
                            'Endpoints' => ['<string>', ...],
                            'LogPublishingOptions' => [
                                'AuditLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                                'IndexSlowLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                                'SearchSlowLogs' => [
                                    'CloudWatchLogsLogGroupArn' => '<string>',
                                    'Enabled' => true || false,
                                ],
                            ],
                            'NodeToNodeEncryptionOptions' => [
                                'Enabled' => true || false,
                            ],
                            'ServiceSoftwareOptions' => [
                                'AutomatedUpdateDate' => '<string>',
                                'Cancellable' => true || false,
                                'CurrentVersion' => '<string>',
                                'Description' => '<string>',
                                'NewVersion' => '<string>',
                                'UpdateAvailable' => true || false,
                                'UpdateStatus' => '<string>',
                            ],
                            'VPCOptions' => [
                                'AvailabilityZones' => ['<string>', ...],
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                                'VPCId' => '<string>',
                            ],
                        ],
                        'AwsElbLoadBalancer' => [
                            'AvailabilityZones' => ['<string>', ...],
                            'BackendServerDescriptions' => [
                                [
                                    'InstancePort' => <integer>,
                                    'PolicyNames' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'CanonicalHostedZoneName' => '<string>',
                            'CanonicalHostedZoneNameID' => '<string>',
                            'CreatedTime' => '<string>',
                            'DnsName' => '<string>',
                            'HealthCheck' => [
                                'HealthyThreshold' => <integer>,
                                'Interval' => <integer>,
                                'Target' => '<string>',
                                'Timeout' => <integer>,
                                'UnhealthyThreshold' => <integer>,
                            ],
                            'Instances' => [
                                [
                                    'InstanceId' => '<string>',
                                ],
                                // ...
                            ],
                            'ListenerDescriptions' => [
                                [
                                    'Listener' => [
                                        'InstancePort' => <integer>,
                                        'InstanceProtocol' => '<string>',
                                        'LoadBalancerPort' => <integer>,
                                        'Protocol' => '<string>',
                                        'SslCertificateId' => '<string>',
                                    ],
                                    'PolicyNames' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'LoadBalancerAttributes' => [
                                'AccessLog' => [
                                    'EmitInterval' => <integer>,
                                    'Enabled' => true || false,
                                    'S3BucketName' => '<string>',
                                    'S3BucketPrefix' => '<string>',
                                ],
                                'AdditionalAttributes' => [
                                    [
                                        'Key' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ConnectionDraining' => [
                                    'Enabled' => true || false,
                                    'Timeout' => <integer>,
                                ],
                                'ConnectionSettings' => [
                                    'IdleTimeout' => <integer>,
                                ],
                                'CrossZoneLoadBalancing' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'LoadBalancerName' => '<string>',
                            'Policies' => [
                                'AppCookieStickinessPolicies' => [
                                    [
                                        'CookieName' => '<string>',
                                        'PolicyName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'LbCookieStickinessPolicies' => [
                                    [
                                        'CookieExpirationPeriod' => <integer>,
                                        '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' => true || false,
                                ],
                                'SessionIssuer' => [
                                    'AccountId' => '<string>',
                                    'Arn' => '<string>',
                                    'PrincipalId' => '<string>',
                                    'Type' => '<string>',
                                    'UserName' => '<string>',
                                ],
                            ],
                            'Status' => 'Active|Inactive',
                            'UserName' => '<string>',
                        ],
                        'AwsIamGroup' => [
                            'AttachedManagedPolicies' => [
                                [
                                    'PolicyArn' => '<string>',
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateDate' => '<string>',
                            'GroupId' => '<string>',
                            'GroupName' => '<string>',
                            'GroupPolicyList' => [
                                [
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'Path' => '<string>',
                        ],
                        'AwsIamPolicy' => [
                            'AttachmentCount' => <integer>,
                            'CreateDate' => '<string>',
                            'DefaultVersionId' => '<string>',
                            'Description' => '<string>',
                            'IsAttachable' => true || false,
                            'Path' => '<string>',
                            'PermissionsBoundaryUsageCount' => <integer>,
                            'PolicyId' => '<string>',
                            'PolicyName' => '<string>',
                            'PolicyVersionList' => [
                                [
                                    'CreateDate' => '<string>',
                                    'IsDefaultVersion' => true || false,
                                    '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' => <integer>,
                            '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' => <integer>,
                            'ShardCount' => <integer>,
                            'StreamEncryption' => [
                                'EncryptionType' => '<string>',
                                'KeyId' => '<string>',
                            ],
                        ],
                        'AwsKmsKey' => [
                            'AWSAccountId' => '<string>',
                            'CreationDate' => <float>,
                            'Description' => '<string>',
                            'KeyId' => '<string>',
                            'KeyManager' => '<string>',
                            'KeyRotationStatus' => true || false,
                            '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>', ...],
                            ],
                            'FunctionName' => '<string>',
                            'Handler' => '<string>',
                            'KmsKeyArn' => '<string>',
                            'LastModified' => '<string>',
                            'Layers' => [
                                [
                                    'Arn' => '<string>',
                                    'CodeSize' => <integer>,
                                ],
                                // ...
                            ],
                            'MasterArn' => '<string>',
                            'MemorySize' => <integer>,
                            'PackageType' => '<string>',
                            'RevisionId' => '<string>',
                            'Role' => '<string>',
                            'Runtime' => '<string>',
                            'Timeout' => <integer>,
                            'TracingConfig' => [
                                'Mode' => '<string>',
                            ],
                            'Version' => '<string>',
                            'VpcConfig' => [
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                                'VpcId' => '<string>',
                            ],
                        ],
                        'AwsLambdaLayerVersion' => [
                            'CompatibleRuntimes' => ['<string>', ...],
                            'CreatedDate' => '<string>',
                            'Version' => <integer>,
                        ],
                        'AwsMskCluster' => [
                            'ClusterInfo' => [
                                'ClientAuthentication' => [
                                    'Sasl' => [
                                        'Iam' => [
                                            'Enabled' => true || false,
                                        ],
                                        'Scram' => [
                                            'Enabled' => true || false,
                                        ],
                                    ],
                                    'Tls' => [
                                        'CertificateAuthorityArnList' => ['<string>', ...],
                                        'Enabled' => true || false,
                                    ],
                                    'Unauthenticated' => [
                                        'Enabled' => true || false,
                                    ],
                                ],
                                'ClusterName' => '<string>',
                                'CurrentVersion' => '<string>',
                                'EncryptionInfo' => [
                                    'EncryptionAtRest' => [
                                        'DataVolumeKMSKeyId' => '<string>',
                                    ],
                                    'EncryptionInTransit' => [
                                        'ClientBroker' => '<string>',
                                        'InCluster' => true || false,
                                    ],
                                ],
                                'EnhancedMonitoring' => '<string>',
                                'NumberOfBrokerNodes' => <integer>,
                            ],
                        ],
                        'AwsNetworkFirewallFirewall' => [
                            'DeleteProtection' => true || false,
                            'Description' => '<string>',
                            'FirewallArn' => '<string>',
                            'FirewallId' => '<string>',
                            'FirewallName' => '<string>',
                            'FirewallPolicyArn' => '<string>',
                            'FirewallPolicyChangeProtection' => true || false,
                            'SubnetChangeProtection' => true || false,
                            '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' => <integer>,
                                        'ResourceArn' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'FirewallPolicyArn' => '<string>',
                            'FirewallPolicyId' => '<string>',
                            'FirewallPolicyName' => '<string>',
                        ],
                        'AwsNetworkFirewallRuleGroup' => [
                            'Capacity' => <integer>,
                            'Description' => '<string>',
                            'RuleGroup' => [
                                'RuleVariables' => [
                                    'IpSets' => [
                                        'Definition' => ['<string>', ...],
                                    ],
                                    'PortSets' => [
                                        'Definition' => ['<string>', ...],
                                    ],
                                ],
                                'RulesSource' => [
                                    'RulesSourceList' => [
                                        'GeneratedRulesType' => '<string>',
                                        'TargetTypes' => ['<string>', ...],
                                        'Targets' => ['<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>',
                                                            ],