AWS SecurityHub 2018-10-26
- 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 = [] )
Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
- AcceptInvitation ( array $params = [] )
This method is deprecated.
- BatchDisableStandards ( array $params = [] )
Disables the standards specified by the provided StandardsSubscriptionArns.
- BatchEnableStandards ( array $params = [] )
Enables the standards specified by the provided StandardsArn.
- 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.
- 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.
- CreateFindingAggregator ( array $params = [] )
Used to enable finding aggregation.
- 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 = [] )
Declines invitations to become a member account.
- DeleteActionTarget ( array $params = [] )
Deletes a custom action target from Security Hub.
- DeleteFindingAggregator ( array $params = [] )
Deletes a finding aggregator.
- DeleteInsight ( array $params = [] )
Deletes the insight specified by the InsightArn.
- DeleteInvitations ( array $params = [] )
Deletes invitations received by the Amazon Web Services account to become a member account.
- 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 Organizations configuration for 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 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.
- GetEnabledStandards ( array $params = [] )
Returns a list of the standards that are currently enabled.
- GetFindingAggregator ( array $params = [] )
Returns the current finding aggregation configuration.
- 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 = [] )
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
- GetMasterAccount ( array $params = [] )
This method is deprecated.
- GetMembers ( array $params = [] )
Returns the details for the Security Hub member accounts for the specified account IDs.
- InviteMembers ( array $params = [] )
Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
- ListEnabledProductsForImport ( array $params = [] )
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
- ListFindingAggregators ( array $params = [] )
If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator.
- ListInvitations ( array $params = [] )
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
- 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.
- 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.
- UpdateFindingAggregator ( array $params = [] )
Updates the finding aggregation configuration.
- UpdateFindings ( array $params = [] )
UpdateFindings is deprecated.
- UpdateInsight ( array $params = [] )
Updates the Security Hub insight identified by the specified insight ARN.
- UpdateOrganizationConfiguration ( array $params = [] )
Used to update the configuration related to Organizations.
- 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
- GetFindings
- GetInsights
- ListEnabledProductsForImport
- ListFindingAggregators
- ListInvitations
- ListMembers
- ListOrganizationAdminAccounts
- ListSecurityControlDefinitions
- ListStandardsControlAssociations
Operations
AcceptAdministratorInvitation
$result = $client->acceptAdministratorInvitation([/* ... */]); $promise = $client->acceptAdministratorInvitationAsync([/* ... */]);
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
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
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.
-
The request was rejected because we can't find the specified resource.
-
The account doesn't have permission to perform this action.
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
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
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.
-
The request was rejected because we can't find the specified resource.
-
The account doesn't have permission to perform this action.
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
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
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
Result Syntax
[
'SecurityControls' => [
[
'Description' => '<string>',
'RemediationUrl' => '<string>',
'SecurityControlArn' => '<string>',
'SecurityControlId' => '<string>',
'SecurityControlStatus' => 'ENABLED|DISABLED',
'SeverityRating' => 'LOW|MEDIUM|HIGH|CRITICAL',
'Title' => '<string>',
],
// ...
],
'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
SecurityControlIdorSecurityControlArn. - 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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
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
BatchImportFindingsfrom needs to be the same as theAwsAccountIdattribute 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
BatchImportFindingsfrom 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
'CompanyName' => '<string>',
'Compliance' => [
'AssociatedStandards' => [
[
'StandardsId' => '<string>',
],
// ...
],
'RelatedRequirements' => ['<string>', ...],
'SecurityControlId' => '<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>',
'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>',
],
'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
[
'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' => [
'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>', ...],
],
'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>',
],
],
'AwsDynamoDbTable' => [
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => '<string>',
],
// ...
],
'BillingModeSummary' => [
'BillingMode' => '<string>',
'LastUpdateToPayPerRequestDateTime' => '<string>',
],
'CreationDateTime' => '<string>',
'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>',
],
'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>', ...],
'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>',
],
'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>,
],
'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>',
],
// ...
],
'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>',
'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>',
],
// ...
],
],
'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>',
'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>',
],
],
],
'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' => [
[
'Cvss' => [
[
'Adjustments' => [
[
'Metric' => '<string>',
'Reason' => '<string>',
],
// ...
],
'BaseScore' => <float>,
'BaseVector' => '<string>',
'Source' => '<string>',
'Version' => '<string>',
],
// ...
],
'FixAvailable' => 'YES|NO|PARTIAL',
'Id' => '<string>', // REQUIRED
'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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
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.
-
The account doesn't have permission to perform this action.
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 do not 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.
BatchUpdateFindingscan 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
VerificationStateare 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 ofTRUE_POSITIVEwhere 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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
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.
-
The account doesn't have permission to perform this action.
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
-
- Type: Array of UnprocessedStandardsControlAssociationUpdate structures
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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
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
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The resource specified in the request conflicts with an existing resource.
CreateFindingAggregator
$result = $client->createFindingAggregator([/* ... */]); $promise = $client->createFindingAggregatorAsync([/* ... */]);
Used to enable finding aggregation. Must be called from the aggregation Region.
For more details about cross-Region replication, see Configuring finding aggregation 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- Indicates to aggregate 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- Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in theRegionsparameter. 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- Indicates to aggregate findings only from the Regions listed in theRegionsparameter. Security Hub does not automatically aggregate findings from new Regions.
- Regions
-
- Type: Array of strings
If
RegionLinkingModeisALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.If
RegionLinkingModeisSPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
Result Syntax
[
'FindingAggregationRegion' => '<string>',
'FindingAggregatorArn' => '<string>',
'RegionLinkingMode' => '<string>',
'Regions' => ['<string>', ...],
]
Result Details
Members
- FindingAggregationRegion
-
- Type: string
The aggregation Region.
- FindingAggregatorArn
-
- Type: string
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding 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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
You don't have permission to perform the action specified in the request.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
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',
'Value' => '<string>',
],
// ...
],
'CompanyName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceAssociatedStandardsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceSecurityControlId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Confidence' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'CreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'Criticality' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'Description' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsConfidence' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'FindingProviderFieldsCriticality' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'FindingProviderFieldsRelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsRelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsSeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsSeverityOriginal' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsTypes' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FirstObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'GeneratorId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Id' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Keyword' => [
[
'Value' => '<string>',
],
// ...
],
'LastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'MalwareName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwarePath' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwareState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwareType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationDomain' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationPort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NetworkDirection' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkProtocol' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourceDomain' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourceIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceMac' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourcePort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NoteText' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NoteUpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'NoteUpdatedBy' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProcessName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessParentPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessPath' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessTerminatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProductFields' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProductName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RecommendationText' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RecordState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Region' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceImageId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV4Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV6Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceKeyName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceSubnetId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceVpcId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyCreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyPrincipalName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyUserName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamUserUserName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceContainerName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceDetailsOther' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourcePartition' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceRegion' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceTags' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Sample' => [
[
'Value' => true || false,
],
// ...
],
'SeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'SeverityNormalized' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SeverityProduct' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorCategory' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorLastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSource' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorValue' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Title' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Type' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'UserDefinedFields' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VerificationState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'WorkflowState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'WorkflowStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'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
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
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.
-
The account doesn't have permission to perform this action.
-
The resource specified in the request conflicts with an existing resource.
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 do not 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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
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.
-
The account doesn't have permission to perform this action.
-
The resource specified in the request conflicts with an existing resource.
DeclineInvitations
$result = $client->declineInvitations([/* ... */]); $promise = $client->declineInvitationsAsync([/* ... */]);
Declines invitations to become a member account.
A prospective member account uses this operation to decline an invitation to become a member.
This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.
Parameter Syntax
$result = $client->declineInvitations([
'AccountIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
The request was rejected because we can't find the specified resource.
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
Result Syntax
[
'ActionTargetArn' => '<string>',
]
Result Details
Members
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
The request was rejected because we can't find the specified resource.
DeleteFindingAggregator
$result = $client->deleteFindingAggregator([/* ... */]); $promise = $client->deleteFindingAggregatorAsync([/* ... */]);
Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.
When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
Parameter Syntax
$result = $client->deleteFindingAggregator([
'FindingAggregatorArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
You don't have permission to perform the action specified in the request.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The request was rejected because we can't find the specified resource.
DeleteInsight
$result = $client->deleteInsight([/* ... */]); $promise = $client->deleteInsightAsync([/* ... */]);
Deletes the insight specified by the InsightArn.
Parameter Syntax
$result = $client->deleteInsight([
'InsightArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'InsightArn' => '<string>',
]
Result Details
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
DeleteInvitations
$result = $client->deleteInvitations([/* ... */]); $promise = $client->deleteInvitationsAsync([/* ... */]);
Deletes invitations received by the Amazon Web Services account to become a member account.
A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.
This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.
Parameter Syntax
$result = $client->deleteInvitations([
'AccountIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
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.
-
The request was rejected because we can't find the specified resource.
-
The account doesn't have permission to perform this action.
DeleteMembers
$result = $client->deleteMembers([/* ... */]); $promise = $client->deleteMembersAsync([/* ... */]);
Deletes the specified member accounts from Security Hub.
Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.
Parameter Syntax
$result = $client->deleteMembers([
'AccountIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
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
DescribeActionTargetsoperation, set the value of this parameter toNULL.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
ActionTargetobjects. Each object includes theActionTargetArn,Description, andNameof a custom action target available in Security Hub. - NextToken
-
- Type: string
The pagination token to use to request the next page of results.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
The request was rejected because we can't find the specified resource.
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
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 tofalse, 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_CONTROLif 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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The request was rejected because we can't find the specified resource.
DescribeOrganizationConfiguration
$result = $client->describeOrganizationConfiguration([/* ... */]); $promise = $client->describeOrganizationConfigurationAsync([/* ... */]);
Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.
Parameter Syntax
$result = $client->describeOrganizationConfiguration([ ]);
Parameter Details
Members
Result Syntax
[
'AutoEnable' => true || false,
'AutoEnableStandards' => 'NONE|DEFAULT',
'MemberAccountLimitReached' => true || false,
]
Result Details
Members
- AutoEnable
-
- Type: boolean
Whether to automatically enable Security Hub for new accounts in the organization.
If set to
true, then Security Hub is enabled for new accounts. If set to false, then new accounts are not added automatically. - AutoEnableStandards
-
- Type: string
Whether to automatically enable Security Hub default standards for new member accounts in the organization.
The default value of this parameter is equal to
DEFAULT.If equal to
DEFAULT, then Security Hub default standards are automatically enabled for new member accounts. If equal toNONE, then default standards are not automatically enabled for new member accounts. - MemberAccountLimitReached
-
- Type: boolean
Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
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 do not 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
DescribeProductsoperation, set the value of this parameter toNULL.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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
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
DescribeStandardsoperation, set the value of this parameter toNULL.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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
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
DescribeStandardsControlsoperation, set the value of this parameter toNULL.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
GetEnabledStandardsoperation.
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
The request was rejected because we can't find the specified resource.
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
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The request was rejected because we can't find the specified resource.
-
The account doesn't have permission to perform this action.
-
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.
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
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
DisableSecurityHub
$result = $client->disableSecurityHub([/* ... */]); $promise = $client->disableSecurityHubAsync([/* ... */]);
Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.
When you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated member accounts.
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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
The request was rejected because we can't find the specified resource.
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
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
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
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
Result Syntax
[
'ProductSubscriptionArn' => '<string>',
]
Result Details
Members
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
The resource specified in the request conflicts with an existing resource.
-
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.
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
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
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_CONTROLif 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 do not provide a value for
EnableDefaultStandards, it is set totrue. To not enable the automatically enabled standards, setEnableDefaultStandardstofalse. - 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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
The resource specified in the request conflicts with an existing resource.
-
You don't have permission to perform the action specified in the request.
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
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
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
GetEnabledStandardsoperation, set the value of this parameter toNULL.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
StandardsSubscriptionsobjects that include information about the enabled standards.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
GetFindingAggregator
$result = $client->getFindingAggregator([/* ... */]); $promise = $client->getFindingAggregatorAsync([/* ... */]);
Returns the current finding aggregation configuration.
Parameter Syntax
$result = $client->getFindingAggregator([
'FindingAggregatorArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'FindingAggregationRegion' => '<string>',
'FindingAggregatorArn' => '<string>',
'RegionLinkingMode' => '<string>',
'Regions' => ['<string>', ...],
]
Result Details
Members
- FindingAggregationRegion
-
- Type: string
The aggregation 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
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
You don't have permission to perform the action specified in the request.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The request was rejected because we can't find the specified resource.
GetFindings
$result = $client->getFindings([/* ... */]); $promise = $client->getFindingsAsync([/* ... */]);
Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
Parameter Syntax
$result = $client->getFindings([
'Filters' => [
'AwsAccountId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'CompanyName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceAssociatedStandardsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceSecurityControlId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Confidence' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'CreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'Criticality' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'Description' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsConfidence' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'FindingProviderFieldsCriticality' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'FindingProviderFieldsRelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsRelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsSeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsSeverityOriginal' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsTypes' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FirstObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'GeneratorId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Id' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Keyword' => [
[
'Value' => '<string>',
],
// ...
],
'LastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'MalwareName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwarePath' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwareState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwareType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationDomain' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationPort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NetworkDirection' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkProtocol' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourceDomain' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourceIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceMac' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourcePort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NoteText' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NoteUpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'NoteUpdatedBy' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProcessName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessParentPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessPath' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessTerminatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProductFields' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProductName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RecommendationText' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RecordState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Region' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceImageId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV4Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV6Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceKeyName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceSubnetId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceVpcId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyCreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyPrincipalName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyUserName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamUserUserName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceContainerName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceDetailsOther' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourcePartition' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceRegion' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceTags' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Sample' => [
[
'Value' => true || false,
],
// ...
],
'SeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'SeverityNormalized' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SeverityProduct' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorCategory' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorLastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSource' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorValue' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Title' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Type' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'UserDefinedFields' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VerificationState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'WorkflowState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'WorkflowStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'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,
WorkflowStateis deprecated. To search for a finding based on its workflow status, useWorkflowStatus. - 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
GetFindingsoperation, set the value of this parameter toNULL.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>',
'CompanyName' => '<string>',
'Compliance' => [
'AssociatedStandards' => [
[
'StandardsId' => '<string>',
],
// ...
],
'RelatedRequirements' => ['<string>', ...],
'SecurityControlId' => '<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>',
'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>',
],
'ProductArn' => '<string>',
'ProductFields' => ['<string>', ...],
'ProductName' => '<string>',
'RecordState' => 'ACTIVE|ARCHIVED',
'Region' => '<string>',
'RelatedFindings' => [
[
'Id' => '<string>',
'ProductArn' => '<string>',
],
// ...
],
'Remediation' => [
'Recommendation' => [
'Text' => '<string>',
'Url' => '<string>',
],
],
'Resources' => [
[
'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' => [
'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>', ...],
],
'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>',
],
],
'AwsDynamoDbTable' => [
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => '<string>',
],
// ...
],
'BillingModeSummary' => [
'BillingMode' => '<string>',
'LastUpdateToPayPerRequestDateTime' => '<string>',
],
'CreationDateTime' => '<string>',
'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>',
],
'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>', ...],
'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>',
],
'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>,
],
'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>',
],
// ...
],
'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>',
'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>',
],
// ...
],
],
'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>',
'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>',
],
],
],
'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>',
'Partition' => 'aws|aws-cn|aws-us-gov',
'Region' => '<string>',
'ResourceRole' => '<string>',
'Tags' => ['<string>', ...],
'Type' => '<string>',
],
// ...
],
'Sample' => true || false,
'SchemaVersion' => '<string>',
'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>',
'Types' => ['<string>', ...],
'UpdatedAt' => '<string>',
'UserDefinedFields' => ['<string>', ...],
'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
'Vulnerabilities' => [
[
'Cvss' => [
[
'Adjustments' => [
[
'Metric' => '<string>',
'Reason' => '<string>',
],
// ...
],
'BaseScore' => <float>,
'BaseVector' => '<string>',
'Source' => '<string>',
'Version' => '<string>',
],
// ...
],
'FixAvailable' => 'YES|NO|PARTIAL',
'Id' => '<string>',
'ReferenceUrls' => ['<string>', ...],
'RelatedVulnerabilities' => ['<string>', ...],
'Vendor' => [
'Name' => '<string>',
'Url' => '<string>',
'VendorCreatedAt' => '<string>',
'VendorSeverity' => '<string>',
'VendorUpdatedAt' => '<string>',
],
'VulnerablePackages' => [
[
'Architecture' => '<string>',
'Epoch' => '<string>',
'FilePath' => '<string>',
'FixedInVersion' => '<string>',
'Name' => '<string>',
'PackageManager' => '<string>',
'Release' => '<string>',
'Remediation' => '<string>',
'SourceLayerArn' => '<string>',
'SourceLayerHash' => '<string>',
'Version' => '<string>',
],
// ...
],
],
// ...
],
'Workflow' => [
'Status' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
],
'WorkflowState' => 'NEW|ASSIGNED|IN_PROGRESS|DEFERRED|RESOLVED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Findings
-
- Required: Yes
- Type: Array of AwsSecurityFinding structures
The findings that matched the filters specified in the request.
- NextToken
-
- Type: string
The pagination token to use to request the next page of results.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
GetInsightResults
$result = $client->getInsightResults([/* ... */]); $promise = $client->getInsightResultsAsync([/* ... */]);
Lists the results of the Security Hub insight specified by the insight ARN.
Parameter Syntax
$result = $client->getInsightResults([
'InsightArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'InsightResults' => [
'GroupByAttribute' => '<string>',
'InsightArn' => '<string>',
'ResultValues' => [
[
'Count' => <integer>,
'GroupByAttributeValue' => '<string>',
],
// ...
],
],
]
Result Details
Members
- InsightResults
-
- Required: Yes
- Type: InsightResults structure
The insight results returned by the operation.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
GetInsights
$result = $client->getInsights([/* ... */]); $promise = $client->getInsightsAsync([/* ... */]);
Lists and describes insights for the specified insight ARNs.
Parameter Syntax
$result = $client->getInsights([
'InsightArns' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- InsightArns
-
- Type: Array of strings
The ARNs of the insights to describe. If you do not provide any insight ARNs, then
GetInsightsreturns all of your custom insights. It does not return any managed insights. - MaxResults
-
- Type: int
The maximum number of items to return in the response.
- NextToken
-
- Type: string
The token that is required for pagination. On your first call to the
GetInsightsoperation, set the value of this parameter toNULL.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
[
'Insights' => [
[
'Filters' => [
'AwsAccountId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'CompanyName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceAssociatedStandardsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceSecurityControlId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ComplianceStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Confidence' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'CreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'Criticality' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'Description' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsConfidence' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'FindingProviderFieldsCriticality' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'FindingProviderFieldsRelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsRelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsSeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsSeverityOriginal' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FindingProviderFieldsTypes' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'FirstObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'GeneratorId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Id' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Keyword' => [
[
'Value' => '<string>',
],
// ...
],
'LastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'MalwareName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwarePath' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwareState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'MalwareType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationDomain' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationPort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NetworkDirection' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkProtocol' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourceDomain' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourceIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceMac' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NetworkSourcePort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NoteText' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'NoteUpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'NoteUpdatedBy' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProcessName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessParentPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessPath' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProcessPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessTerminatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ProductFields' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProductName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RecommendationText' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RecordState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Region' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceImageId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV4Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV6Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceKeyName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceSubnetId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceVpcId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyCreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyPrincipalName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyUserName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamUserUserName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceContainerLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceContainerName' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceDetailsOther' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceId' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourcePartition' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceRegion' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ResourceTags' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Sample' => [
[
'Value' => true || false,
],
// ...
],
'SeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'SeverityNormalized' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SeverityProduct' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorCategory' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorLastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSource' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorType' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorValue' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Title' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'Type' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'UserDefinedFields' => [
[
'Comparison' => 'EQUALS|NOT_EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VerificationState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'WorkflowState' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
'WorkflowStatus' => [
[
'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
'Value' => '<string>',
],
// ...
],
],
'GroupByAttribute' => '<string>',
'InsightArn' => '<string>',
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Insights
-
- Required: Yes
- Type: Array of Insight structures
The insights returned by the operation.
- NextToken
-
- Type: string
The pagination token to use to request the next page of results.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
GetInvitationsCount
$result = $client->getInvitationsCount([/* ... */]); $promise = $client->getInvitationsCountAsync([/* ... */]);
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
Parameter Syntax
$result = $client->getInvitationsCount([ ]);
Parameter Details
Members
Result Syntax
[
'InvitationsCount' => <integer>,
]
Result Details
Members
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
GetMasterAccount
$result = $client->getMasterAccount([/* ... */]); $promise = $client->getMasterAccountAsync([/* ... */]);
This method is deprecated. Instead, use GetAdministratorAccount.
The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount.
Provides the details for the Security Hub 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->getMasterAccount([ ]);
Parameter Details
Members
Result Syntax
[
'Master' => [
'AccountId' => '<string>',
'InvitationId' => '<string>',
'InvitedAt' => <DateTime>,
'MemberStatus' => '<string>',
],
]
Result Details
Members
- Master
-
- Type: Invitation structure
A list of details about the Security Hub administrator account for the current member account.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
GetMembers
$result = $client->getMembers([/* ... */]); $promise = $client->getMembersAsync([/* ... */]);
Returns the details for the Security Hub member accounts for the specified account IDs.
An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.
The results include both member accounts that are managed using Organizations and accounts that were invited manually.
Parameter Syntax
$result = $client->getMembers([
'AccountIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Members' => [
[
'AccountId' => '<string>',
'AdministratorId' => '<string>',
'Email' => '<string>',
'InvitedAt' => <DateTime>,
'MasterId' => '<string>',
'MemberStatus' => '<string>',
'UpdatedAt' => <DateTime>,
],
// ...
],
'UnprocessedAccounts' => [
[
'AccountId' => '<string>',
'ProcessingResult' => '<string>',
],
// ...
],
]
Result Details
Members
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
InviteMembers
$result = $client->inviteMembers([/* ... */]); $promise = $client->inviteMembersAsync([/* ... */]);
Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.
Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.
When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
Parameter Syntax
$result = $client->inviteMembers([
'AccountIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'UnprocessedAccounts' => [
[
'AccountId' => '<string>',
'ProcessingResult' => '<string>',
],
// ...
],
]
Result Details
Members
- UnprocessedAccounts
-
- Type: Array of Result structures
The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
-
The request was rejected because we can't find the specified resource.
ListEnabledProductsForImport
$result = $client->listEnabledProductsForImport([/* ... */]); $promise = $client->listEnabledProductsForImportAsync([/* ... */]);
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
Parameter Syntax
$result = $client->listEnabledProductsForImport([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of items to return in the response.
- NextToken
-
- Type: string
The token that is required for pagination. On your first call to the
ListEnabledProductsForImportoperation, set the value of this parameter toNULL.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>',
'ProductSubscriptions' => ['<string>', ...],
]
Result Details
Members
Errors
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
ListFindingAggregators
$result = $client->listFindingAggregators([/* ... */]); $promise = $client->listFindingAggregatorsAsync([/* ... */]);
If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.
Parameter Syntax
$result = $client->listFindingAggregators([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'FindingAggregators' => [
[
'FindingAggregatorArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- FindingAggregators
-
- Type: Array of FindingAggregator structures
The list of finding aggregators. This operation currently only returns a single result.
- NextToken
-
- Type: string
If there are more results, this is the token to provide in the next call to
ListFindingAggregators.This operation currently only returns a single result.
Errors
-
Internal server error.
-
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.
-
The account doesn't have permission to perform this action.
-
You don't have permission to perform the action specified in the request.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
ListInvitations
$result = $client->listInvitations([/* ... */]); $promise = $client->listInvitationsAsync([/* ... */]);
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
Parameter Syntax
$result = $client->listInvitations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of items to return in the response.
- NextToken
-
- Type: string
The token that is required for pagination. On your first call to the
ListInvitationsoperation, set the value of this parameter toNULL.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
[
'Invitations' => [
[
'AccountId' => '<string>',
'InvitationId' => '<string>',
'InvitedAt' => <DateTime>,
'MemberStatus' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Invitations
-
- Type: Array of Invitation structures
The details of the invitations returned by the operation.
- NextToken
-
- Type: string
The pagination token to use to request the next page of results.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
ListMembers
$result = $client->listMembers([/* ... */]); $promise = $client->listMembersAsync([/* ... */]);
Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
Parameter Syntax
$result = $client->listMembers([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'OnlyAssociated' => true || false,
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of items to return in the response.
- NextToken
-
- Type: string
The token that is required for pagination. On your first call to the
ListMembersoperation, set the value of this parameter toNULL.For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- OnlyAssociated
-
- Type: boolean
Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is
TRUE.If
OnlyAssociatedis set toTRUE, the response includes member accounts whose relationship status with the administrator account is set toENABLED.If
OnlyAssociatedis set toFALSE, the response includes all existing member accounts.
Result Syntax
[
'Members' => [
[
'AccountId' => '<string>',
'AdministratorId' => '<string>',
'Email' => '<string>',
'InvitedAt' => <DateTime>,
'MasterId' => '<string>',
'MemberStatus' => '<string>',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Members
-
- Type: Array of Member structures
Member details returned by the operation.
- NextToken
-
- Type: string
The pagination token to use to request the next page of results.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
ListOrganizationAdminAccounts
$result = $client->listOrganizationAdminAccounts([/* ... */]); $promise = $client->listOrganizationAdminAccountsAsync([/* ... */]);
Lists the Security Hub administrator accounts. Can only be called by the organization management account.
Parameter Syntax
$result = $client->listOrganizationAdminAccounts([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of items to return in the response.
- NextToken
-
- Type: string
The token that is required for pagination. On your first call to the
ListOrganizationAdminAccountsoperation, set the value of this parameter toNULL. 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
[
'AdminAccounts' => [
[
'AccountId' => '<string>',
'Status' => 'ENABLED|DISABLE_IN_PROGRESS',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AdminAccounts
-
- Type: Array of AdminAccount structures
The list of Security Hub administrator accounts.
- NextToken
-
- Type: string
The pagination token to use to request the next page of results.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
ListSecurityControlDefinitions
$result = $client->listSecurityControlDefinitions([/* ... */]); $promise = $client->listSecurityControlDefinitionsAsync([/* ... */]);
Lists all of the security controls that apply to a specified standard.
Parameter Syntax
$result = $client->listSecurityControlDefinitions([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'StandardsArn' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 security controls that apply to the specified standard. The results also include a
NextTokenparameter that you can use in a subsequent API call to get the next 25 controls. This repeats until all controls for the standard are returned. - NextToken
-
- Type: string
Optional pagination parameter.
- StandardsArn
-
- Type: string
The Amazon Resource Name (ARN) of the standard that you want to view controls for.
Result Syntax
[
'NextToken' => '<string>',
'SecurityControlDefinitions' => [
[
'CurrentRegionAvailability' => 'AVAILABLE|UNAVAILABLE',
'Description' => '<string>',
'RemediationUrl' => '<string>',
'SecurityControlId' => '<string>',
'SeverityRating' => 'LOW|MEDIUM|HIGH|CRITICAL',
'Title' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A pagination parameter that's included in the response only if it was included in the request.
- SecurityControlDefinitions
-
- Required: Yes
- Type: Array of SecurityControlDefinition structures
An array of controls that apply to the specified standard.
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
The account doesn't have permission to perform this action.
-
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.
ListStandardsControlAssociations
$result = $client->listStandardsControlAssociations([/* ... */]); $promise = $client->listStandardsControlAssociationsAsync([/* ... */]);
Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
Parameter Syntax
$result = $client->listStandardsControlAssociations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SecurityControlId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 standard and control associations. The results also include a
NextTokenparameter that you can use in a subsequent API call to get the next 25 associations. This repeats until all associations for the specified control are returned. The number of results is limited by the number of supported Security Hub standards that you've enabled in the calling account. - NextToken
-
- Type: string
Optional pagination parameter.
- SecurityControlId
-
- Required: Yes
- Type: string
The identifier of the control (identified with
SecurityControlId,SecurityControlArn, or a mix of both parameters) that you want to determine the enablement status of in each enabled standard.
Result Syntax
[
'NextToken' => '<string>',
'StandardsControlAssociationSummaries' => [
[
'AssociationStatus' => 'ENABLED|DISABLED',
'RelatedRequirements' => ['<string>', ...],
'SecurityControlArn' => '<string>',
'SecurityControlId' => '<string>',
'StandardsArn' => '<string>',
'StandardsControlDescription' => '<string>',
'StandardsControlTitle' => '<string>',
'UpdatedAt' => <DateTime>,
'UpdatedReason' => '<string>',
],
// ...
],
]