Package-level declarations

Types

Link copied to clipboard
data class AutomationRuleDateFilter(val dateRange: AutomationRuleDateRange? = null, val end: String? = null, val start: String? = null)

A date filter for querying findings.

Link copied to clipboard

A date range for the date filter.

Link copied to clipboard
data class AutomationRuleMapFilter(val comparison: AutomationRuleMapFilterComparison, val key: String, val value: String)

A map filter for filtering ASHlong findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.

Link copied to clipboard
data class AutomationRuleNoteUpdate(val text: String, val updatedBy: String)

The updated note.

Link copied to clipboard
data class AutomationRuleNumberFilter(val eq: Double? = null, val gte: Double? = null, val lte: Double? = null)

A number filter for querying findings.

Link copied to clipboard
data class AutomationRuleRelatedFinding(val id: String, val productArn: String)

Provides details about a list of findings that the current finding relates to.

Link copied to clipboard

One or more actions to update finding fields if a finding matches the defined criteria of the rule.

Link copied to clipboard
data class AutomationRuleSeverityUpdate(val label: AutomationRuleSeverityUpdateLabel? = null, val normalized: Int? = null, val product: Double? = null)

Updates to the severity information for a finding.

Link copied to clipboard
data class AutomationRulesFindingFieldsUpdate(val confidence: Int? = null, val criticality: Int? = null, val note: AutomationRuleNoteUpdate? = null, val relatedFindings: List<AutomationRuleRelatedFinding>? = null, val severity: AutomationRuleSeverityUpdate? = null, val types: List<String>? = null, val userDefinedFields: Map<String, String>? = null, val verificationState: AutomationRulesFindingFieldsUpdateVerificationState? = null, val workflow: AutomationRuleWorkflowUpdate? = null)

Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria.

Link copied to clipboard
data class AutomationRulesFindingFilters(val awsAccountId: List<AutomationRuleStringFilter>? = null, val companyName: List<AutomationRuleStringFilter>? = null, val complianceAssociatedStandardsId: List<AutomationRuleStringFilter>? = null, val complianceSecurityControlId: List<AutomationRuleStringFilter>? = null, val complianceStatus: List<AutomationRuleStringFilter>? = null, val confidence: List<AutomationRuleNumberFilter>? = null, val createdAt: List<AutomationRuleDateFilter>? = null, val criticality: List<AutomationRuleNumberFilter>? = null, val description: List<AutomationRuleStringFilter>? = null, val firstObservedAt: List<AutomationRuleDateFilter>? = null, val generatorId: List<AutomationRuleStringFilter>? = null, val id: List<AutomationRuleStringFilter>? = null, val lastObservedAt: List<AutomationRuleDateFilter>? = null, val noteText: List<AutomationRuleStringFilter>? = null, val noteUpdatedAt: List<AutomationRuleDateFilter>? = null, val noteUpdatedBy: List<AutomationRuleStringFilter>? = null, val productArn: List<AutomationRuleStringFilter>? = null, val productName: List<AutomationRuleStringFilter>? = null, val recordState: List<AutomationRuleStringFilter>? = null, val relatedFindingsId: List<AutomationRuleStringFilter>? = null, val relatedFindingsProductArn: List<AutomationRuleStringFilter>? = null, val resourceDetailsOther: List<AutomationRuleMapFilter>? = null, val resourceId: List<AutomationRuleStringFilter>? = null, val resourcePartition: List<AutomationRuleStringFilter>? = null, val resourceRegion: List<AutomationRuleStringFilter>? = null, val resourceTags: List<AutomationRuleMapFilter>? = null, val resourceType: List<AutomationRuleStringFilter>? = null, val severityLabel: List<AutomationRuleStringFilter>? = null, val sourceUrl: List<AutomationRuleStringFilter>? = null, val title: List<AutomationRuleStringFilter>? = null, val type: List<AutomationRuleStringFilter>? = null, val updatedAt: List<AutomationRuleDateFilter>? = null, val userDefinedFields: List<AutomationRuleMapFilter>? = null, val verificationState: List<AutomationRuleStringFilter>? = null, val workflowStatus: List<AutomationRuleStringFilter>? = null)

The criteria that determine which findings a rule applies to.

Link copied to clipboard

A string filter for filtering ASHlong findings.

Link copied to clipboard

Used to update information about the investigation into the finding.

An object that provides the current value of a security control parameter and identifies whether it has been customized.

Link copied to clipboard
data class ConfigurationPolicyParameterValue(val boolean: Boolean? = null, val double: Double? = null, val enum: String? = null, val enumList: List<String>? = null, val integer: Int? = null, val integerList: List<Int>? = null, val string: String? = null, val stringList: List<String>? = null)

An object that includes the data type of a security control parameter and its current value.

Link copied to clipboard

An object that defines how Security Hub is configured.

data class ConfigurationPolicySecurityControlCustomParameter(val parameters: Map<String, ConfigurationPolicyParameterConfiguration>? = null, val securityControlId: String? = null)

An object of security control and control parameter value that are included in a configuration policy.

data class ConfigurationPolicySecurityControlsConfiguration(val disabledSecurityControlIdentifiers: List<String>? = null, val enabledSecurityControlIdentifiers: List<String>? = null, val securityControlCustomParameters: List<ConfigurationPolicySecurityControlCustomParameter>? = null)

An object that defines which security controls are enabled in an AWS Security Hub configuration policy.

Link copied to clipboard
data class ConfigurationPolicySecurityHubPolicy(val enabledStandardIdentifiers: List<String>? = null, val securityControlsConfiguration: ConfigurationPolicySecurityControlsConfiguration? = null, val serviceEnabled: Boolean? = null)

An object that defines how AWS Security Hub is configured.

Link copied to clipboard
data class GetAutomationRuleResult(val actions: List<AutomationRulesAction>? = null, val createdAt: String? = null, val createdBy: String? = null, val criteria: AutomationRulesFindingFilters? = null, val description: String? = null, val isTerminal: Boolean? = null, val ruleArn: String? = null, val ruleName: String? = null, val ruleOrder: Int? = null, val ruleStatus: AutomationRuleRuleStatus? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetConfigurationPolicyResult(val arn: String? = null, val configurationPolicy: ConfigurationPolicyPolicy? = null, val createdAt: String? = null, val description: String? = null, val id: String? = null, val name: String? = null, val serviceEnabled: Boolean? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetDelegatedAdminResult(val delegatedAdminIdentifier: String? = null, val status: DelegatedAdminStatus? = null)
Link copied to clipboard
data class GetFindingAggregatorResult(val findingAggregationRegion: String? = null, val findingAggregatorArn: String? = null, val regionLinkingMode: FindingAggregatorRegionLinkingMode? = null, val regions: List<String>? = null)
Link copied to clipboard
data class GetHubResult(val arn: String? = null, val autoEnableControls: Boolean? = null, val controlFindingGenerator: String? = null, val subscribedAt: String? = null, val tags: Map<String, String>? = null)
Link copied to clipboard
data class GetInsightResult(val filters: InsightAwsSecurityFindingFilters? = null, val groupByAttribute: String? = null, val insightArn: String? = null, val name: String? = null)
Link copied to clipboard
data class GetOrganizationConfigurationResult(val autoEnable: Boolean? = null, val autoEnableStandards: OrganizationConfigurationAutoEnableStandards? = null, val configurationType: OrganizationConfigurationConfigurationType? = null, val memberAccountLimitReached: Boolean? = null, val organizationConfigurationIdentifier: String? = null, val status: OrganizationConfigurationStatus? = null, val statusMessage: String? = null)
Link copied to clipboard
data class GetPolicyAssociationResult(val associationIdentifier: String? = null, val associationStatus: PolicyAssociationAssociationStatus? = null, val associationStatusMessage: String? = null, val associationType: PolicyAssociationAssociationType? = null, val configurationPolicyId: String? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetProductSubscriptionResult(val productSubscriptionArn: String? = null)
Link copied to clipboard
data class GetSecurityControlResult(val lastUpdateReason: String? = null, val parameters: Map<String, SecurityControlParameterConfiguration>? = null, val securityControlArn: String? = null)
Link copied to clipboard
data class GetStandardResult(val disabledStandardsControls: List<StandardsControl>? = null, val standardsSubscriptionArn: String? = null)
Link copied to clipboard
data class InsightAwsSecurityFindingFilters(val awsAccountId: List<InsightStringFilter>? = null, val awsAccountName: List<InsightStringFilter>? = null, val companyName: List<InsightStringFilter>? = null, val complianceAssociatedStandardsId: List<InsightStringFilter>? = null, val complianceSecurityControlId: List<InsightStringFilter>? = null, val complianceSecurityControlParametersName: List<InsightStringFilter>? = null, val complianceSecurityControlParametersValue: List<InsightStringFilter>? = null, val complianceStatus: List<InsightStringFilter>? = null, val confidence: List<InsightNumberFilter>? = null, val createdAt: List<InsightDateFilter>? = null, val criticality: List<InsightNumberFilter>? = null, val description: List<InsightStringFilter>? = null, val findingProviderFieldsConfidence: List<InsightNumberFilter>? = null, val findingProviderFieldsCriticality: List<InsightNumberFilter>? = null, val findingProviderFieldsRelatedFindingsId: List<InsightStringFilter>? = null, val findingProviderFieldsRelatedFindingsProductArn: List<InsightStringFilter>? = null, val findingProviderFieldsSeverityLabel: List<InsightStringFilter>? = null, val findingProviderFieldsSeverityOriginal: List<InsightStringFilter>? = null, val findingProviderFieldsTypes: List<InsightStringFilter>? = null, val firstObservedAt: List<InsightDateFilter>? = null, val generatorId: List<InsightStringFilter>? = null, val id: List<InsightStringFilter>? = null, val keyword: List<InsightKeywordFilter>? = null, val lastObservedAt: List<InsightDateFilter>? = null, val malwareName: List<InsightStringFilter>? = null, val malwarePath: List<InsightStringFilter>? = null, val malwareState: List<InsightStringFilter>? = null, val malwareType: List<InsightStringFilter>? = null, val networkDestinationDomain: List<InsightStringFilter>? = null, val networkDestinationIpV4: List<InsightIpFilter>? = null, val networkDestinationIpV6: List<InsightIpFilter>? = null, val networkDestinationPort: List<InsightNumberFilter>? = null, val networkDirection: List<InsightStringFilter>? = null, val networkProtocol: List<InsightStringFilter>? = null, val networkSourceDomain: List<InsightStringFilter>? = null, val networkSourceIpV4: List<InsightIpFilter>? = null, val networkSourceIpV6: List<InsightIpFilter>? = null, val networkSourceMac: List<InsightStringFilter>? = null, val networkSourcePort: List<InsightNumberFilter>? = null, val noteText: List<InsightStringFilter>? = null, val noteUpdatedAt: List<InsightDateFilter>? = null, val noteUpdatedBy: List<InsightStringFilter>? = null, val processLaunchedAt: List<InsightDateFilter>? = null, val processName: List<InsightStringFilter>? = null, val processParentPid: List<InsightNumberFilter>? = null, val processPath: List<InsightStringFilter>? = null, val processPid: List<InsightNumberFilter>? = null, val processTerminatedAt: List<InsightDateFilter>? = null, val productArn: List<InsightStringFilter>? = null, val productFields: List<InsightMapFilter>? = null, val productName: List<InsightStringFilter>? = null, val recommendationText: List<InsightStringFilter>? = null, val recordState: List<InsightStringFilter>? = null, val region: List<InsightStringFilter>? = null, val relatedFindingsId: List<InsightStringFilter>? = null, val relatedFindingsProductArn: List<InsightStringFilter>? = null, val resourceApplicationArn: List<InsightStringFilter>? = null, val resourceApplicationName: List<InsightStringFilter>? = null, val resourceAwsEc2InstanceIamInstanceProfileArn: List<InsightStringFilter>? = null, val resourceAwsEc2InstanceImageId: List<InsightStringFilter>? = null, val resourceAwsEc2InstanceIpV4Addresses: List<InsightIpFilter>? = null, val resourceAwsEc2InstanceIpV6Addresses: List<InsightIpFilter>? = null, val resourceAwsEc2InstanceKeyName: List<InsightStringFilter>? = null, val resourceAwsEc2InstanceLaunchedAt: List<InsightDateFilter>? = null, val resourceAwsEc2InstanceSubnetId: List<InsightStringFilter>? = null, val resourceAwsEc2InstanceType: List<InsightStringFilter>? = null, val resourceAwsEc2InstanceVpcId: List<InsightStringFilter>? = null, val resourceAwsIamAccessKeyCreatedAt: List<InsightDateFilter>? = null, val resourceAwsIamAccessKeyPrincipalName: List<InsightStringFilter>? = null, val resourceAwsIamAccessKeyStatus: List<InsightStringFilter>? = null, val resourceAwsIamAccessKeyUserName: List<InsightStringFilter>? = null, val resourceAwsIamUserUserName: List<InsightStringFilter>? = null, val resourceAwsS3BucketOwnerId: List<InsightStringFilter>? = null, val resourceAwsS3BucketOwnerName: List<InsightStringFilter>? = null, val resourceContainerImageId: List<InsightStringFilter>? = null, val resourceContainerImageName: List<InsightStringFilter>? = null, val resourceContainerLaunchedAt: List<InsightDateFilter>? = null, val resourceContainerName: List<InsightStringFilter>? = null, val resourceDetailsOther: List<InsightMapFilter>? = null, val resourceId: List<InsightStringFilter>? = null, val resourcePartition: List<InsightStringFilter>? = null, val resourceRegion: List<InsightStringFilter>? = null, val resourceTags: List<InsightMapFilter>? = null, val resourceType: List<InsightStringFilter>? = null, val sample: List<InsightBooleanFilter>? = null, val severityLabel: List<InsightStringFilter>? = null, val severityNormalized: List<InsightNumberFilter>? = null, val severityProduct: List<InsightNumberFilter>? = null, val sourceUrl: List<InsightStringFilter>? = null, val threatIntelIndicatorCategory: List<InsightStringFilter>? = null, val threatIntelIndicatorLastObservedAt: List<InsightDateFilter>? = null, val threatIntelIndicatorSource: List<InsightStringFilter>? = null, val threatIntelIndicatorSourceUrl: List<InsightStringFilter>? = null, val threatIntelIndicatorType: List<InsightStringFilter>? = null, val threatIntelIndicatorValue: List<InsightStringFilter>? = null, val title: List<InsightStringFilter>? = null, val type: List<InsightStringFilter>? = null, val updatedAt: List<InsightDateFilter>? = null, val userDefinedFields: List<InsightMapFilter>? = null, val verificationState: List<InsightStringFilter>? = null, val vulnerabilitiesExploitAvailable: List<InsightStringFilter>? = null, val vulnerabilitiesFixAvailable: List<InsightStringFilter>? = null, val workflowState: List<InsightStringFilter>? = null, val workflowStatus: List<InsightStringFilter>? = null)

A collection of filters that are applied to all active findings aggregated by AWS Security Hub.

Link copied to clipboard
data class InsightBooleanFilter(val value: Boolean)

Boolean filter for querying findings.

Link copied to clipboard
data class InsightDateFilter(val dateRange: InsightDateRange? = null, val end: String? = null, val start: String? = null)

A date filter for querying findings.

Link copied to clipboard
data class InsightDateRange(val unit: InsightDateRangeUnit, val value: Double)

A date range for the date filter.

Link copied to clipboard
data class InsightIpFilter(val cidr: String)

The IP filter for querying findings.

Link copied to clipboard
data class InsightKeywordFilter(val value: String)

A keyword filter for querying findings.

Link copied to clipboard
data class InsightMapFilter(val comparison: InsightMapFilterComparison, val key: String, val value: String)

A map filter for filtering AWS Security Hub findings.

Link copied to clipboard
data class InsightNumberFilter(val eq: Double? = null, val gte: Double? = null, val lte: Double? = null)

A number filter for querying findings.

Link copied to clipboard
data class InsightStringFilter(val comparison: InsightStringFilterComparison, val value: String)

A string filter for filtering AWS Security Hub findings.

Link copied to clipboard
data class SecurityControlParameterValue(val boolean: Boolean? = null, val double: Double? = null, val enum: String? = null, val enumList: List<String>? = null, val integer: Int? = null, val integerList: List<Int>? = null, val string: String? = null, val stringList: List<String>? = null)
Link copied to clipboard
data class StandardsControl(val reason: String? = null, val standardsControlArn: String)

Provides details about an individual security control. For a list of ASH controls, see controls reference in the User Guide.