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 */).
- AcceptInvitation ( array $params = [] )
Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from.
- BatchDisableStandards ( array $params = [] )
Disables the standards specified by the provided StandardsSubscriptionArns.
- BatchEnableStandards ( array $params = [] )
Enables the standards specified by the provided StandardsArn.
- BatchImportFindings ( array $params = [] )
Imports security findings generated from an integrated third-party product into Security Hub.
- BatchUpdateFindings ( array $params = [] )
Used by Security Hub customers to update information about their investigation into a finding.
- CreateActionTarget ( array $params = [] )
Creates a custom action target in Security Hub.
- 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 master account.
- DeclineInvitations ( array $params = [] )
Declines invitations to become a member account.
- DeleteActionTarget ( array $params = [] )
Deletes a custom action target from Security Hub.
- DeleteInsight ( array $params = [] )
Deletes the insight specified by the InsightArn.
- DeleteInvitations ( array $params = [] )
Deletes invitations received by the AWS 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.
- DescribeProducts ( array $params = [] )
Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.
- 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.
- DisableSecurityHub ( array $params = [] )
Disables Security Hub in your account only in the current Region.
- DisassociateFromMasterAccount ( array $params = [] )
Disassociates the current Security Hub member account from the associated master account.
- DisassociateMembers ( array $params = [] )
Disassociates the specified member accounts from the associated master account.
- EnableImportFindingsForProduct ( array $params = [] )
Enables the integration of a partner product with Security Hub.
- EnableSecurityHub ( array $params = [] )
Enables Security Hub for your account in the current Region or the Region you specify in the request.
- GetEnabledStandards ( array $params = [] )
Returns a list of the standards that are currently enabled.
- 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 = [] )
Provides the details for the Security Hub master account for the current member account.
- GetMembers ( array $params = [] )
Returns the details for the Security Hub member accounts for the specified account IDs.
- InviteMembers ( array $params = [] )
Invites other AWS accounts to become member accounts for the Security Hub master 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.
- ListInvitations ( array $params = [] )
Lists all Security Hub membership invitations that were sent to the current AWS account.
- ListMembers ( array $params = [] )
Lists details about all member accounts for the current Security Hub master 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.
- UpdateFindings ( array $params = [] )
UpdateFindings is deprecated.
- UpdateInsight ( array $params = [] )
Updates the Security Hub insight identified by the specified insight ARN.
- 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:
Operations
AcceptInvitation
$result = $client->acceptInvitation([/* ... */]); $promise = $client->acceptInvitationAsync([/* ... */]);
Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from.
When the member account accepts the invitation, permission is granted to the master 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
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 AWS account limits. The error code describes the limit exceeded.
-
The request was rejected because we can't find the specified resource.
-
AWS Security Hub isn't enabled for the account used to make this request.
BatchDisableStandards
$result = $client->batchDisableStandards([/* ... */]); $promise = $client->batchDisableStandardsAsync([/* ... */]);
Disables the standards specified by the provided StandardsSubscriptionArns.
For more information, see Security Standards section of the AWS 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',
'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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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 AWS 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',
'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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
BatchImportFindings
$result = $client->batchImportFindings([/* ... */]); $promise = $client->batchImportFindingsAsync([/* ... */]);
Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.
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.
-
Confidence -
Criticality -
Note -
RelatedFindings -
Severity -
Types -
UserDefinedFields -
VerificationState -
Workflow
Parameter Syntax
$result = $client->batchImportFindings([
'Findings' => [ // REQUIRED
[
'AwsAccountId' => '<string>', // REQUIRED
'Compliance' => [
'RelatedRequirements' => ['<string>', ...],
'Status' => 'PASSED|WARNING|FAILED|NOT_AVAILABLE',
'StatusReasons' => [
[
'Description' => '<string>',
'ReasonCode' => '<string>', // REQUIRED
],
// ...
],
],
'Confidence' => <integer>,
'CreatedAt' => '<string>', // REQUIRED
'Criticality' => <integer>,
'Description' => '<string>', // REQUIRED
'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
],
'Process' => [
'LaunchedAt' => '<string>',
'Name' => '<string>',
'ParentPid' => <integer>,
'Path' => '<string>',
'Pid' => <integer>,
'TerminatedAt' => '<string>',
],
'ProductArn' => '<string>', // REQUIRED
'ProductFields' => ['<string>', ...],
'RecordState' => 'ACTIVE|ARCHIVED',
'RelatedFindings' => [
[
'Id' => '<string>', // REQUIRED
'ProductArn' => '<string>', // REQUIRED
],
// ...
],
'Remediation' => [
'Recommendation' => [
'Text' => '<string>',
'Url' => '<string>',
],
],
'Resources' => [ // REQUIRED
[
'Details' => [
'AwsAutoScalingAutoScalingGroup' => [
'CreatedTime' => '<string>',
'HealthCheckGracePeriod' => <integer>,
'HealthCheckType' => '<string>',
'LaunchConfigurationName' => '<string>',
'LoadBalancerNames' => ['<string>', ...],
],
'AwsCloudFrontDistribution' => [
'DomainName' => '<string>',
'ETag' => '<string>',
'LastModifiedTime' => '<string>',
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'IncludeCookies' => true || false,
'Prefix' => '<string>',
],
'Origins' => [
'Items' => [
[
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
],
// ...
],
],
'Status' => '<string>',
'WebAclId' => '<string>',
],
'AwsCodeBuildProject' => [
'EncryptionKey' => '<string>',
'Environment' => [
'Certificate' => '<string>',
'ImagePullCredentialsType' => '<string>',
'RegistryCredential' => [
'Credential' => '<string>',
'CredentialProvider' => '<string>',
],
'Type' => '<string>',
],
'Name' => '<string>',
'ServiceRole' => '<string>',
'Source' => [
'GitCloneDepth' => <integer>,
'InsecureSsl' => true || false,
'Location' => '<string>',
'Type' => '<string>',
],
'VpcConfig' => [
'SecurityGroupIds' => ['<string>', ...],
'Subnets' => ['<string>', ...],
'VpcId' => '<string>',
],
],
'AwsEc2Instance' => [
'IamInstanceProfileArn' => '<string>',
'ImageId' => '<string>',
'IpV4Addresses' => ['<string>', ...],
'IpV6Addresses' => ['<string>', ...],
'KeyName' => '<string>',
'LaunchedAt' => '<string>',
'SubnetId' => '<string>',
'Type' => '<string>',
'VpcId' => '<string>',
],
'AwsEc2NetworkInterface' => [
'Attachment' => [
'AttachTime' => '<string>',
'AttachmentId' => '<string>',
'DeleteOnTermination' => true || false,
'DeviceIndex' => <integer>,
'InstanceId' => '<string>',
'InstanceOwnerId' => '<string>',
'Status' => '<string>',
],
'NetworkInterfaceId' => '<string>',
'SecurityGroups' => [
[
'GroupId' => '<string>',
'GroupName' => '<string>',
],
// ...
],
'SourceDestCheck' => true || false,
],
'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>',
],
'AwsEc2Volume' => [
'Attachments' => [
[
'AttachTime' => '<string>',
'DeleteOnTermination' => true || false,
'InstanceId' => '<string>',
'Status' => '<string>',
],
// ...
],
'CreateTime' => '<string>',
'Encrypted' => true || false,
'KmsKeyId' => '<string>',
'Size' => <integer>,
'SnapshotId' => '<string>',
'Status' => '<string>',
],
'AwsEc2Vpc' => [
'CidrBlockAssociationSet' => [
[
'AssociationId' => '<string>',
'CidrBlock' => '<string>',
'CidrBlockState' => '<string>',
],
// ...
],
'DhcpOptionsId' => '<string>',
'Ipv6CidrBlockAssociationSet' => [
[
'AssociationId' => '<string>',
'CidrBlockState' => '<string>',
'Ipv6CidrBlock' => '<string>',
],
// ...
],
'State' => '<string>',
],
'AwsElasticsearchDomain' => [
'AccessPolicies' => '<string>',
'DomainEndpointOptions' => [
'EnforceHTTPS' => true || false,
'TLSSecurityPolicy' => '<string>',
],
'DomainId' => '<string>',
'DomainName' => '<string>',
'ElasticsearchVersion' => '<string>',
'EncryptionAtRestOptions' => [
'Enabled' => true || false,
'KmsKeyId' => '<string>',
],
'Endpoint' => '<string>',
'Endpoints' => ['<string>', ...],
'NodeToNodeEncryptionOptions' => [
'Enabled' => true || false,
],
'VPCOptions' => [
'AvailabilityZones' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VPCId' => '<string>',
],
],
'AwsElbv2LoadBalancer' => [
'AvailabilityZones' => [
[
'SubnetId' => '<string>',
'ZoneName' => '<string>',
],
// ...
],
'CanonicalHostedZoneId' => '<string>',
'CreatedTime' => '<string>',
'DNSName' => '<string>',
'IpAddressType' => '<string>',
'Scheme' => '<string>',
'SecurityGroups' => ['<string>', ...],
'State' => [
'Code' => '<string>',
'Reason' => '<string>',
],
'Type' => '<string>',
'VpcId' => '<string>',
],
'AwsIamAccessKey' => [
'CreatedAt' => '<string>',
'PrincipalId' => '<string>',
'PrincipalName' => '<string>',
'PrincipalType' => '<string>',
'Status' => 'Active|Inactive',
'UserName' => '<string>',
],
'AwsIamRole' => [
'AssumeRolePolicyDocument' => '<string>',
'CreateDate' => '<string>',
'MaxSessionDuration' => <integer>,
'Path' => '<string>',
'RoleId' => '<string>',
'RoleName' => '<string>',
],
'AwsKmsKey' => [
'AWSAccountId' => '<string>',
'CreationDate' => <float>,
'KeyId' => '<string>',
'KeyManager' => '<string>',
'KeyState' => '<string>',
'Origin' => '<string>',
],
'AwsLambdaFunction' => [
'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>,
'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>,
],
'AwsRdsDbInstance' => [
'AssociatedRoles' => [
[
'FeatureName' => '<string>',
'RoleArn' => '<string>',
'Status' => '<string>',
],
// ...
],
'CACertificateIdentifier' => '<string>',
'DBClusterIdentifier' => '<string>',
'DBInstanceClass' => '<string>',
'DBInstanceIdentifier' => '<string>',
'DBName' => '<string>',
'DbInstancePort' => <integer>,
'DbiResourceId' => '<string>',
'DeletionProtection' => true || false,
'Endpoint' => [
'Address' => '<string>',
'HostedZoneId' => '<string>',
'Port' => <integer>,
],
'Engine' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => '<string>',
'KmsKeyId' => '<string>',
'PubliclyAccessible' => true || false,
'StorageEncrypted' => true || false,
'TdeCredentialArn' => '<string>',
'VpcSecurityGroups' => [
[
'Status' => '<string>',
'VpcSecurityGroupId' => '<string>',
],
// ...
],
],
'AwsS3Bucket' => [
'CreatedAt' => '<string>',
'OwnerId' => '<string>',
'OwnerName' => '<string>',
'ServerSideEncryptionConfiguration' => [
'Rules' => [
[
'ApplyServerSideEncryptionByDefault' => [
'KMSMasterKeyID' => '<string>',
'SSEAlgorithm' => '<string>',
],
],
// ...
],
],
],
'AwsS3Object' => [
'ContentType' => '<string>',
'ETag' => '<string>',
'LastModified' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => '<string>',
'VersionId' => '<string>',
],
'AwsSnsTopic' => [
'KmsMasterKeyId' => '<string>',
'Owner' => '<string>',
'Subscription' => [
[
'Endpoint' => '<string>',
'Protocol' => '<string>',
],
// ...
],
'TopicName' => '<string>',
],
'AwsSqsQueue' => [
'DeadLetterTargetArn' => '<string>',
'KmsDataKeyReusePeriodSeconds' => <integer>,
'KmsMasterKeyId' => '<string>',
'QueueName' => '<string>',
],
'AwsWafWebAcl' => [
'DefaultAction' => '<string>',
'Name' => '<string>',
'Rules' => [
[
'Action' => [
'Type' => '<string>',
],
'ExcludedRules' => [
[
'RuleId' => '<string>',
],
// ...
],
'OverrideAction' => [
'Type' => '<string>',
],
'Priority' => <integer>,
'RuleId' => '<string>',
'Type' => '<string>',
],
// ...
],
'WebAclId' => '<string>',
],
'Container' => [
'ImageId' => '<string>',
'ImageName' => '<string>',
'LaunchedAt' => '<string>',
'Name' => '<string>',
],
'Other' => ['<string>', ...],
],
'Id' => '<string>', // REQUIRED
'Partition' => 'aws|aws-cn|aws-us-gov',
'Region' => '<string>',
'Tags' => ['<string>', ...],
'Type' => '<string>', // REQUIRED
],
// ...
],
'SchemaVersion' => '<string>', // REQUIRED
'Severity' => [ // REQUIRED
'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>',
],
// ...
],
'Title' => '<string>', // REQUIRED
'Types' => ['<string>', ...], // REQUIRED
'UpdatedAt' => '<string>', // REQUIRED
'UserDefinedFields' => ['<string>', ...],
'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
'Vulnerabilities' => [
[
'Cvss' => [
[
'BaseScore' => <float>,
'BaseVector' => '<string>',
'Version' => '<string>',
],
// ...
],
'Id' => '<string>', // REQUIRED
'ReferenceUrls' => ['<string>', ...],
'RelatedVulnerabilities' => ['<string>', ...],
'Vendor' => [
'Name' => '<string>', // REQUIRED
'Url' => '<string>',
'VendorCreatedAt' => '<string>',
'VendorSeverity' => '<string>',
'VendorUpdatedAt' => '<string>',
],
'VulnerablePackages' => [
[
'Architecture' => '<string>',
'Epoch' => '<string>',
'Name' => '<string>',
'Release' => '<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 AWS 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 AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
BatchUpdateFindings
$result = $client->batchUpdateFindings([/* ... */]); $promise = $client->batchUpdateFindingsAsync([/* ... */]);
Used by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master 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.
Master accounts can use BatchUpdateFindings to update the following finding fields and objects.
-
Confidence -
Criticality -
Note -
RelatedFindings -
Severity -
Types -
UserDefinedFields -
VerificationState -
Workflow
Member accounts can only use BatchUpdateFindings to update the Note object.
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 AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
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
Result Syntax
[
'ActionTargetArn' => '<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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
-
The resource specified in the request conflicts with an existing resource.
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',
'Value' => '<string>',
],
// ...
],
'CompanyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ComplianceStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'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',
'Value' => '<string>',
],
// ...
],
'FirstObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'GeneratorId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Id' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Keyword' => [
[
'Value' => '<string>',
],
// ...
],
'LastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'MalwareName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwarePath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationPort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NetworkDirection' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkProtocol' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceMac' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourcePort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NoteText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NoteUpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'NoteUpdatedBy' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProcessName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessParentPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessPath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessTerminatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProductFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProductName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecommendationText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecordState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV4Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV6Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceKeyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceSubnetId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceVpcId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyCreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyUserName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceContainerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceDetailsOther' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourcePartition' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceRegion' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceTags' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityNormalized' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SeverityProduct' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorCategory' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorLastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSource' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorValue' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Title' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Type' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'UserDefinedFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VerificationState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'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 AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
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 master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.
After you use CreateMembers to create member account associations in Security Hub, you must use the InviteMembers operation to invite the accounts to enable Security Hub and become member accounts in Security Hub.
If the account owner accepts the invitation, the account becomes a member account in Security Hub. A permissions policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start to be sent to both the member and master accounts.
To remove the association between the master and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
Parameter Syntax
$result = $client->createMembers([
'AccountDetails' => [
[
'AccountId' => '<string>',
'Email' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- AccountDetails
-
- Type: Array of AccountDetails structures
The list of accounts to associate with the Security Hub master account. For each account, the list includes the account ID and the email address.
Result Syntax
[
'UnprocessedAccounts' => [
[
'AccountId' => '<string>',
'ProcessingResult' => '<string>',
],
// ...
],
]
Result Details
Members
- UnprocessedAccounts
-
- Type: Array of Result structures
The list of AWS 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 AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
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.
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 AWS 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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
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
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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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 AWS account to become a member account.
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 AWS 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 AWS account limits. The error code describes the limit exceeded.
-
The request was rejected because we can't find the specified resource.
-
AWS Security Hub isn't enabled for the account used to make this request.
DeleteMembers
$result = $client->deleteMembers([/* ... */]); $promise = $client->deleteMembersAsync([/* ... */]);
Deletes the specified member accounts from Security Hub.
Parameter Syntax
$result = $client->deleteMembers([
'AccountIds' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[
'UnprocessedAccounts' => [
[
'AccountId' => '<string>',
'ProcessingResult' => '<string>',
],
// ...
],
]
Result Details
Members
- UnprocessedAccounts
-
- Type: Array of Result structures
The list of AWS 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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
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,
'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. - 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 AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this 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.
DescribeProducts
$result = $client->describeProducts([/* ... */]); $promise = $client->describeProductsAsync([/* ... */]);
Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.
Parameter Syntax
$result = $client->describeProducts([
'MaxResults' => <integer>,
'NextToken' => '<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.
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 AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
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>',
],
// ...
],
]
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.
-
AWS Security Hub isn't enabled for the account used to make this request.
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.
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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
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
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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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 a master 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 master 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
Errors
-
Internal server error.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because we can't find the specified resource.
DisassociateFromMasterAccount
$result = $client->disassociateFromMasterAccount([/* ... */]); $promise = $client->disassociateFromMasterAccountAsync([/* ... */]);
Disassociates the current Security Hub member account from the associated master account.
Parameter Syntax
$result = $client->disassociateFromMasterAccount([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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 master account.
Parameter Syntax
$result = $client->disassociateMembers([
'AccountIds' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The resource specified in the request conflicts with an existing resource.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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.
-
CIS AWS Foundations
-
AWS Foundational Security Best Practices
You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard.
To not enable the 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 Setting Up AWS Security Hub in the AWS Security Hub User Guide.
Parameter Syntax
$result = $client->enableSecurityHub([
'EnableDefaultStandards' => true || false,
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- 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
Errors
-
Internal server error.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The resource specified in the request conflicts with an existing resource.
-
You don't have permission to perform the action specified in the request.
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',
'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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
GetFindings
$result = $client->getFindings([/* ... */]); $promise = $client->getFindingsAsync([/* ... */]);
Returns a list of findings that match the specified criteria.
Parameter Syntax
$result = $client->getFindings([
'Filters' => [
'AwsAccountId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'CompanyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ComplianceStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'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',
'Value' => '<string>',
],
// ...
],
'FirstObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'GeneratorId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Id' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Keyword' => [
[
'Value' => '<string>',
],
// ...
],
'LastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'MalwareName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwarePath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationPort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NetworkDirection' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkProtocol' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceMac' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourcePort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NoteText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NoteUpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'NoteUpdatedBy' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProcessName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessParentPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessPath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessTerminatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProductFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProductName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecommendationText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecordState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV4Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV6Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceKeyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceSubnetId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceVpcId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyCreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyUserName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceContainerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceDetailsOther' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourcePartition' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceRegion' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceTags' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityNormalized' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SeverityProduct' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorCategory' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorLastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSource' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorValue' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Title' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Type' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'UserDefinedFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VerificationState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'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.
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' => [
[
'AwsAccountId' => '<string>',
'Compliance' => [
'RelatedRequirements' => ['<string>', ...],
'Status' => 'PASSED|WARNING|FAILED|NOT_AVAILABLE',
'StatusReasons' => [
[
'Description' => '<string>',
'ReasonCode' => '<string>',
],
// ...
],
],
'Confidence' => <integer>,
'CreatedAt' => '<string>',
'Criticality' => <integer>,
'Description' => '<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>',
],
'Process' => [
'LaunchedAt' => '<string>',
'Name' => '<string>',
'ParentPid' => <integer>,
'Path' => '<string>',
'Pid' => <integer>,
'TerminatedAt' => '<string>',
],
'ProductArn' => '<string>',
'ProductFields' => ['<string>', ...],
'RecordState' => 'ACTIVE|ARCHIVED',
'RelatedFindings' => [
[
'Id' => '<string>',
'ProductArn' => '<string>',
],
// ...
],
'Remediation' => [
'Recommendation' => [
'Text' => '<string>',
'Url' => '<string>',
],
],
'Resources' => [
[
'Details' => [
'AwsAutoScalingAutoScalingGroup' => [
'CreatedTime' => '<string>',
'HealthCheckGracePeriod' => <integer>,
'HealthCheckType' => '<string>',
'LaunchConfigurationName' => '<string>',
'LoadBalancerNames' => ['<string>', ...],
],
'AwsCloudFrontDistribution' => [
'DomainName' => '<string>',
'ETag' => '<string>',
'LastModifiedTime' => '<string>',
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'IncludeCookies' => true || false,
'Prefix' => '<string>',
],
'Origins' => [
'Items' => [
[
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
],
// ...
],
],
'Status' => '<string>',
'WebAclId' => '<string>',
],
'AwsCodeBuildProject' => [
'EncryptionKey' => '<string>',
'Environment' => [
'Certificate' => '<string>',
'ImagePullCredentialsType' => '<string>',
'RegistryCredential' => [
'Credential' => '<string>',
'CredentialProvider' => '<string>',
],
'Type' => '<string>',
],
'Name' => '<string>',
'ServiceRole' => '<string>',
'Source' => [
'GitCloneDepth' => <integer>,
'InsecureSsl' => true || false,
'Location' => '<string>',
'Type' => '<string>',
],
'VpcConfig' => [
'SecurityGroupIds' => ['<string>', ...],
'Subnets' => ['<string>', ...],
'VpcId' => '<string>',
],
],
'AwsEc2Instance' => [
'IamInstanceProfileArn' => '<string>',
'ImageId' => '<string>',
'IpV4Addresses' => ['<string>', ...],
'IpV6Addresses' => ['<string>', ...],
'KeyName' => '<string>',
'LaunchedAt' => '<string>',
'SubnetId' => '<string>',
'Type' => '<string>',
'VpcId' => '<string>',
],
'AwsEc2NetworkInterface' => [
'Attachment' => [
'AttachTime' => '<string>',
'AttachmentId' => '<string>',
'DeleteOnTermination' => true || false,
'DeviceIndex' => <integer>,
'InstanceId' => '<string>',
'InstanceOwnerId' => '<string>',
'Status' => '<string>',
],
'NetworkInterfaceId' => '<string>',
'SecurityGroups' => [
[
'GroupId' => '<string>',
'GroupName' => '<string>',
],
// ...
],
'SourceDestCheck' => true || false,
],
'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>',
],
'AwsEc2Volume' => [
'Attachments' => [
[
'AttachTime' => '<string>',
'DeleteOnTermination' => true || false,
'InstanceId' => '<string>',
'Status' => '<string>',
],
// ...
],
'CreateTime' => '<string>',
'Encrypted' => true || false,
'KmsKeyId' => '<string>',
'Size' => <integer>,
'SnapshotId' => '<string>',
'Status' => '<string>',
],
'AwsEc2Vpc' => [
'CidrBlockAssociationSet' => [
[
'AssociationId' => '<string>',
'CidrBlock' => '<string>',
'CidrBlockState' => '<string>',
],
// ...
],
'DhcpOptionsId' => '<string>',
'Ipv6CidrBlockAssociationSet' => [
[
'AssociationId' => '<string>',
'CidrBlockState' => '<string>',
'Ipv6CidrBlock' => '<string>',
],
// ...
],
'State' => '<string>',
],
'AwsElasticsearchDomain' => [
'AccessPolicies' => '<string>',
'DomainEndpointOptions' => [
'EnforceHTTPS' => true || false,
'TLSSecurityPolicy' => '<string>',
],
'DomainId' => '<string>',
'DomainName' => '<string>',
'ElasticsearchVersion' => '<string>',
'EncryptionAtRestOptions' => [
'Enabled' => true || false,
'KmsKeyId' => '<string>',
],
'Endpoint' => '<string>',
'Endpoints' => ['<string>', ...],
'NodeToNodeEncryptionOptions' => [
'Enabled' => true || false,
],
'VPCOptions' => [
'AvailabilityZones' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VPCId' => '<string>',
],
],
'AwsElbv2LoadBalancer' => [
'AvailabilityZones' => [
[
'SubnetId' => '<string>',
'ZoneName' => '<string>',
],
// ...
],
'CanonicalHostedZoneId' => '<string>',
'CreatedTime' => '<string>',
'DNSName' => '<string>',
'IpAddressType' => '<string>',
'Scheme' => '<string>',
'SecurityGroups' => ['<string>', ...],
'State' => [
'Code' => '<string>',
'Reason' => '<string>',
],
'Type' => '<string>',
'VpcId' => '<string>',
],
'AwsIamAccessKey' => [
'CreatedAt' => '<string>',
'PrincipalId' => '<string>',
'PrincipalName' => '<string>',
'PrincipalType' => '<string>',
'Status' => 'Active|Inactive',
'UserName' => '<string>',
],
'AwsIamRole' => [
'AssumeRolePolicyDocument' => '<string>',
'CreateDate' => '<string>',
'MaxSessionDuration' => <integer>,
'Path' => '<string>',
'RoleId' => '<string>',
'RoleName' => '<string>',
],
'AwsKmsKey' => [
'AWSAccountId' => '<string>',
'CreationDate' => <float>,
'KeyId' => '<string>',
'KeyManager' => '<string>',
'KeyState' => '<string>',
'Origin' => '<string>',
],
'AwsLambdaFunction' => [
'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>,
'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>,
],
'AwsRdsDbInstance' => [
'AssociatedRoles' => [
[
'FeatureName' => '<string>',
'RoleArn' => '<string>',
'Status' => '<string>',
],
// ...
],
'CACertificateIdentifier' => '<string>',
'DBClusterIdentifier' => '<string>',
'DBInstanceClass' => '<string>',
'DBInstanceIdentifier' => '<string>',
'DBName' => '<string>',
'DbInstancePort' => <integer>,
'DbiResourceId' => '<string>',
'DeletionProtection' => true || false,
'Endpoint' => [
'Address' => '<string>',
'HostedZoneId' => '<string>',
'Port' => <integer>,
],
'Engine' => '<string>',
'EngineVersion' => '<string>',
'IAMDatabaseAuthenticationEnabled' => true || false,
'InstanceCreateTime' => '<string>',
'KmsKeyId' => '<string>',
'PubliclyAccessible' => true || false,
'StorageEncrypted' => true || false,
'TdeCredentialArn' => '<string>',
'VpcSecurityGroups' => [
[
'Status' => '<string>',
'VpcSecurityGroupId' => '<string>',
],
// ...
],
],
'AwsS3Bucket' => [
'CreatedAt' => '<string>',
'OwnerId' => '<string>',
'OwnerName' => '<string>',
'ServerSideEncryptionConfiguration' => [
'Rules' => [
[
'ApplyServerSideEncryptionByDefault' => [
'KMSMasterKeyID' => '<string>',
'SSEAlgorithm' => '<string>',
],
],
// ...
],
],
],
'AwsS3Object' => [
'ContentType' => '<string>',
'ETag' => '<string>',
'LastModified' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => '<string>',
'VersionId' => '<string>',
],
'AwsSnsTopic' => [
'KmsMasterKeyId' => '<string>',
'Owner' => '<string>',
'Subscription' => [
[
'Endpoint' => '<string>',
'Protocol' => '<string>',
],
// ...
],
'TopicName' => '<string>',
],
'AwsSqsQueue' => [
'DeadLetterTargetArn' => '<string>',
'KmsDataKeyReusePeriodSeconds' => <integer>,
'KmsMasterKeyId' => '<string>',
'QueueName' => '<string>',
],
'AwsWafWebAcl' => [
'DefaultAction' => '<string>',
'Name' => '<string>',
'Rules' => [
[
'Action' => [
'Type' => '<string>',
],
'ExcludedRules' => [
[
'RuleId' => '<string>',
],
// ...
],
'OverrideAction' => [
'Type' => '<string>',
],
'Priority' => <integer>,
'RuleId' => '<string>',
'Type' => '<string>',
],
// ...
],
'WebAclId' => '<string>',
],
'Container' => [
'ImageId' => '<string>',
'ImageName' => '<string>',
'LaunchedAt' => '<string>',
'Name' => '<string>',
],
'Other' => ['<string>', ...],
],
'Id' => '<string>',
'Partition' => 'aws|aws-cn|aws-us-gov',
'Region' => '<string>',
'Tags' => ['<string>', ...],
'Type' => '<string>',
],
// ...
],
'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>',
],
// ...
],
'Title' => '<string>',
'Types' => ['<string>', ...],
'UpdatedAt' => '<string>',
'UserDefinedFields' => ['<string>', ...],
'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
'Vulnerabilities' => [
[
'Cvss' => [
[
'BaseScore' => <float>,
'BaseVector' => '<string>',
'Version' => '<string>',
],
// ...
],
'Id' => '<string>',
'ReferenceUrls' => ['<string>', ...],
'RelatedVulnerabilities' => ['<string>', ...],
'Vendor' => [
'Name' => '<string>',
'Url' => '<string>',
'VendorCreatedAt' => '<string>',
'VendorSeverity' => '<string>',
'VendorUpdatedAt' => '<string>',
],
'VulnerablePackages' => [
[
'Architecture' => '<string>',
'Epoch' => '<string>',
'Name' => '<string>',
'Release' => '<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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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',
'Value' => '<string>',
],
// ...
],
'CompanyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ComplianceStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'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',
'Value' => '<string>',
],
// ...
],
'FirstObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'GeneratorId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Id' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Keyword' => [
[
'Value' => '<string>',
],
// ...
],
'LastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'MalwareName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwarePath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationPort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NetworkDirection' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkProtocol' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceMac' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourcePort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NoteText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NoteUpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'NoteUpdatedBy' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProcessName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessParentPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessPath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessTerminatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProductFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProductName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecommendationText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecordState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV4Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV6Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceKeyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceSubnetId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceVpcId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyCreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyUserName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceContainerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceDetailsOther' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourcePartition' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceRegion' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceTags' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityNormalized' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SeverityProduct' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorCategory' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorLastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSource' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorValue' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Title' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Type' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'UserDefinedFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VerificationState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
GetMasterAccount
$result = $client->getMasterAccount([/* ... */]); $promise = $client->getMasterAccountAsync([/* ... */]);
Provides the details for the Security Hub master account for the current member account.
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 master 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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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.
Parameter Syntax
$result = $client->getMembers([
'AccountIds' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Members' => [
[
'AccountId' => '<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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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 AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.
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 accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from the member account.
Parameter Syntax
$result = $client->inviteMembers([
'AccountIds' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[
'UnprocessedAccounts' => [
[
'AccountId' => '<string>',
'ProcessingResult' => '<string>',
],
// ...
],
]
Result Details
Members
- UnprocessedAccounts
-
- Type: Array of Result structures
The list of AWS 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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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 AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
ListInvitations
$result = $client->listInvitations([/* ... */]); $promise = $client->listInvitationsAsync([/* ... */]);
Lists all Security Hub membership invitations that were sent to the current AWS account.
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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account 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 master account.
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 master account. The default value is
TRUE.If
OnlyAssociatedis set toTRUE, the response includes member accounts whose relationship status with the master is set toENABLEDorDISABLED.If
OnlyAssociatedis set toFALSE, the response includes all existing member accounts.
Result Syntax
[
'Members' => [
[
'AccountId' => '<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.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Returns a list of tags associated with a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<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 request was rejected because we can't find the specified resource.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds one or more tags to a resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
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 we can't find the specified resource.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes one or more tags from a resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
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 we can't find the specified resource.
UpdateActionTarget
$result = $client->updateActionTarget([/* ... */]); $promise = $client->updateActionTargetAsync([/* ... */]);
Updates the name and description of a custom action target in Security Hub.
Parameter Syntax
$result = $client->updateActionTarget([
'ActionTargetArn' => '<string>', // REQUIRED
'Description' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
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 we can't find the specified resource.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because we can't find the specified resource.
UpdateFindings
$result = $client->updateFindings([/* ... */]); $promise = $client->updateFindingsAsync([/* ... */]);
UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings.
Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
Parameter Syntax
$result = $client->updateFindings([
'Filters' => [ // REQUIRED
'AwsAccountId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'CompanyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ComplianceStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'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',
'Value' => '<string>',
],
// ...
],
'FirstObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'GeneratorId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Id' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Keyword' => [
[
'Value' => '<string>',
],
// ...
],
'LastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'MalwareName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwarePath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationPort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NetworkDirection' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkProtocol' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceMac' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourcePort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NoteText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NoteUpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'NoteUpdatedBy' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProcessName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessParentPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessPath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessTerminatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProductFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProductName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecommendationText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecordState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV4Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV6Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceKeyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceSubnetId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceVpcId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyCreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyUserName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceContainerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceDetailsOther' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourcePartition' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceRegion' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceTags' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityNormalized' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SeverityProduct' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorCategory' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorLastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSource' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorValue' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Title' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Type' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'UserDefinedFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VerificationState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
],
'Note' => [
'Text' => '<string>', // REQUIRED
'UpdatedBy' => '<string>', // REQUIRED
],
'RecordState' => 'ACTIVE|ARCHIVED',
]);
Parameter Details
Members
- Filters
-
- Required: Yes
- Type: AwsSecurityFindingFilters structure
A collection of attributes that specify which findings you want to update.
- Note
-
- Type: NoteUpdate structure
The updated note for the finding.
- RecordState
-
- Type: string
The updated record state for the finding.
Result Syntax
[]
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 AWS account limits. The error code describes the limit exceeded.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because we can't find the specified resource.
UpdateInsight
$result = $client->updateInsight([/* ... */]); $promise = $client->updateInsightAsync([/* ... */]);
Updates the Security Hub insight identified by the specified insight ARN.
Parameter Syntax
$result = $client->updateInsight([
'Filters' => [
'AwsAccountId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'CompanyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ComplianceStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'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',
'Value' => '<string>',
],
// ...
],
'FirstObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'GeneratorId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Id' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Keyword' => [
[
'Value' => '<string>',
],
// ...
],
'LastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'MalwareName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwarePath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'MalwareType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkDestinationIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkDestinationPort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NetworkDirection' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkProtocol' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceDomain' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourceIpV4' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceIpV6' => [
[
'Cidr' => '<string>',
],
// ...
],
'NetworkSourceMac' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NetworkSourcePort' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'NoteText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'NoteUpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'NoteUpdatedBy' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProcessName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessParentPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessPath' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProcessPid' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'ProcessTerminatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ProductFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProductName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecommendationText' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RecordState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'RelatedFindingsProductArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV4Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceIpV6Addresses' => [
[
'Cidr' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceKeyName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceSubnetId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsEc2InstanceVpcId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyCreatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsIamAccessKeyUserName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceAwsS3BucketOwnerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerImageName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceContainerLaunchedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ResourceContainerName' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceDetailsOther' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceId' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourcePartition' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceRegion' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ResourceTags' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ResourceType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityLabel' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'SeverityNormalized' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SeverityProduct' => [
[
'Eq' => <float>,
'Gte' => <float>,
'Lte' => <float>,
],
// ...
],
'SourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorCategory' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorLastObservedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSource' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorSourceUrl' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorType' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'ThreatIntelIndicatorValue' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Title' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'Type' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => [
[
'DateRange' => [
'Unit' => 'DAYS',
'Value' => <integer>,
],
'End' => '<string>',
'Start' => '<string>',
],
// ...
],
'UserDefinedFields' => [
[
'Comparison' => 'EQUALS',
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VerificationState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowState' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
'WorkflowStatus' => [
[
'Comparison' => 'EQUALS|PREFIX',
'Value' => '<string>',
],
// ...
],
],
'GroupByAttribute' => '<string>',
'InsightArn' => '<string>', // REQUIRED
'Name' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: AwsSecurityFindingFilters structure
The updated filters that define this insight.
- GroupByAttribute
-
- Type: string
The updated
GroupByattribute that defines this insight. - InsightArn
-
- Required: Yes
- Type: string
The ARN of the insight that you want to update.
- Name
-
- Type: string
The updated name for the insight.
Result Syntax
[]
Result Details
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
-
The request was rejected because we can't find the specified resource.
UpdateSecurityHubConfiguration
$result = $client->updateSecurityHubConfiguration([/* ... */]); $promise = $client->updateSecurityHubConfigurationAsync([/* ... */]);
Updates configuration options for Security Hub.
Parameter Syntax
$result = $client->updateSecurityHubConfiguration([
'AutoEnableControls' => true || false,
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
-
The request was rejected because we can't find the specified resource.
UpdateStandardsControl
$result = $client->updateStandardsControl([/* ... */]); $promise = $client->updateStandardsControlAsync([/* ... */]);
Used to control whether an individual security standard control is enabled or disabled.
Parameter Syntax
$result = $client->updateStandardsControl([
'ControlStatus' => 'ENABLED|DISABLED',
'DisabledReason' => '<string>',
'StandardsControlArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ControlStatus
-
- Type: string
The updated status of the security standard control.
- DisabledReason
-
- Type: string
A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.
- StandardsControlArn
-
- Required: Yes
- Type: string
The ARN of the security standard control to enable or disable.
Result Syntax
[]
Result Details
Errors
-
Internal server error.
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
-
AWS Security Hub isn't enabled for the account used to make this request.
-
The request was rejected because we can't find the specified resource.
Shapes
AccessDeniedException
Description
You don't have permission to perform the action specified in the request.
Members
AccountDetails
Description
The details of an AWS account.
Members
ActionTarget
Description
An ActionTarget object.
Members
AvailabilityZone
Description
Information about an Availability Zone.
Members
AwsAutoScalingAutoScalingGroupDetails
Description
Provides details about an auto scaling group.
Members
- CreatedTime
-
- Type: string
The datetime when the auto scaling group was created.
- HealthCheckGracePeriod
-
- Type: int
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the health status of an EC2 instance that has come into service.
- HealthCheckType
-
- Type: string
The service to use for the health checks.
- LaunchConfigurationName
-
- Type: string
The name of the launch configuration.
- LoadBalancerNames
-
- Type: Array of strings
The list of load balancers associated with the group.
AwsCloudFrontDistributionDetails
Description
A distribution configuration.
Members
- DomainName
-
- Type: string
The domain name corresponding to the distribution.
- ETag
-
- Type: string
The entity tag is a hash of the object.
- LastModifiedTime
-
- Type: string
The date and time that the distribution was last modified.
- Logging
-
- Type: AwsCloudFrontDistributionLogging structure
A complex type that controls whether access logs are written for the distribution.
- Origins
-
- Type: AwsCloudFrontDistributionOrigins structure
A complex type that contains information about origins for this distribution.
- Status
-
- Type: string
Indicates the current status of the distribution.
- WebAclId
-
- Type: string
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.
AwsCloudFrontDistributionLogging
Description
A complex type that controls whether access logs are written for the distribution.
Members
- Bucket
-
- Type: string
The Amazon S3 bucket to store the access logs in.
- Enabled
-
- Type: boolean
With this field, you can enable or disable the selected distribution.
- IncludeCookies
-
- Type: boolean
Specifies whether you want CloudFront to include cookies in access logs.
- Prefix
-
- Type: string
An optional string that you want CloudFront to use as a prefix to the access log filenames for this distribution.
AwsCloudFrontDistributionOriginItem
Description
A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon Elemental MediaStore, or other server from which CloudFront gets your files.
Members
- DomainName
-
- Type: string
Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin.
- Id
-
- Type: string
A unique identifier for the origin or origin group.
- OriginPath
-
- Type: string
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.
AwsCloudFrontDistributionOrigins
Description
A complex type that contains information about origins and origin groups for this distribution.
Members
- Items
-
- Type: Array of AwsCloudFrontDistributionOriginItem structures
A complex type that contains origins or origin groups for this distribution.
AwsCodeBuildProjectDetails
Description
Information about an AWS CodeBuild project.
Members
- EncryptionKey
-
- Type: string
The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the build output artifacts.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK alias (using the format alias/alias-name).
- Environment
-
- Type: AwsCodeBuildProjectEnvironment structure
Information about the build environment for this build project.
- Name
-
- Type: string
The name of the build project.
- ServiceRole
-
- Type: string
The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- Source
-
- Type: AwsCodeBuildProjectSource structure
Information about the build input source code for this build project.
- VpcConfig
-
- Type: AwsCodeBuildProjectVpcConfig structure
Information about the VPC configuration that AWS CodeBuild accesses.
AwsCodeBuildProjectEnvironment
Description
Information about the build environment for this build project.
Members
- Certificate
-
- Type: string
The certificate to use with this build project.
- ImagePullCredentialsType
-
- Type: string
The type of credentials AWS CodeBuild uses to pull images in your build.
Valid values:
-
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the AWS CodeBuild service principal. -
SERVICE_ROLEspecifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use
SERVICE_ROLEcredentials. When you use an AWS CodeBuild curated image, you must useCODEBUILDcredentials. - RegistryCredential
-
- Type: AwsCodeBuildProjectEnvironmentRegistryCredential structure
The credentials for access to a private registry.
- Type
-
- Type: string
The type of build environment to use for related builds.
The environment type
ARM_CONTAINERis available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).The environment type
LINUX_CONTAINERwith compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).The environment type
LINUX_GPU_CONTAINERis available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).Valid values:
WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER
AwsCodeBuildProjectEnvironmentRegistryCredential
Description
The credentials for access to a private registry.
Members
- Credential
-
- Type: string
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.
The credential can use the name of the credentials only if they exist in your current AWS Region.
- CredentialProvider
-
- Type: string
The service that created the credentials to access a private Docker registry.
The valid value,
SECRETS_MANAGER, is for AWS Secrets Manager.
AwsCodeBuildProjectSource
Description
Information about the build input source code for this build project.
Members
- GitCloneDepth
-
- Type: int
Information about the Git clone depth for the build project.
- InsecureSsl
-
- Type: boolean
Whether to ignore SSL warnings while connecting to the project source code.
- Location
-
- Type: string
Information about the location of the source code to be built.
Valid values include:
-
For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
-
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec file (for example,
https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name). -
For source code in an S3 input bucket, one of the following.
-
The path to the ZIP file that contains the source code (for example,
bucket-name/path/to/object-name.zip). -
The path to the folder that contains the source code (for example,
bucket-name/path/to/source-code/folder/).
-
-
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
-
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
- Type
-
- Type: string
The type of repository that contains the source code to be built. Valid values are:
-
BITBUCKET- The source code is in a Bitbucket repository. -
CODECOMMIT- The source code is in an AWS CodeCommit repository. -
CODEPIPELINE- The source code settings are specified in the source action of a pipeline in AWS CodePipeline. -
GITHUB- The source code is in a GitHub repository. -
GITHUB_ENTERPRISE- The source code is in a GitHub Enterprise repository. -
NO_SOURCE- The project does not have input source code. -
S3- The source code is in an S3 input bucket.
AwsCodeBuildProjectVpcConfig
Description
Information about the VPC configuration that AWS CodeBuild accesses.
Members
AwsEc2InstanceDetails
Description
The details of an Amazon EC2 instance.
Members
- IamInstanceProfileArn
-
- Type: string
The IAM profile ARN of the instance.
- ImageId
-
- Type: string
The Amazon Machine Image (AMI) ID of the instance.
- IpV4Addresses
-
- Type: Array of strings
The IPv4 addresses associated with the instance.
- IpV6Addresses
-
- Type: Array of strings
The IPv6 addresses associated with the instance.
- KeyName
-
- Type: string
The key name associated with the instance.
- LaunchedAt
-
- Type: string
The date/time the instance was launched.
- SubnetId
-
- Type: string
The identifier of the subnet that the instance was launched in.
- Type
-
- Type: string
The instance type of the instance.
- VpcId
-
- Type: string
The identifier of the VPC that the instance was launched in.
AwsEc2NetworkInterfaceAttachment
Description
Information about the network interface attachment.
Members
- AttachTime
-
- Type: string
The timestamp indicating when the attachment initiated.
- AttachmentId
-
- Type: string
The identifier of the network interface attachment
- DeleteOnTermination
-
- Type: boolean
Indicates whether the network interface is deleted when the instance is terminated.
- DeviceIndex
-
- Type: int
The device index of the network interface attachment on the instance.
- InstanceId
-
- Type: string
The ID of the instance.
- InstanceOwnerId
-
- Type: string
The AWS account ID of the owner of the instance.
- Status
-
- Type: string
The attachment state.
Valid values:
attaching|attached|detaching|detached
AwsEc2NetworkInterfaceDetails
Description
Details about the network interface
Members
- Attachment
-
- Type: AwsEc2NetworkInterfaceAttachment structure
The network interface attachment.
- NetworkInterfaceId
-
- Type: string
The ID of the network interface.
- SecurityGroups
-
- Type: Array of AwsEc2NetworkInterfaceSecurityGroup structures
Security groups for the network interface.
- SourceDestCheck
-
- Type: boolean
Indicates whether traffic to or from the instance is validated.
AwsEc2NetworkInterfaceSecurityGroup
Description
A security group associated with the network interface.
Members
AwsEc2SecurityGroupDetails
Description
Details about an EC2 security group.
Members
- GroupId
-
- Type: string
The ID of the security group.
- GroupName
-
- Type: string
The name of the security group.
- IpPermissions
-
- Type: Array of AwsEc2SecurityGroupIpPermission structures
The inbound rules associated with the security group.
- IpPermissionsEgress
-
- Type: Array of AwsEc2SecurityGroupIpPermission structures
[VPC only] The outbound rules associated with the security group.
- OwnerId
-
- Type: string
The AWS account ID of the owner of the security group.
- VpcId
-
- Type: string
[VPC only] The ID of the VPC for the security group.
AwsEc2SecurityGroupIpPermission
Description
An IP permission for an EC2 security group.
Members
- FromPort
-
- Type: int
The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
- IpProtocol
-
- Type: string
The IP protocol name (
tcp,udp,icmp,icmpv6) or number.[VPC only] Use
-1to specify all protocols.When authorizing security group rules, specifying -1 or a protocol number other than
tcp,udp,icmp, oricmpv6allows traffic on all ports, regardless of any port range you specify.For
tcp,udp, andicmp, you must specify a port range.For
icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed. - IpRanges
-
- Type: Array of AwsEc2SecurityGroupIpRange structures
The IPv4 ranges.
- Ipv6Ranges
-
- Type: Array of AwsEc2SecurityGroupIpv6Range structures
The IPv6 ranges.
- PrefixListIds
-
- Type: Array of AwsEc2SecurityGroupPrefixListId structures
[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group.
- ToPort
-
- Type: int
The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
- UserIdGroupPairs
-
- Type: Array of AwsEc2SecurityGroupUserIdGroupPair structures
The security group and AWS account ID pairs.
AwsEc2SecurityGroupIpRange
Description
A range of IPv4 addresses.
Members
AwsEc2SecurityGroupIpv6Range
Description
A range of IPv6 addresses.
Members
AwsEc2SecurityGroupPrefixListId
AwsEc2SecurityGroupUserIdGroupPair
Description
A relationship between a security group and a user.
Members
- GroupId
-
- Type: string
The ID of the security group.
- GroupName
-
- Type: string
The name of the security group.
- PeeringStatus
-
- Type: string
The status of a VPC peering connection, if applicable.
- UserId
-
- Type: string
The ID of an AWS account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS.
- VpcId
-
- Type: string
The ID of the VPC for the referenced security group, if applicable.
- VpcPeeringConnectionId
-
- Type: string
The ID of the VPC peering connection, if applicable.
AwsEc2VolumeAttachment
Description
An attachment to an AWS EC2 volume.
Members
AwsEc2VolumeDetails
Description
Details about an EC2 volume.
Members
- Attachments
-
- Type: Array of AwsEc2VolumeAttachment structures
The volume attachments.
- CreateTime
-
- Type: string
The datetime when the volume was created.
- Encrypted
-
- Type: boolean
Whether the volume is encrypted.
- KmsKeyId
-
- Type: string
The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
- Size
-
- Type: int
The size of the volume, in GiBs.
- SnapshotId
-
- Type: string
The snapshot from which the volume was created.
- Status
-
- Type: string
The volume state.
AwsEc2VpcDetails
Description
Details about an EC2 VPC.
Members
- CidrBlockAssociationSet
-
- Type: Array of CidrBlockAssociation structures
Information about the IPv4 CIDR blocks associated with the VPC.
- DhcpOptionsId
-
- Type: string
The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.
- Ipv6CidrBlockAssociationSet
-
- Type: Array of Ipv6CidrBlockAssociation structures
Information about the IPv6 CIDR blocks associated with the VPC.
- State
-
- Type: string
The current state of the VPC.
AwsElasticsearchDomainDetails
Description
Information about an Elasticsearch domain.
Members
- AccessPolicies
-
- Type: string
IAM policy document specifying the access policies for the new Amazon ES domain.
- DomainEndpointOptions
-
- Type: AwsElasticsearchDomainDomainEndpointOptions structure
Additional options for the domain endpoint.
- DomainId
-
- Type: string
Unique identifier for an Amazon ES domain.
- DomainName
-
- Type: string
Name of an Amazon ES domain.
Domain names are unique across all domains owned by the same account within an AWS Region.
Domain names must start with a lowercase letter and must be between 3 and 28 characters.
Valid characters are a-z (lowercase only), 0-9, and – (hyphen).
- ElasticsearchVersion
-
- Type: string
Elasticsearch version.
- EncryptionAtRestOptions
-
- Type: AwsElasticsearchDomainEncryptionAtRestOptions structure
Details about the configuration for encryption at rest.
- Endpoint
-
- Type: string
Domain-specific endpoint used to submit index, search, and data upload requests to an Amazon ES domain.
The endpoint is a service URL.
- Endpoints
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
The key-value pair that exists if the Amazon ES domain uses VPC endpoints.
- NodeToNodeEncryptionOptions
-
- Type: AwsElasticsearchDomainNodeToNodeEncryptionOptions structure
Details about the configuration for node-to-node encryption.
- VPCOptions
-
- Type: AwsElasticsearchDomainVPCOptions structure
Information that Amazon ES derives based on
VPCOptionsfor the domain.
AwsElasticsearchDomainDomainEndpointOptions
Description
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Members
- EnforceHTTPS
-
- Type: boolean
Whether to require that all traffic to the domain arrive over HTTPS.
- TLSSecurityPolicy
-
- Type: string
The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch domain.
Valid values:
-
Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher -
Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2
AwsElasticsearchDomainEncryptionAtRestOptions
Description
Details about the configuration for encryption at rest.
Members
AwsElasticsearchDomainNodeToNodeEncryptionOptions
Description
Details about the configuration for node-to-node encryption.
Members
AwsElasticsearchDomainVPCOptions
Description
Information that Amazon ES derives based on VPCOptions for the domain.
Members
- AvailabilityZones
-
- Type: Array of strings
The list of Availability Zones associated with the VPC subnets.
- SecurityGroupIds
-
- Type: Array of strings
The list of security group IDs associated with the VPC endpoints for the domain.
- SubnetIds
-
- Type: Array of strings
A list of subnet IDs associated with the VPC endpoints for the domain.
- VPCId
-
- Type: string
ID for the VPC.
AwsElbv2LoadBalancerDetails
Description
Information about a load balancer.
Members
- AvailabilityZones
-
- Type: Array of AvailabilityZone structures
The Availability Zones for the load balancer.
- CanonicalHostedZoneId
-
- Type: string
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
- CreatedTime
-
- Type: string
The date and time the load balancer was created.
- DNSName
-
- Type: string
The public DNS name of the load balancer.
- IpAddressType
-
- Type: string
The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4(for IPv4 addresses) anddualstack(for IPv4 and IPv6 addresses). - Scheme
-
- Type: string
The nodes of an Internet-facing load balancer have public IP addresses.
- SecurityGroups
-
- Type: Array of strings
The IDs of the security groups for the load balancer.
- State
-
- Type: LoadBalancerState structure
The state of the load balancer.
- Type
-
- Type: string
The type of load balancer.
- VpcId
-
- Type: string
The ID of the VPC for the load balancer.
AwsIamAccessKeyDetails
Description
IAM access key details related to a finding.
Members
- CreatedAt
-
- Type: string
The creation date/time of the IAM access key related to a finding.
- PrincipalId
-
- Type: string
The ID of the principal associated with an access key.
- PrincipalName
-
- Type: string
The name of the principal.
- PrincipalType
-
- Type: string
The type of principal associated with an access key.
- Status
-
- Type: string
The status of the IAM access key related to a finding.
- UserName
-
- Type: string
The user associated with the IAM access key related to a finding.
The
UserNameparameter has been replaced with thePrincipalNameparameter because access keys can also be assigned to principals that are not IAM users.
AwsIamRoleDetails
Description
Contains information about an IAM role, including all of the role's policies.
Members
- AssumeRolePolicyDocument
-
- Type: string
The trust policy that grants permission to assume the role.
- CreateDate
-
- Type: string
The date and time, in ISO 8601 date-time format, when the role was created.
- MaxSessionDuration
-
- Type: int
The maximum session duration (in seconds) that you want to set for the specified role.
- Path
-
- Type: string
The path to the role.
- RoleId
-
- Type: string
The stable and unique string identifying the role.
- RoleName
-
- Type: string
The friendly name that identifies the role.
AwsKmsKeyDetails
Description
Contains metadata about a customer master key (CMK).
Members
- AWSAccountId
-
- Type: string
The twelve-digit account ID of the AWS account that owns the CMK.
- CreationDate
-
- Type: double
The date and time when the CMK was created.
- KeyId
-
- Type: string
The globally unique identifier for the CMK.
- KeyManager
-
- Type: string
The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.
- KeyState
-
- Type: string
The state of the CMK.
- Origin
-
- Type: string
The source of the CMK's key material.
When this value is
AWS_KMS, AWS KMS created the key material.When this value is
EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.When this value is
AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
AwsLambdaFunctionCode
Description
The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.
Members
- S3Bucket
-
- Type: string
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
- S3Key
-
- Type: string
The Amazon S3 key of the deployment package.
- S3ObjectVersion
-
- Type: string
For versioned objects, the version of the deployment package object to use.
- ZipFile
-
- Type: string
The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
AwsLambdaFunctionDeadLetterConfig
Description
The dead-letter queue for failed asynchronous invocations.
Members
AwsLambdaFunctionDetails
Description
Details about a function's configuration.
Members
- Code
-
- Type: AwsLambdaFunctionCode structure
An
AwsLambdaFunctionCodeobject. - CodeSha256
-
- Type: string
The SHA256 hash of the function's deployment package.
- DeadLetterConfig
-
- Type: AwsLambdaFunctionDeadLetterConfig structure
The function's dead letter queue.
- Environment
-
- Type: AwsLambdaFunctionEnvironment structure
The function's environment variables.
- FunctionName
-
- Type: string
The name of the function.
- Handler
-
- Type: string
The function that Lambda calls to begin executing your function.
- KmsKeyArn
-
- Type: string
The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.
- LastModified
-
- Type: string
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- Layers
-
- Type: Array of AwsLambdaFunctionLayer structures
The function's layers.
- MasterArn
-
- Type: string
For Lambda@Edge functions, the ARN of the master function.
- MemorySize
-
- Type: int
The memory that's allocated to the function.
- RevisionId
-
- Type: string
The latest updated revision of the function or alias.
- Role
-
- Type: string
The function's execution role.
- Runtime
-
- Type: string
The runtime environment for the Lambda function.
- Timeout
-
- Type: int
The amount of time that Lambda allows a function to run before stopping it.
- TracingConfig
-
- Type: AwsLambdaFunctionTracingConfig structure
The function's AWS X-Ray tracing configuration.
- Version
-
- Type: string
The version of the Lambda function.
- VpcConfig
-
- Type: AwsLambdaFunctionVpcConfig structure
The function's networking configuration.
AwsLambdaFunctionEnvironment
Description
A function's environment variable settings.
Members
- Error
-
- Type: AwsLambdaFunctionEnvironmentError structure
An
AwsLambdaFunctionEnvironmentErrorobject. - Variables
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
Environment variable key-value pairs.
AwsLambdaFunctionEnvironmentError
Description
Error messages for environment variables that couldn't be applied.
Members
AwsLambdaFunctionLayer
Description
An AWS Lambda layer.
Members
AwsLambdaFunctionTracingConfig
Description
The function's AWS X-Ray tracing configuration.
Members
AwsLambdaFunctionVpcConfig
Description
The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.
Members
AwsLambdaLayerVersionDetails
Description
Details about a Lambda layer version.
Members
- CompatibleRuntimes
-
- Type: Array of strings
The layer's compatible runtimes. Maximum number of five items.
Valid values:
nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.1|go1.x|ruby2.5|provided - CreatedDate
-
- Type: string
The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.
- Version
-
- Type: long (int|float)
The version number.
AwsRdsDbInstanceAssociatedRole
Description
An AWS Identity and Access Management (IAM) role associated with the DB instance.
Members
- FeatureName
-
- Type: string
The name of the feature associated with the IAM)role.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- Status
-
- Type: string
Describes the state of the association between the IAM role and the DB instance. The
Statusproperty returns one of the following values:-
ACTIVE- The IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf. -
PENDING- The IAM role ARN is being associated with the DB instance. -
INVALID- The IAM role ARN is associated with the DB instance. But the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.
AwsRdsDbInstanceDetails
Description
Contains the details of an Amazon RDS DB instance.
Members
- AssociatedRoles
-
- Type: Array of AwsRdsDbInstanceAssociatedRole structures
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
- CACertificateIdentifier
-
- Type: string
The identifier of the CA certificate for this DB instance.
- DBClusterIdentifier
-
- Type: string
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
- DBInstanceClass
-
- Type: string
Contains the name of the compute and memory capacity class of the DB instance.
- DBInstanceIdentifier
-
- Type: string
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
- DBName
-
- Type: string
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
- DbInstancePort
-
- Type: int
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
- DbiResourceId
-
- Type: string
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
- DeletionProtection
-
- Type: boolean
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
- Endpoint
-
- Type: AwsRdsDbInstanceEndpoint structure
Specifies the connection endpoint.
- Engine
-
- Type: string
Provides the name of the database engine to use for this DB instance.
- EngineVersion
-
- Type: string
Indicates the database engine version.
- IAMDatabaseAuthenticationEnabled
-
- Type: boolean
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines.
-
For MySQL 5.6, minor version 5.6.34 or higher
-
For MySQL 5.7, minor version 5.7.16 or higher
-
Aurora 5.6 or higher
- InstanceCreateTime
-
- Type: string
Provides the date and time the DB instance was created.
- KmsKeyId
-
- Type: string
If
StorageEncryptedis true, the AWS KMS key identifier for the encrypted DB instance. - PubliclyAccessible
-
- Type: boolean
Specifies the accessibility options for the DB instance.
A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.
A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
- StorageEncrypted
-
- Type: boolean
Specifies whether the DB instance is encrypted.
- TdeCredentialArn
-
- Type: string
The ARN from the key store with which the instance is associated for TDE encryption.
- VpcSecurityGroups
-
- Type: Array of AwsRdsDbInstanceVpcSecurityGroup structures
A list of VPC security groups that the DB instance belongs to.
AwsRdsDbInstanceEndpoint
Description
Specifies the connection endpoint.
Members
AwsRdsDbInstanceVpcSecurityGroup
Description
A VPC security groups that the DB instance belongs to.
Members
AwsS3BucketDetails
Description
The details of an Amazon S3 bucket.
Members
- CreatedAt
-
- Type: string
The date and time when the S3 bucket was created.
- OwnerId
-
- Type: string
The canonical user ID of the owner of the S3 bucket.
- OwnerName
-
- Type: string
The display name of the owner of the S3 bucket.
- ServerSideEncryptionConfiguration
-
- Type: AwsS3BucketServerSideEncryptionConfiguration structure
The encryption rules that are applied to the S3 bucket.
AwsS3BucketServerSideEncryptionByDefault
Description
Specifies the default server-side encryption to apply to new objects in the bucket.
Members
AwsS3BucketServerSideEncryptionConfiguration
Description
The encryption configuration for the S3 bucket.
Members
- Rules
-
- Type: Array of AwsS3BucketServerSideEncryptionRule structures
The encryption rules that are applied to the S3 bucket.
AwsS3BucketServerSideEncryptionRule
Description
An encryption rule to apply to the S3 bucket.
Members
- ApplyServerSideEncryptionByDefault
-
- Type: AwsS3BucketServerSideEncryptionByDefault structure
Specifies the default server-side encryption to apply to new objects in the bucket. If a
PUTobject request doesn't specify any server-side encryption, this default encryption is applied.
AwsS3ObjectDetails
Description
Details about an Amazon S3 object.
Members
- ContentType
-
- Type: string
A standard MIME type describing the format of the object data.
- ETag
-
- Type: string
The opaque identifier assigned by a web server to a specific version of a resource found at a URL.
- LastModified
-
- Type: string
The date and time when the object was last modified.
- SSEKMSKeyId
-
- Type: string
The identifier of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.
- ServerSideEncryption
-
- Type: string
If the object is stored using server-side encryption, the value of the server-side encryption algorithm used when storing this object in Amazon S3.
- VersionId
-
- Type: string
The version of the object.
AwsSecurityFinding
Description
Provides consistent format for the contents of the Security Hub-aggregated findings. AwsSecurityFinding format enables you to share findings between AWS security services and third-party solutions, and security standards checks.
A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and standards checks.
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID that a finding is generated in.
- Compliance
-
- Type: Compliance structure
This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS AWS Foundations. Contains security standard-related finding details.
- Confidence
-
- Type: int
A finding's 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.
- CreatedAt
-
- Required: Yes
- Type: string
An ISO8601-formatted timestamp that indicates when the security-findings provider created the potential security issue that a finding captured.
- Criticality
-
- Type: int
The level of importance assigned to the resources associated with the finding.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
- Description
-
- Required: Yes
- Type: string
A finding's description.
In this release,
Descriptionis a required property. - FirstObservedAt
-
- Type: string
An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.
- GeneratorId
-
- Required: Yes
- Type: string
The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, etc.
- Id
-
- Required: Yes
- Type: string
The security findings provider-specific identifier for a finding.
- LastObservedAt
-
- Type: string
An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.
- Malware
-
- Type: Array of Malware structures
A list of malware related to a finding.
- Network
-
- Type: Network structure
The details of network-related information about a finding.
- NetworkPath
-
- Type: Array of NetworkPathComponent structures
Provides information about a network path that is relevant to a finding. Each entry under
NetworkPathrepresents a component of that path. - Note
-
- Type: Note structure
A user-defined note added to a finding.
- Process
-
- Type: ProcessDetails structure
The details of process-related information about a finding.
- ProductArn
-
- Required: Yes
- Type: string
The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.
- ProductFields
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
A data type where security-findings providers can include additional solution-specific details that aren't part of the defined
AwsSecurityFindingformat. - RecordState
-
- Type: string
The record state of a finding.
- RelatedFindings
-
- Type: Array of RelatedFinding structures
A list of related findings.
- Remediation
-
- Type: Remediation structure
A data type that describes the remediation options for a finding.
- Resources
-
- Required: Yes
- Type: Array of Resource structures
A set of resource data types that describe the resources that the finding refers to.
- SchemaVersion
-
- Required: Yes
- Type: string
The schema version that a finding is formatted for.
- Severity
-
- Required: Yes
- Type: Severity structure
A finding's severity.
- SourceUrl
-
- Type: string
A URL that links to a page about the current finding in the security-findings provider's solution.
- ThreatIntelIndicators
-
- Type: Array of ThreatIntelIndicator structures
Threat intelligence details related to a finding.
- Title
-
- Required: Yes
- Type: string
A finding's title.
In this release,
Titleis a required property. - Types
-
- Required: Yes
- Type: Array of strings
One or more finding types in the format of
namespace/category/classifierthat classify a finding.Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
- UpdatedAt
-
- Required: Yes
- Type: string
An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.
- 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.
- Vulnerabilities
-
- Type: Array of Vulnerability structures
Provides a list of vulnerabilities associated with the findings.
- Workflow
-
- Type: Workflow structure
Provides information about the status of the investigation into a finding.
- WorkflowState
-
- Type: string
The workflow state of a finding.
AwsSecurityFindingFilters
Description
A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight.
Members
- AwsAccountId
-
- Type: Array of StringFilter structures
The AWS account ID that a finding is generated in.
- CompanyName
-
- Type: Array of StringFilter structures
The name of the findings provider (company) that owns the solution (product) that generates findings.
- ComplianceStatus
-
- Type: Array of StringFilter structures
Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS AWS Foundations. Contains security standard-related finding details.
- Confidence
-
- Type: Array of NumberFilter structures
A finding's 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.
- CreatedAt
-
- Type: Array of DateFilter structures
An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.
- Criticality
-
- Type: Array of NumberFilter structures
The level of importance assigned to the resources associated with the finding.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
- Description
-
- Type: Array of StringFilter structures
A finding's description.
- FirstObservedAt
-
- Type: Array of DateFilter structures
An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.
- GeneratorId
-
- Type: Array of StringFilter structures
The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, etc.
- Id
-
- Type: Array of StringFilter structures
The security findings provider-specific identifier for a finding.
- Keyword
-
- Type: Array of KeywordFilter structures
A keyword for a finding.
- LastObservedAt
-
- Type: Array of DateFilter structures
An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.
- MalwareName
-
- Type: Array of StringFilter structures
The name of the malware that was observed.
- MalwarePath
-
- Type: Array of StringFilter structures
The filesystem path of the malware that was observed.
- MalwareState
-
- Type: Array of StringFilter structures
The state of the malware that was observed.
- MalwareType
-
- Type: Array of StringFilter structures
The type of the malware that was observed.
- NetworkDestinationDomain
-
- Type: Array of StringFilter structures
The destination domain of network-related information about a finding.
- NetworkDestinationIpV4
-
- Type: Array of IpFilter structures
The destination IPv4 address of network-related information about a finding.
- NetworkDestinationIpV6
-
- Type: Array of IpFilter structures
The destination IPv6 address of network-related information about a finding.
- NetworkDestinationPort
-
- Type: Array of NumberFilter structures
The destination port of network-related information about a finding.
- NetworkDirection
-
- Type: Array of StringFilter structures
Indicates the direction of network traffic associated with a finding.
- NetworkProtocol
-
- Type: Array of StringFilter structures
The protocol of network-related information about a finding.
- NetworkSourceDomain
-
- Type: Array of StringFilter structures
The source domain of network-related information about a finding.
- NetworkSourceIpV4
-
- Type: Array of IpFilter structures
The source IPv4 address of network-related information about a finding.
- NetworkSourceIpV6
-
- Type: Array of IpFilter structures
The source IPv6 address of network-related information about a finding.
- NetworkSourceMac
-
- Type: Array of StringFilter structures
The source media access control (MAC) address of network-related information about a finding.
- NetworkSourcePort
-
- Type: Array of NumberFilter structures
The source port of network-related information about a finding.
- NoteText
-
- Type: Array of StringFilter structures
The text of a note.
- NoteUpdatedAt
-
- Type: Array of DateFilter structures
The timestamp of when the note was updated.
- NoteUpdatedBy
-
- Type: Array of StringFilter structures
The principal that created a note.
- ProcessLaunchedAt
-
- Type: Array of DateFilter structures
The date/time that the process was launched.
- ProcessName
-
- Type: Array of StringFilter structures
The name of the process.
- ProcessParentPid
-
- Type: Array of NumberFilter structures
The parent process ID.
- ProcessPath
-
- Type: Array of StringFilter structures
The path to the process executable.
- ProcessPid
-
- Type: Array of NumberFilter structures
The process ID.
- ProcessTerminatedAt
-
- Type: Array of DateFilter structures
The date/time that the process was terminated.
- ProductArn
-
- Type: Array of StringFilter structures
The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.
- ProductFields
-
- Type: Array of MapFilter structures
A data type where security-findings providers can include additional solution-specific details that aren't part of the defined
AwsSecurityFindingformat. - ProductName
-
- Type: Array of StringFilter structures
The name of the solution (product) that generates findings.
- RecommendationText
-
- Type: Array of StringFilter structures
The recommendation of what to do about the issue described in a finding.
- RecordState
-
- Type: Array of StringFilter structures
The updated record state for the finding.
- RelatedFindingsId
-
- Type: Array of StringFilter structures
The solution-generated identifier for a related finding.
- RelatedFindingsProductArn
-
- Type: Array of StringFilter structures
The ARN of the solution that generated a related finding.
- ResourceAwsEc2InstanceIamInstanceProfileArn
-
- Type: Array of StringFilter structures
The IAM profile ARN of the instance.
- ResourceAwsEc2InstanceImageId
-
- Type: Array of StringFilter structures
The Amazon Machine Image (AMI) ID of the instance.
- ResourceAwsEc2InstanceIpV4Addresses
-
- Type: Array of IpFilter structures
The IPv4 addresses associated with the instance.
- ResourceAwsEc2InstanceIpV6Addresses
-
- Type: Array of IpFilter structures
The IPv6 addresses associated with the instance.
- ResourceAwsEc2InstanceKeyName
-
- Type: Array of StringFilter structures
The key name associated with the instance.
- ResourceAwsEc2InstanceLaunchedAt
-
- Type: Array of DateFilter structures
The date and time the instance was launched.
- ResourceAwsEc2InstanceSubnetId
-
- Type: Array of StringFilter structures
The identifier of the subnet that the instance was launched in.
- ResourceAwsEc2InstanceType
-
- Type: Array of StringFilter structures
The instance type of the instance.
- ResourceAwsEc2InstanceVpcId
-
- Type: Array of StringFilter structures
The identifier of the VPC that the instance was launched in.
- ResourceAwsIamAccessKeyCreatedAt
-
- Type: Array of DateFilter structures
The creation date/time of the IAM access key related to a finding.
- ResourceAwsIamAccessKeyStatus
-
- Type: Array of StringFilter structures
The status of the IAM access key related to a finding.
- ResourceAwsIamAccessKeyUserName
-
- Type: Array of StringFilter structures
The user associated with the IAM access key related to a finding.
- ResourceAwsS3BucketOwnerId
-
- Type: Array of StringFilter structures
The canonical user ID of the owner of the S3 bucket.
- ResourceAwsS3BucketOwnerName
-
- Type: Array of StringFilter structures
The display name of the owner of the S3 bucket.
- ResourceContainerImageId
-
- Type: Array of StringFilter structures
The identifier of the image related to a finding.
- ResourceContainerImageName
-
- Type: Array of StringFilter structures
The name of the image related to a finding.
- ResourceContainerLaunchedAt
-
- Type: Array of DateFilter structures
The date/time that the container was started.
- ResourceContainerName
-
- Type: Array of StringFilter structures
The name of the container related to a finding.
- ResourceDetailsOther
-
- Type: Array of MapFilter structures
The details of a resource that doesn't have a specific subfield for the resource type defined.
- ResourceId
-
- Type: Array of StringFilter structures
The canonical identifier for the given resource type.
- ResourcePartition
-
- Type: Array of StringFilter structures
The canonical AWS partition name that the Region is assigned to.
- ResourceRegion
-
- Type: Array of StringFilter structures
The canonical AWS external Region name where this resource is located.
- ResourceTags
-
- Type: Array of MapFilter structures
A list of AWS tags associated with a resource at the time the finding was processed.
- ResourceType
-
- Type: Array of StringFilter structures
Specifies the type of the resource that details are provided for.
- SeverityLabel
-
- Type: Array of StringFilter structures
The label of a finding's severity.
- SeverityNormalized
-
- Type: Array of NumberFilter structures
The normalized severity of a finding.
- SeverityProduct
-
- Type: Array of NumberFilter structures
The native severity as defined by the security-findings provider's solution that generated the finding.
- SourceUrl
-
- Type: Array of StringFilter structures
A URL that links to a page about the current finding in the security-findings provider's solution.
- ThreatIntelIndicatorCategory
-
- Type: Array of StringFilter structures
The category of a threat intelligence indicator.
- ThreatIntelIndicatorLastObservedAt
-
- Type: Array of DateFilter structures
The date/time of the last observation of a threat intelligence indicator.
- ThreatIntelIndicatorSource
-
- Type: Array of StringFilter structures
The source of the threat intelligence.
- ThreatIntelIndicatorSourceUrl
-
- Type: Array of StringFilter structures
The URL for more details from the source of the threat intelligence.
- ThreatIntelIndicatorType
-
- Type: Array of StringFilter structures
The type of a threat intelligence indicator.
- ThreatIntelIndicatorValue
-
- Type: Array of StringFilter structures
The value of a threat intelligence indicator.
- Title
-
- Type: Array of StringFilter structures
A finding's title.
- Type
-
- Type: Array of StringFilter structures
A finding type in the format of
namespace/category/classifierthat classifies a finding. - UpdatedAt
-
- Type: Array of DateFilter structures
An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.
- UserDefinedFields
-
- Type: Array of MapFilter structures
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
- VerificationState
-
- Type: Array of StringFilter structures
The veracity of a finding.
- WorkflowState
-
- Type: Array of StringFilter structures
The workflow state of a finding.
Note that this field is deprecated. To search for a finding based on its workflow status, use
WorkflowStatus. - WorkflowStatus
-
- Type: Array of StringFilter structures
The status of the investigation into a finding. Allowed values are the following.
-
NEW- The initial state of a finding, before it is reviewed. -
NOTIFIED- Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. -
SUPPRESSED- The finding will not be reviewed again and will not be acted upon. -
RESOLVED- The finding was reviewed and remediated and is now considered resolved.
AwsSecurityFindingIdentifier
Description
Identifies a finding to update using BatchUpdateFindings.
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the finding that was specified by the finding provider.
- ProductArn
-
- Required: Yes
- Type: string
The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.
AwsSnsTopicDetails
Description
A wrapper type for the topic's Amazon Resource Name (ARN).
Members
- KmsMasterKeyId
-
- Type: string
The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.
- Owner
-
- Type: string
The subscription's owner.
- Subscription
-
- Type: Array of AwsSnsTopicSubscription structures
Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.
- TopicName
-
- Type: string
The name of the topic.
AwsSnsTopicSubscription
Description
A wrapper type for the attributes of an Amazon SNS subscription.
Members
AwsSqsQueueDetails
Description
Data about a queue.
Members
- DeadLetterTargetArn
-
- Type: string
The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of
maxReceiveCountis exceeded. - KmsDataKeyReusePeriodSeconds
-
- Type: int
The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.
- KmsMasterKeyId
-
- Type: string
The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK.
- QueueName
-
- Type: string
The name of the new queue.
AwsWafWebAclDetails
Description
Details about a WAF WebACL.
Members
- DefaultAction
-
- Type: string
The action to perform if none of the rules contained in the WebACL match.
- Name
-
- Type: string
A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
- Rules
-
- Type: Array of AwsWafWebAclRule structures
An array that contains the action for each rule in a WebACL, the priority of the rule, and the ID of the rule.
- WebAclId
-
- Type: string
A unique identifier for a WebACL.
AwsWafWebAclRule
Description
Details for a rule in a WAF WebACL.
Members
- Action
-
- Type: WafAction structure
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
- ExcludedRules
-
- Type: Array of WafExcludedRule structures
Rules to exclude from a rule group.
- OverrideAction
-
- Type: WafOverrideAction structure
Use the
OverrideActionto test your RuleGroup.Any rule in a RuleGroup can potentially block a request. If you set the
OverrideActiontoNone, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.However, if you first want to test the RuleGroup, set the
OverrideActiontoCount. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.ActivatedRule|OverrideActionapplies only when updating or adding a RuleGroup to a WebACL. In this case you do not useActivatedRule|Action. For all other update requests,ActivatedRule|Actionis used instead ofActivatedRule|OverrideAction. - Priority
-
- Type: int
Specifies the order in which the rules in a WebACL are evaluated. Rules with a lower value for
Priorityare evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a WebACL, the values do not need to be consecutive. - RuleId
-
- Type: string
The identifier for a rule.
- Type
-
- Type: string
The rule type.
Valid values:
REGULAR|RATE_BASED|GROUPThe default is
REGULAR.
BatchUpdateFindingsUnprocessedFinding
Description
A finding from a BatchUpdateFindings request that Security Hub was unable to update.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The code associated with the error.
- ErrorMessage
-
- Required: Yes
- Type: string
The message associated with the error.
- FindingIdentifier
-
- Required: Yes
- Type: AwsSecurityFindingIdentifier structure
The identifier of the finding that was not updated.
CidrBlockAssociation
Description
An IPv4 CIDR block association.
Members
Compliance
Description
Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.
Members
- RelatedRequirements
-
- Type: Array of strings
For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.
- Status
-
- Type: string
The result of a standards check.
The valid values for
Statusare as follows.-
-
PASSED- Standards check passed for all evaluated resources. -
WARNING- Some information is missing or this check is not supported for your configuration. -
FAILED- Standards check failed for at least one evaluated resource. -
NOT_AVAILABLE- Check could not be performed due to a service outage, API error, or because the result of the AWS Config evaluation wasNOT_APPLICABLE. If the AWS Config evaluation result wasNOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.
-
- StatusReasons
-
- Type: Array of StatusReason structures
For findings generated from controls, a list of reasons behind the value of
Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the AWS Security Hub User Guide.
ContainerDetails
Description
Container details related to a finding.
Members
Cvss
Description
CVSS scores from the advisory related to the vulnerability.
Members
DateFilter
Description
A date filter for querying findings.
Members
- DateRange
-
- Type: DateRange structure
A date range for the date filter.
- End
-
- Type: string
An end date for the date filter.
- Start
-
- Type: string
A start date for the date filter.
DateRange
Description
A date range for the date filter.
Members
ImportFindingsError
Description
The list of the findings that cannot be imported. For each finding, the list provides the error.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The code of the error returned by the
BatchImportFindingsoperation. - ErrorMessage
-
- Required: Yes
- Type: string
The message of the error returned by the
BatchImportFindingsoperation. - Id
-
- Required: Yes
- Type: string
The identifier of the finding that could not be updated.
Insight
Description
Contains information about a Security Hub insight.
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 grouping attribute for the insight's findings. Indicates how to group the matching findings, and 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.
- InsightArn
-
- Required: Yes
- Type: string
The ARN of a Security Hub insight.
- Name
-
- Required: Yes
- Type: string
The name of a Security Hub insight.
InsightResultValue
Description
The insight result values returned by the GetInsightResults operation.
Members
InsightResults
Description
The insight results returned by the GetInsightResults operation.
Members
- GroupByAttribute
-
- Required: Yes
- Type: string
The attribute that the findings are grouped by for the insight whose results are returned by the
GetInsightResultsoperation. - InsightArn
-
- Required: Yes
- Type: string
The ARN of the insight whose results are returned by the
GetInsightResultsoperation. - ResultValues
-
- Required: Yes
- Type: Array of InsightResultValue structures
The list of insight result values returned by the
GetInsightResultsoperation.
InternalException
InvalidAccessException
Description
AWS Security Hub isn't enabled for the account used to make this request.
Members
InvalidInputException
Description
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
Members
Invitation
Description
Details about an invitation.
Members
- AccountId
-
- Type: string
The account ID of the Security Hub master account that the invitation was sent from.
- InvitationId
-
- Type: string
The ID of the invitation sent to the member account.
- InvitedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the invitation was sent.
- MemberStatus
-
- Type: string
The current status of the association between the member and master accounts.
IpFilter
Ipv6CidrBlockAssociation
Description
An IPV6 CIDR block association.
Members
KeywordFilter
Description
A keyword filter for querying findings.
Members
LimitExceededException
Description
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
Members
LoadBalancerState
Description
Information about the state of the load balancer.
Members
Malware
Description
A list of malware related to a finding.
Members
MapFilter
Description
The map filter for querying findings.
Members
Member
Description
The details about a member account.
Members
- AccountId
-
- Type: string
The AWS account ID of the member account.
-
- Type: string
The email address of the member account.
- InvitedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp for the date and time when the invitation was sent to the member account.
- MasterId
-
- Type: string
The AWS account ID of the Security Hub master account associated with this member account.
- MemberStatus
-
- Type: string
The status of the relationship between the member account and its master account.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for the date and time when the member account was updated.
Network
Description
The details of network-related information about a finding.
Members
- DestinationDomain
-
- Type: string
The destination domain of network-related information about a finding.
- DestinationIpV4
-
- Type: string
The destination IPv4 address of network-related information about a finding.
- DestinationIpV6
-
- Type: string
The destination IPv6 address of network-related information about a finding.
- DestinationPort
-
- Type: int
The destination port of network-related information about a finding.
- Direction
-
- Type: string
The direction of network traffic associated with a finding.
- OpenPortRange
-
- Type: PortRange structure
The range of open ports that is present on the network.
- Protocol
-
- Type: string
The protocol of network-related information about a finding.
- SourceDomain
-
- Type: string
The source domain of network-related information about a finding.
- SourceIpV4
-
- Type: string
The source IPv4 address of network-related information about a finding.
- SourceIpV6
-
- Type: string
The source IPv6 address of network-related information about a finding.
- SourceMac
-
- Type: string
The source media access control (MAC) address of network-related information about a finding.
- SourcePort
-
- Type: int
The source port of network-related information about a finding.
NetworkHeader
Description
Details about a network path component that occurs before or after the current component.
Members
- Destination
-
- Type: NetworkPathComponentDetails structure
Information about the destination of the component.
- Protocol
-
- Type: string
The protocol used for the component.
- Source
-
- Type: NetworkPathComponentDetails structure
Information about the origin of the component.
NetworkPathComponent
Description
Information about a network path component.
Members
- ComponentId
-
- Type: string
The identifier of a component in the network path.
- ComponentType
-
- Type: string
The type of component.
- Egress
-
- Type: NetworkHeader structure
Information about the component that comes after the current component in the network path.
- Ingress
-
- Type: NetworkHeader structure
Information about the component that comes before the current node in the network path.
NetworkPathComponentDetails
Description
Information about the destination of the next component in the network path.
Members
- Address
-
- Type: Array of strings
The IP addresses of the destination.
- PortRanges
-
- Type: Array of PortRange structures
A list of port ranges for the destination.
Note
Description
A user-defined note added to a finding.
Members
NoteUpdate
Description
The updated note.
Members
NumberFilter
Description
A number filter for querying findings.
Members
- Eq
-
- Type: double
The equal-to condition to be applied to a single field when querying for findings.
- Gte
-
- Type: double
The greater-than-equal condition to be applied to a single field when querying for findings.
- Lte
-
- Type: double
The less-than-equal condition to be applied to a single field when querying for findings.
PortRange
Description
A range of ports.
Members
ProcessDetails
Description
The details of process-related information about a finding.
Members
- LaunchedAt
-
- Type: string
The date/time that the process was launched.
- Name
-
- Type: string
The name of the process.
- ParentPid
-
- Type: int
The parent process ID.
- Path
-
- Type: string
The path to the process executable.
- Pid
-
- Type: int
The process ID.
- TerminatedAt
-
- Type: string
The date and time when the process was terminated.
Product
Description
Contains details about a product.
Members
- ActivationUrl
-
- Type: string
The URL used to activate the product.
- Categories
-
- Type: Array of strings
The categories assigned to the product.
- CompanyName
-
- Type: string
The name of the company that provides the product.
- Description
-
- Type: string
A description of the product.
- IntegrationTypes
-
- Type: Array of strings
The types of integration that the product supports. Available values are the following.
-
SEND_FINDINGS_TO_SECURITY_HUB- Indicates that the integration sends findings to Security Hub. -
RECEIVE_FINDINGS_FROM_SECURITY_HUB- Indicates that the integration receives findings from Security Hub.
- MarketplaceUrl
-
- Type: string
The URL for the page that contains more information about the product.
- ProductArn
-
- Required: Yes
- Type: string
The ARN assigned to the product.
- ProductName
-
- Type: string
The name of the product.
- ProductSubscriptionResourcePolicy
-
- Type: string
The resource policy associated with the product.
Recommendation
Description
A recommendation on how to remediate the issue identified in a finding.
Members
RelatedFinding
Description
Details about a related finding.
Members
Remediation
Description
Details about the remediation steps for a finding.
Members
- Recommendation
-
- Type: Recommendation structure
A recommendation on the steps to take to remediate the issue identified by a finding.
Resource
Description
A resource related to a finding.
Members
- Details
-
- Type: ResourceDetails structure
Additional details about the resource related to a finding.
- Id
-
- Required: Yes
- Type: string
The canonical identifier for the given resource type.
- Partition
-
- Type: string
The canonical AWS partition name that the Region is assigned to.
- Region
-
- Type: string
The canonical AWS external Region name where this resource is located.
- Tags
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
A list of AWS tags associated with a resource at the time the finding was processed.
- Type
-
- Required: Yes
- Type: string
The type of the resource that details are provided for. If possible, set
Typeto one of the supported resource types. For example, if the resource is an EC2 instance, then setTypetoAwsEc2Instance.If the resource does not match any of the provided types, then set
TypetoOther.
ResourceConflictException
Description
The resource specified in the request conflicts with an existing resource.
Members
ResourceDetails
Description
Additional details about a resource related to a finding.
To provide the details, use the object that corresponds to the resource type. For example, if the resource type is AwsEc2Instance, then you use the AwsEc2Instance object to provide the details.
If the type-specific object does not contain all of the fields you want to populate, then you use the Other object to populate those additional fields.
You also use the Other object to populate the details when the selected type does not have a corresponding object.
Members
- AwsAutoScalingAutoScalingGroup
-
- Type: AwsAutoScalingAutoScalingGroupDetails structure
Details for an autoscaling group.
- AwsCloudFrontDistribution
-
- Type: AwsCloudFrontDistributionDetails structure
Details about a CloudFront distribution.
- AwsCodeBuildProject
-
- Type: AwsCodeBuildProjectDetails structure
Details for an AWS CodeBuild project.
- AwsEc2Instance
-
- Type: AwsEc2InstanceDetails structure
Details about an Amazon EC2 instance related to a finding.
- AwsEc2NetworkInterface
-
- Type: AwsEc2NetworkInterfaceDetails structure
Details for an Amazon EC2 network interface.
- AwsEc2SecurityGroup
-
- Type: AwsEc2SecurityGroupDetails structure
Details for an EC2 security group.
- AwsEc2Volume
-
- Type: AwsEc2VolumeDetails structure
Details for an EC2 volume.
- AwsEc2Vpc
-
- Type: AwsEc2VpcDetails structure
Details for an EC2 VPC.
- AwsElasticsearchDomain
-
- Type: AwsElasticsearchDomainDetails structure
Details for an Elasticsearch domain.
- AwsElbv2LoadBalancer
-
- Type: AwsElbv2LoadBalancerDetails structure
Details about a load balancer.
- AwsIamAccessKey
-
- Type: AwsIamAccessKeyDetails structure
Details about an IAM access key related to a finding.
- AwsIamRole
-
- Type: AwsIamRoleDetails structure
Details about an IAM role.
- AwsKmsKey
-
- Type: AwsKmsKeyDetails structure
Details about a KMS key.
- AwsLambdaFunction
-
- Type: AwsLambdaFunctionDetails structure
Details about a Lambda function.
- AwsLambdaLayerVersion
-
- Type: AwsLambdaLayerVersionDetails structure
Details for a Lambda layer version.
- AwsRdsDbInstance
-
- Type: AwsRdsDbInstanceDetails structure
Details for an Amazon RDS database instance.
- AwsS3Bucket
-
- Type: AwsS3BucketDetails structure
Details about an Amazon S3 bucket related to a finding.
- AwsS3Object
-
- Type: AwsS3ObjectDetails structure
Details about an Amazon S3 object related to a finding.
- AwsSnsTopic
-
- Type: AwsSnsTopicDetails structure
Details about an SNS topic.
- AwsSqsQueue
-
- Type: AwsSqsQueueDetails structure
Details about an SQS queue.
- AwsWafWebAcl
-
- Type: AwsWafWebAclDetails structure
Details for a WAF WebACL.
- Container
-
- Type: ContainerDetails structure
Details about a container resource related to a finding.
- Other
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
Details about a resource that are not available in a type-specific details object. Use the
Otherobject in the following cases.-
The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the
Otherobject to populate the fields that are missing from the type-specific object. -
The resource type does not have a corresponding object. This includes resources for which the type is
Other.
ResourceNotFoundException
Description
The request was rejected because we can't find the specified resource.
Members
Result
Description
Details about the account that was not processed.
Members
Severity
Description
The severity of the finding.
The finding provider can provide the initial severity, but cannot update it after that. The severity can only be updated by a master account. It cannot be updated by a member account.
The finding must have either Label or Normalized populated. If only one of these attributes is populated, then Security Hub automatically populates the other one. If neither attribute is populated, then the finding is invalid. Label is the preferred attribute.
Members
- Label
-
- Type: string
The severity value of the finding. The allowed values are the following.
-
INFORMATIONAL- No issue was found. -
LOW- The issue does not require action on its own. -
MEDIUM- The issue must be addressed but not urgently. -
HIGH- The issue must be addressed as a priority. -
CRITICAL- The issue must be remediated immediately to avoid it escalating.
If you provide
Normalizedand do not provideLabel, thenLabelis set automatically as follows.-
0 -
INFORMATIONAL -
1–39 -
LOW -
40–69 -
MEDIUM -
70–89 -
HIGH -
90–100 -
CRITICAL
- Normalized
-
- Type: int
Deprecated. The normalized severity of a finding. This attribute is being deprecated. Instead of providing
Normalized, provideLabel.If you provide
Labeland do not provideNormalized, thenNormalizedis set automatically as follows.-
INFORMATIONAL- 0 -
LOW- 1 -
MEDIUM- 40 -
HIGH- 70 -
CRITICAL- 90
- Original
-
- Type: string
The native severity from the finding product that generated the finding.
- Product
-
- Type: double
Deprecated. This attribute is being deprecated. Instead of providing
Product, provideOriginal.The native severity as defined by the AWS service or integrated partner product that generated the finding.
SeverityUpdate
Description
Updates to the severity information for a finding.
Members
- Label
-
- Type: string
The severity value of the finding. The allowed values are the following.
-
INFORMATIONAL- No issue was found. -
LOW- The issue does not require action on its own. -
MEDIUM- The issue must be addressed but not urgently. -
HIGH- The issue must be addressed as a priority. -
CRITICAL- The issue must be remediated immediately to avoid it escalating.
- Normalized
-
- Type: int
The normalized severity for the finding. This attribute is to be deprecated in favor of
Label.If you provide
Normalizedand do not provideLabel,Labelis set automatically as follows.-
0 -
INFORMATIONAL -
1–39 -
LOW -
40–69 -
MEDIUM -
70–89 -
HIGH -
90–100 -
CRITICAL
- Product
-
- Type: double
The native severity as defined by the AWS service or integrated partner product that generated the finding.
SoftwarePackage
Description
Information about a software package.
Members
SortCriterion
Description
A collection of finding attributes used to sort findings.
Members
Standard
Description
Provides information about a specific standard.
Members
- Description
-
- Type: string
A description of the standard.
- EnabledByDefault
-
- Type: boolean
Whether the standard is enabled by default. When Security Hub is enabled from the console, if a standard is enabled by default, the check box for that standard is selected by default.
When Security Hub is enabled using the
EnableSecurityHubAPI operation, the standard is enabled by default unlessEnableDefaultStandardsis set tofalse. - Name
-
- Type: string
The name of the standard.
- StandardsArn
-
- Type: string
The ARN of a standard.
StandardsControl
Description
Details for an individual security standard control.
Members
- ControlId
-
- Type: string
The identifier of the security standard control.
- ControlStatus
-
- Type: string
The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.
- ControlStatusUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the status of the security standard control was most recently updated.
- Description
-
- Type: string
The longer description of the security standard control. Provides information about what the control is checking for.
- DisabledReason
-
- Type: string
The reason provided for the most recent change in status for the control.
- RelatedRequirements
-
- Type: Array of strings
The list of requirements that are related to this control.
- RemediationUrl
-
- Type: string
A link to remediation information for the control in the Security Hub user documentation.
- SeverityRating
-
- Type: string
The severity of findings generated from this security standard control.
The finding severity is based on an assessment of how easy it would be to compromise AWS resources if the issue is detected.
- StandardsControlArn
-
- Type: string
The ARN of the security standard control.
- Title
-
- Type: string
The title of the security standard control.
StandardsSubscription
Description
A resource that represents your subscription to a supported standard.
Members
- StandardsArn
-
- Required: Yes
- Type: string
The ARN of a standard.
- StandardsInput
-
- Required: Yes
- Type: Associative array of custom strings keys (NonEmptyString) to strings
A key-value pair of input for the standard.
- StandardsStatus
-
- Required: Yes
- Type: string
The status of the standards subscription.
- StandardsSubscriptionArn
-
- Required: Yes
- Type: string
The ARN of a resource that represents your subscription to a supported standard.
StandardsSubscriptionRequest
Description
The standard that you want to enable.
Members
- StandardsArn
-
- Required: Yes
- Type: string
The ARN of the standard that you want to enable. To view the list of available standards and their ARNs, use the
DescribeStandardsoperation. - StandardsInput
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
A key-value pair of input for the standard.
StatusReason
Description
Provides additional context for the value of Compliance.Status.
Members
- Description
-
- Type: string
The corresponding description for the status reason code.
- ReasonCode
-
- Required: Yes
- Type: string
A code that represents a reason for the control status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the AWS Security Hub User Guide.
StringFilter
Description
A string filter for querying findings.
Members
ThreatIntelIndicator
Description
Details about the threat intelligence related to a finding.
Members
- Category
-
- Type: string
The category of a threat intelligence indicator.
- LastObservedAt
-
- Type: string
The date and time when the most recent instance of a threat intelligence indicator was observed.
- Source
-
- Type: string
The source of the threat intelligence indicator.
- SourceUrl
-
- Type: string
The URL to the page or site where you can get more information about the threat intelligence indicator.
- Type
-
- Type: string
The type of threat intelligence indicator.
- Value
-
- Type: string
The value of a threat intelligence indicator.
Vulnerability
Description
A vulnerability associated with a finding.
Members
- Cvss
-
- Type: Array of Cvss structures
CVSS scores from the advisory related to the vulnerability.
- Id
-
- Required: Yes
- Type: string
The identifier of the vulnerability.
- ReferenceUrls
-
- Type: Array of strings
A list of URLs that provide additional information about the vulnerability.
- RelatedVulnerabilities
-
- Type: Array of strings
List of vulnerabilities that are related to this vulnerability.
- Vendor
-
- Type: VulnerabilityVendor structure
Information about the vendor that generates the vulnerability report.
- VulnerablePackages
-
- Type: Array of SoftwarePackage structures
List of software packages that have the vulnerability.
VulnerabilityVendor
Description
A vendor that generates a vulnerability report.
Members
- Name
-
- Required: Yes
- Type: string
The name of the vendor.
- Url
-
- Type: string
The URL of the vulnerability advisory.
- VendorCreatedAt
-
- Type: string
The datetime when the vulnerability advisory was created.
- VendorSeverity
-
- Type: string
The severity that the vendor assigned to the vulnerability.
- VendorUpdatedAt
-
- Type: string
The datetime when the vulnerability advisory was last updated.
WafAction
Description
Details about the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
Members
- Type
-
- Type: string
Specifies how you want AWS WAF to respond to requests that match the settings in a rule.
Valid settings include the following:
-
ALLOW- AWS WAF allows requests -
BLOCK- AWS WAF blocks requests -
COUNT- AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specifyCOUNTfor the default action for a WebACL.
WafExcludedRule
Description
Details about a rule to exclude from a rule group.
Members
WafOverrideAction
Description
Details about an override action for a rule.
Members
Workflow
Description
Provides information about the status of the investigation into a finding.
Members
- Status
-
- Type: string
The status of the investigation into the finding. The allowed values are the following.
-
NEW- The initial state of a finding, before it is reviewed. -
NOTIFIED- Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. -
SUPPRESSED- The finding will not be reviewed again and will not be acted upon. -
RESOLVED- The finding was reviewed and remediated and is now considered resolved.
WorkflowUpdate
Description
Used to update information about the investigation into the finding.
Members
- Status
-
- Type: string
The status of the investigation into the finding. The allowed values are the following.
-
NEW- The initial state of a finding, before it is reviewed. -
NOTIFIED- Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. -
RESOLVED- The finding was reviewed and remediated and is now considered resolved. -
SUPPRESSED- The finding will not be reviewed again and will not be acted upon.
