serverless-offline-msk
Version:
A serverless offline plugin that enables AWS MSK events
1,276 lines • 91.3 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Inspector2 extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Inspector2.Types.ClientConfiguration)
config: Config & Inspector2.Types.ClientConfiguration;
/**
* Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.
*/
associateMember(params: Inspector2.Types.AssociateMemberRequest, callback?: (err: AWSError, data: Inspector2.Types.AssociateMemberResponse) => void): Request<Inspector2.Types.AssociateMemberResponse, AWSError>;
/**
* Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.
*/
associateMember(callback?: (err: AWSError, data: Inspector2.Types.AssociateMemberResponse) => void): Request<Inspector2.Types.AssociateMemberResponse, AWSError>;
/**
* Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
*/
batchGetAccountStatus(params: Inspector2.Types.BatchGetAccountStatusRequest, callback?: (err: AWSError, data: Inspector2.Types.BatchGetAccountStatusResponse) => void): Request<Inspector2.Types.BatchGetAccountStatusResponse, AWSError>;
/**
* Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
*/
batchGetAccountStatus(callback?: (err: AWSError, data: Inspector2.Types.BatchGetAccountStatusResponse) => void): Request<Inspector2.Types.BatchGetAccountStatusResponse, AWSError>;
/**
* Gets free trial status for multiple Amazon Web Services accounts.
*/
batchGetFreeTrialInfo(params: Inspector2.Types.BatchGetFreeTrialInfoRequest, callback?: (err: AWSError, data: Inspector2.Types.BatchGetFreeTrialInfoResponse) => void): Request<Inspector2.Types.BatchGetFreeTrialInfoResponse, AWSError>;
/**
* Gets free trial status for multiple Amazon Web Services accounts.
*/
batchGetFreeTrialInfo(callback?: (err: AWSError, data: Inspector2.Types.BatchGetFreeTrialInfoResponse) => void): Request<Inspector2.Types.BatchGetFreeTrialInfoResponse, AWSError>;
/**
* Cancels the given findings report.
*/
cancelFindingsReport(params: Inspector2.Types.CancelFindingsReportRequest, callback?: (err: AWSError, data: Inspector2.Types.CancelFindingsReportResponse) => void): Request<Inspector2.Types.CancelFindingsReportResponse, AWSError>;
/**
* Cancels the given findings report.
*/
cancelFindingsReport(callback?: (err: AWSError, data: Inspector2.Types.CancelFindingsReportResponse) => void): Request<Inspector2.Types.CancelFindingsReportResponse, AWSError>;
/**
* Creates a filter resource using specified filter criteria.
*/
createFilter(params: Inspector2.Types.CreateFilterRequest, callback?: (err: AWSError, data: Inspector2.Types.CreateFilterResponse) => void): Request<Inspector2.Types.CreateFilterResponse, AWSError>;
/**
* Creates a filter resource using specified filter criteria.
*/
createFilter(callback?: (err: AWSError, data: Inspector2.Types.CreateFilterResponse) => void): Request<Inspector2.Types.CreateFilterResponse, AWSError>;
/**
* Creates a finding report.
*/
createFindingsReport(params: Inspector2.Types.CreateFindingsReportRequest, callback?: (err: AWSError, data: Inspector2.Types.CreateFindingsReportResponse) => void): Request<Inspector2.Types.CreateFindingsReportResponse, AWSError>;
/**
* Creates a finding report.
*/
createFindingsReport(callback?: (err: AWSError, data: Inspector2.Types.CreateFindingsReportResponse) => void): Request<Inspector2.Types.CreateFindingsReportResponse, AWSError>;
/**
* Deletes a filter resource.
*/
deleteFilter(params: Inspector2.Types.DeleteFilterRequest, callback?: (err: AWSError, data: Inspector2.Types.DeleteFilterResponse) => void): Request<Inspector2.Types.DeleteFilterResponse, AWSError>;
/**
* Deletes a filter resource.
*/
deleteFilter(callback?: (err: AWSError, data: Inspector2.Types.DeleteFilterResponse) => void): Request<Inspector2.Types.DeleteFilterResponse, AWSError>;
/**
* Describe Amazon Inspector configuration settings for an Amazon Web Services organization
*/
describeOrganizationConfiguration(params: Inspector2.Types.DescribeOrganizationConfigurationRequest, callback?: (err: AWSError, data: Inspector2.Types.DescribeOrganizationConfigurationResponse) => void): Request<Inspector2.Types.DescribeOrganizationConfigurationResponse, AWSError>;
/**
* Describe Amazon Inspector configuration settings for an Amazon Web Services organization
*/
describeOrganizationConfiguration(callback?: (err: AWSError, data: Inspector2.Types.DescribeOrganizationConfigurationResponse) => void): Request<Inspector2.Types.DescribeOrganizationConfigurationResponse, AWSError>;
/**
* Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.
*/
disable(params: Inspector2.Types.DisableRequest, callback?: (err: AWSError, data: Inspector2.Types.DisableResponse) => void): Request<Inspector2.Types.DisableResponse, AWSError>;
/**
* Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.
*/
disable(callback?: (err: AWSError, data: Inspector2.Types.DisableResponse) => void): Request<Inspector2.Types.DisableResponse, AWSError>;
/**
* Disables the Amazon Inspector delegated administrator for your organization.
*/
disableDelegatedAdminAccount(params: Inspector2.Types.DisableDelegatedAdminAccountRequest, callback?: (err: AWSError, data: Inspector2.Types.DisableDelegatedAdminAccountResponse) => void): Request<Inspector2.Types.DisableDelegatedAdminAccountResponse, AWSError>;
/**
* Disables the Amazon Inspector delegated administrator for your organization.
*/
disableDelegatedAdminAccount(callback?: (err: AWSError, data: Inspector2.Types.DisableDelegatedAdminAccountResponse) => void): Request<Inspector2.Types.DisableDelegatedAdminAccountResponse, AWSError>;
/**
* Disassociates a member account from an Amazon Inspector delegated administrator.
*/
disassociateMember(params: Inspector2.Types.DisassociateMemberRequest, callback?: (err: AWSError, data: Inspector2.Types.DisassociateMemberResponse) => void): Request<Inspector2.Types.DisassociateMemberResponse, AWSError>;
/**
* Disassociates a member account from an Amazon Inspector delegated administrator.
*/
disassociateMember(callback?: (err: AWSError, data: Inspector2.Types.DisassociateMemberResponse) => void): Request<Inspector2.Types.DisassociateMemberResponse, AWSError>;
/**
* Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
*/
enable(params: Inspector2.Types.EnableRequest, callback?: (err: AWSError, data: Inspector2.Types.EnableResponse) => void): Request<Inspector2.Types.EnableResponse, AWSError>;
/**
* Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
*/
enable(callback?: (err: AWSError, data: Inspector2.Types.EnableResponse) => void): Request<Inspector2.Types.EnableResponse, AWSError>;
/**
* Enables the Amazon Inspector delegated administrator for your Organizations organization.
*/
enableDelegatedAdminAccount(params: Inspector2.Types.EnableDelegatedAdminAccountRequest, callback?: (err: AWSError, data: Inspector2.Types.EnableDelegatedAdminAccountResponse) => void): Request<Inspector2.Types.EnableDelegatedAdminAccountResponse, AWSError>;
/**
* Enables the Amazon Inspector delegated administrator for your Organizations organization.
*/
enableDelegatedAdminAccount(callback?: (err: AWSError, data: Inspector2.Types.EnableDelegatedAdminAccountResponse) => void): Request<Inspector2.Types.EnableDelegatedAdminAccountResponse, AWSError>;
/**
* Retrieves setting configurations for Inspector scans.
*/
getConfiguration(params: Inspector2.Types.GetConfigurationRequest, callback?: (err: AWSError, data: Inspector2.Types.GetConfigurationResponse) => void): Request<Inspector2.Types.GetConfigurationResponse, AWSError>;
/**
* Retrieves setting configurations for Inspector scans.
*/
getConfiguration(callback?: (err: AWSError, data: Inspector2.Types.GetConfigurationResponse) => void): Request<Inspector2.Types.GetConfigurationResponse, AWSError>;
/**
* Retrieves information about the Amazon Inspector delegated administrator for your organization.
*/
getDelegatedAdminAccount(params: Inspector2.Types.GetDelegatedAdminAccountRequest, callback?: (err: AWSError, data: Inspector2.Types.GetDelegatedAdminAccountResponse) => void): Request<Inspector2.Types.GetDelegatedAdminAccountResponse, AWSError>;
/**
* Retrieves information about the Amazon Inspector delegated administrator for your organization.
*/
getDelegatedAdminAccount(callback?: (err: AWSError, data: Inspector2.Types.GetDelegatedAdminAccountResponse) => void): Request<Inspector2.Types.GetDelegatedAdminAccountResponse, AWSError>;
/**
* Gets the status of a findings report.
*/
getFindingsReportStatus(params: Inspector2.Types.GetFindingsReportStatusRequest, callback?: (err: AWSError, data: Inspector2.Types.GetFindingsReportStatusResponse) => void): Request<Inspector2.Types.GetFindingsReportStatusResponse, AWSError>;
/**
* Gets the status of a findings report.
*/
getFindingsReportStatus(callback?: (err: AWSError, data: Inspector2.Types.GetFindingsReportStatusResponse) => void): Request<Inspector2.Types.GetFindingsReportStatusResponse, AWSError>;
/**
* Gets member information for your organization.
*/
getMember(params: Inspector2.Types.GetMemberRequest, callback?: (err: AWSError, data: Inspector2.Types.GetMemberResponse) => void): Request<Inspector2.Types.GetMemberResponse, AWSError>;
/**
* Gets member information for your organization.
*/
getMember(callback?: (err: AWSError, data: Inspector2.Types.GetMemberResponse) => void): Request<Inspector2.Types.GetMemberResponse, AWSError>;
/**
* Lists the permissions an account has to configure Amazon Inspector.
*/
listAccountPermissions(params: Inspector2.Types.ListAccountPermissionsRequest, callback?: (err: AWSError, data: Inspector2.Types.ListAccountPermissionsResponse) => void): Request<Inspector2.Types.ListAccountPermissionsResponse, AWSError>;
/**
* Lists the permissions an account has to configure Amazon Inspector.
*/
listAccountPermissions(callback?: (err: AWSError, data: Inspector2.Types.ListAccountPermissionsResponse) => void): Request<Inspector2.Types.ListAccountPermissionsResponse, AWSError>;
/**
* Lists coverage details for you environment.
*/
listCoverage(params: Inspector2.Types.ListCoverageRequest, callback?: (err: AWSError, data: Inspector2.Types.ListCoverageResponse) => void): Request<Inspector2.Types.ListCoverageResponse, AWSError>;
/**
* Lists coverage details for you environment.
*/
listCoverage(callback?: (err: AWSError, data: Inspector2.Types.ListCoverageResponse) => void): Request<Inspector2.Types.ListCoverageResponse, AWSError>;
/**
* Lists Amazon Inspector coverage statistics for your environment.
*/
listCoverageStatistics(params: Inspector2.Types.ListCoverageStatisticsRequest, callback?: (err: AWSError, data: Inspector2.Types.ListCoverageStatisticsResponse) => void): Request<Inspector2.Types.ListCoverageStatisticsResponse, AWSError>;
/**
* Lists Amazon Inspector coverage statistics for your environment.
*/
listCoverageStatistics(callback?: (err: AWSError, data: Inspector2.Types.ListCoverageStatisticsResponse) => void): Request<Inspector2.Types.ListCoverageStatisticsResponse, AWSError>;
/**
* Lists information about the Amazon Inspector delegated administrator of your organization.
*/
listDelegatedAdminAccounts(params: Inspector2.Types.ListDelegatedAdminAccountsRequest, callback?: (err: AWSError, data: Inspector2.Types.ListDelegatedAdminAccountsResponse) => void): Request<Inspector2.Types.ListDelegatedAdminAccountsResponse, AWSError>;
/**
* Lists information about the Amazon Inspector delegated administrator of your organization.
*/
listDelegatedAdminAccounts(callback?: (err: AWSError, data: Inspector2.Types.ListDelegatedAdminAccountsResponse) => void): Request<Inspector2.Types.ListDelegatedAdminAccountsResponse, AWSError>;
/**
* Lists the filters associated with your account.
*/
listFilters(params: Inspector2.Types.ListFiltersRequest, callback?: (err: AWSError, data: Inspector2.Types.ListFiltersResponse) => void): Request<Inspector2.Types.ListFiltersResponse, AWSError>;
/**
* Lists the filters associated with your account.
*/
listFilters(callback?: (err: AWSError, data: Inspector2.Types.ListFiltersResponse) => void): Request<Inspector2.Types.ListFiltersResponse, AWSError>;
/**
* Lists aggregated finding data for your environment based on specific criteria.
*/
listFindingAggregations(params: Inspector2.Types.ListFindingAggregationsRequest, callback?: (err: AWSError, data: Inspector2.Types.ListFindingAggregationsResponse) => void): Request<Inspector2.Types.ListFindingAggregationsResponse, AWSError>;
/**
* Lists aggregated finding data for your environment based on specific criteria.
*/
listFindingAggregations(callback?: (err: AWSError, data: Inspector2.Types.ListFindingAggregationsResponse) => void): Request<Inspector2.Types.ListFindingAggregationsResponse, AWSError>;
/**
* Lists findings for your environment.
*/
listFindings(params: Inspector2.Types.ListFindingsRequest, callback?: (err: AWSError, data: Inspector2.Types.ListFindingsResponse) => void): Request<Inspector2.Types.ListFindingsResponse, AWSError>;
/**
* Lists findings for your environment.
*/
listFindings(callback?: (err: AWSError, data: Inspector2.Types.ListFindingsResponse) => void): Request<Inspector2.Types.ListFindingsResponse, AWSError>;
/**
* List members associated with the Amazon Inspector delegated administrator for your organization.
*/
listMembers(params: Inspector2.Types.ListMembersRequest, callback?: (err: AWSError, data: Inspector2.Types.ListMembersResponse) => void): Request<Inspector2.Types.ListMembersResponse, AWSError>;
/**
* List members associated with the Amazon Inspector delegated administrator for your organization.
*/
listMembers(callback?: (err: AWSError, data: Inspector2.Types.ListMembersResponse) => void): Request<Inspector2.Types.ListMembersResponse, AWSError>;
/**
* Lists all tags attached to a given resource.
*/
listTagsForResource(params: Inspector2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Inspector2.Types.ListTagsForResourceResponse) => void): Request<Inspector2.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all tags attached to a given resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Inspector2.Types.ListTagsForResourceResponse) => void): Request<Inspector2.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the Amazon Inspector usage totals over the last 30 days.
*/
listUsageTotals(params: Inspector2.Types.ListUsageTotalsRequest, callback?: (err: AWSError, data: Inspector2.Types.ListUsageTotalsResponse) => void): Request<Inspector2.Types.ListUsageTotalsResponse, AWSError>;
/**
* Lists the Amazon Inspector usage totals over the last 30 days.
*/
listUsageTotals(callback?: (err: AWSError, data: Inspector2.Types.ListUsageTotalsResponse) => void): Request<Inspector2.Types.ListUsageTotalsResponse, AWSError>;
/**
* Adds tags to a resource.
*/
tagResource(params: Inspector2.Types.TagResourceRequest, callback?: (err: AWSError, data: Inspector2.Types.TagResourceResponse) => void): Request<Inspector2.Types.TagResourceResponse, AWSError>;
/**
* Adds tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: Inspector2.Types.TagResourceResponse) => void): Request<Inspector2.Types.TagResourceResponse, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(params: Inspector2.Types.UntagResourceRequest, callback?: (err: AWSError, data: Inspector2.Types.UntagResourceResponse) => void): Request<Inspector2.Types.UntagResourceResponse, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: Inspector2.Types.UntagResourceResponse) => void): Request<Inspector2.Types.UntagResourceResponse, AWSError>;
/**
* Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.
*/
updateConfiguration(params: Inspector2.Types.UpdateConfigurationRequest, callback?: (err: AWSError, data: Inspector2.Types.UpdateConfigurationResponse) => void): Request<Inspector2.Types.UpdateConfigurationResponse, AWSError>;
/**
* Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.
*/
updateConfiguration(callback?: (err: AWSError, data: Inspector2.Types.UpdateConfigurationResponse) => void): Request<Inspector2.Types.UpdateConfigurationResponse, AWSError>;
/**
* Specifies the action that is to be applied to the findings that match the filter.
*/
updateFilter(params: Inspector2.Types.UpdateFilterRequest, callback?: (err: AWSError, data: Inspector2.Types.UpdateFilterResponse) => void): Request<Inspector2.Types.UpdateFilterResponse, AWSError>;
/**
* Specifies the action that is to be applied to the findings that match the filter.
*/
updateFilter(callback?: (err: AWSError, data: Inspector2.Types.UpdateFilterResponse) => void): Request<Inspector2.Types.UpdateFilterResponse, AWSError>;
/**
* Updates the configurations for your Amazon Inspector organization.
*/
updateOrganizationConfiguration(params: Inspector2.Types.UpdateOrganizationConfigurationRequest, callback?: (err: AWSError, data: Inspector2.Types.UpdateOrganizationConfigurationResponse) => void): Request<Inspector2.Types.UpdateOrganizationConfigurationResponse, AWSError>;
/**
* Updates the configurations for your Amazon Inspector organization.
*/
updateOrganizationConfiguration(callback?: (err: AWSError, data: Inspector2.Types.UpdateOrganizationConfigurationResponse) => void): Request<Inspector2.Types.UpdateOrganizationConfigurationResponse, AWSError>;
}
declare namespace Inspector2 {
export interface Account {
/**
* The ID of the Amazon Web Services account.
*/
accountId: AccountId;
/**
* Details of the status of Amazon Inspector scans by resource type.
*/
resourceStatus: ResourceStatus;
/**
* The status of Amazon Inspector for the account.
*/
status: Status;
}
export interface AccountAggregation {
/**
* The type of finding.
*/
findingType?: AggregationFindingType;
/**
* The type of resource.
*/
resourceType?: AggregationResourceType;
/**
* The value to sort by.
*/
sortBy?: AccountSortBy;
/**
* The sort order (ascending or descending).
*/
sortOrder?: SortOrder;
}
export interface AccountAggregationResponse {
/**
* The Amazon Web Services account ID.
*/
accountId?: AccountId;
/**
* The number of findings by severity.
*/
severityCounts?: SeverityCounts;
}
export type AccountId = string;
export type AccountIdSet = AccountId[];
export type AccountList = Account[];
export type AccountSortBy = "CRITICAL"|"HIGH"|"ALL"|string;
export interface AccountState {
/**
* The Amazon Web Services account ID.
*/
accountId: AccountId;
/**
* An object detailing which resources Amazon Inspector is enabled to scan for the account.
*/
resourceState: ResourceState;
/**
* An object detailing the status of Amazon Inspector for the account.
*/
state: State;
}
export type AccountStateList = AccountState[];
export type AggCounts = number;
export type AggregationFindingType = "NETWORK_REACHABILITY"|"PACKAGE_VULNERABILITY"|string;
export interface AggregationRequest {
/**
* An object that contains details about an aggregation request based on Amazon Web Services account IDs.
*/
accountAggregation?: AccountAggregation;
/**
* An object that contains details about an aggregation request based on Amazon Machine Images (AMIs).
*/
amiAggregation?: AmiAggregation;
/**
* An object that contains details about an aggregation request based on Amazon ECR container images.
*/
awsEcrContainerAggregation?: AwsEcrContainerAggregation;
/**
* An object that contains details about an aggregation request based on Amazon EC2 instances.
*/
ec2InstanceAggregation?: Ec2InstanceAggregation;
/**
* An object that contains details about an aggregation request based on finding types.
*/
findingTypeAggregation?: FindingTypeAggregation;
/**
* An object that contains details about an aggregation request based on container image layers.
*/
imageLayerAggregation?: ImageLayerAggregation;
/**
* An object that contains details about an aggregation request based on operating system package type.
*/
packageAggregation?: PackageAggregation;
/**
* An object that contains details about an aggregation request based on Amazon ECR repositories.
*/
repositoryAggregation?: RepositoryAggregation;
/**
* An object that contains details about an aggregation request based on finding title.
*/
titleAggregation?: TitleAggregation;
}
export type AggregationResourceType = "AWS_EC2_INSTANCE"|"AWS_ECR_CONTAINER_IMAGE"|string;
export interface AggregationResponse {
/**
* An object that contains details about an aggregation response based on Amazon Web Services account IDs.
*/
accountAggregation?: AccountAggregationResponse;
/**
* An object that contains details about an aggregation response based on Amazon Machine Images (AMIs).
*/
amiAggregation?: AmiAggregationResponse;
/**
* An object that contains details about an aggregation response based on Amazon ECR container images.
*/
awsEcrContainerAggregation?: AwsEcrContainerAggregationResponse;
/**
* An object that contains details about an aggregation response based on Amazon EC2 instances.
*/
ec2InstanceAggregation?: Ec2InstanceAggregationResponse;
/**
* An object that contains details about an aggregation response based on finding types.
*/
findingTypeAggregation?: FindingTypeAggregationResponse;
/**
* An object that contains details about an aggregation response based on container image layers.
*/
imageLayerAggregation?: ImageLayerAggregationResponse;
/**
* An object that contains details about an aggregation response based on operating system package type.
*/
packageAggregation?: PackageAggregationResponse;
/**
* An object that contains details about an aggregation response based on Amazon ECR repositories.
*/
repositoryAggregation?: RepositoryAggregationResponse;
/**
* An object that contains details about an aggregation response based on finding title.
*/
titleAggregation?: TitleAggregationResponse;
}
export type AggregationResponseList = AggregationResponse[];
export type AggregationType = "FINDING_TYPE"|"PACKAGE"|"TITLE"|"REPOSITORY"|"AMI"|"AWS_EC2_INSTANCE"|"AWS_ECR_CONTAINER"|"IMAGE_LAYER"|"ACCOUNT"|string;
export interface AmiAggregation {
/**
* The IDs of AMIs to aggregate findings for.
*/
amis?: StringFilterList;
/**
* The value to sort results by.
*/
sortBy?: AmiSortBy;
/**
* The order to sort results by.
*/
sortOrder?: SortOrder;
}
export interface AmiAggregationResponse {
/**
* The Amazon Web Services account ID that the AMI belongs.
*/
accountId?: AccountId;
/**
* The IDs of Amazon EC2 instances using this AMI.
*/
affectedInstances?: Long;
/**
* The ID of the AMI that findings were aggregated for.
*/
ami: AmiId;
/**
* An object that contains the count of matched findings per severity.
*/
severityCounts?: SeverityCounts;
}
export type AmiId = string;
export type AmiSortBy = "CRITICAL"|"HIGH"|"ALL"|"AFFECTED_INSTANCES"|string;
export type Arn = string;
export interface AssociateMemberRequest {
/**
* The Amazon Web Services account ID of the member account to be associated.
*/
accountId: AccountId;
}
export interface AssociateMemberResponse {
/**
* The Amazon Web Services account ID of the successfully associated member account.
*/
accountId: AccountId;
}
export interface AutoEnable {
/**
* Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.
*/
ec2: Boolean;
/**
* Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.
*/
ecr: Boolean;
}
export interface AwsEc2InstanceDetails {
/**
* The IAM instance profile ARN of the Amazon EC2 instance.
*/
iamInstanceProfileArn?: NonEmptyString;
/**
* The image ID of the Amazon EC2 instance.
*/
imageId?: NonEmptyString;
/**
* The IPv4 addresses of the Amazon EC2 instance.
*/
ipV4Addresses?: IpV4AddressList;
/**
* The IPv6 addresses of the Amazon EC2 instance.
*/
ipV6Addresses?: IpV6AddressList;
/**
* The name of the key pair used to launch the Amazon EC2 instance.
*/
keyName?: NonEmptyString;
/**
* The date and time the Amazon EC2 instance was launched at.
*/
launchedAt?: DateTimeTimestamp;
/**
* The platform of the Amazon EC2 instance.
*/
platform?: Platform;
/**
* The subnet ID of the Amazon EC2 instance.
*/
subnetId?: NonEmptyString;
/**
* The type of the Amazon EC2 instance.
*/
type?: NonEmptyString;
/**
* The VPC ID of the Amazon EC2 instance.
*/
vpcId?: NonEmptyString;
}
export interface AwsEcrContainerAggregation {
/**
* The architecture of the containers.
*/
architectures?: StringFilterList;
/**
* The image SHA values.
*/
imageShas?: StringFilterList;
/**
* The image tags.
*/
imageTags?: StringFilterList;
/**
* The container repositories.
*/
repositories?: StringFilterList;
/**
* The container resource IDs.
*/
resourceIds?: StringFilterList;
/**
* The value to sort by.
*/
sortBy?: AwsEcrContainerSortBy;
/**
* The sort order (ascending or descending).
*/
sortOrder?: SortOrder;
}
export interface AwsEcrContainerAggregationResponse {
/**
* The Amazon Web Services account ID of the account that owns the container.
*/
accountId?: AccountId;
/**
* The architecture of the container.
*/
architecture?: String;
/**
* The SHA value of the container image.
*/
imageSha?: String;
/**
* The container image stags.
*/
imageTags?: StringList;
/**
* The container repository.
*/
repository?: String;
/**
* The resource ID of the container.
*/
resourceId: NonEmptyString;
/**
* The number of finding by severity.
*/
severityCounts?: SeverityCounts;
}
export interface AwsEcrContainerImageDetails {
/**
* The architecture of the Amazon ECR container image.
*/
architecture?: NonEmptyString;
/**
* The image author of the Amazon ECR container image.
*/
author?: String;
/**
* The image hash of the Amazon ECR container image.
*/
imageHash: ImageHash;
/**
* The image tags attached to the Amazon ECR container image.
*/
imageTags?: ImageTagList;
/**
* The platform of the Amazon ECR container image.
*/
platform?: Platform;
/**
* The date and time the Amazon ECR container image was pushed.
*/
pushedAt?: DateTimeTimestamp;
/**
* The registry the Amazon ECR container image belongs to.
*/
registry: NonEmptyString;
/**
* The name of the repository the Amazon ECR container image resides in.
*/
repositoryName: NonEmptyString;
}
export type AwsEcrContainerSortBy = "CRITICAL"|"HIGH"|"ALL"|string;
export interface BatchGetAccountStatusRequest {
/**
* The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.
*/
accountIds?: AccountIdSet;
}
export interface BatchGetAccountStatusResponse {
/**
* An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.
*/
accounts: AccountStateList;
/**
* An array of objects detailing any accounts that failed to enable Amazon Inspector and why.
*/
failedAccounts?: FailedAccountList;
}
export interface BatchGetFreeTrialInfoRequest {
/**
* The account IDs to get free trial status for.
*/
accountIds: BatchGetFreeTrialInfoRequestAccountIdsList;
}
export type BatchGetFreeTrialInfoRequestAccountIdsList = MeteringAccountId[];
export interface BatchGetFreeTrialInfoResponse {
/**
* An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.
*/
accounts: FreeTrialAccountInfoList;
/**
* An array of objects detailing any accounts that free trial data could not be returned for.
*/
failedAccounts: FreeTrialInfoErrorList;
}
export type Boolean = boolean;
export interface CancelFindingsReportRequest {
/**
* The ID of the report to be canceled.
*/
reportId: ReportId;
}
export interface CancelFindingsReportResponse {
/**
* The ID of the canceled report.
*/
reportId: ReportId;
}
export type ClientToken = string;
export type Component = string;
export type ComponentType = string;
export interface Counts {
/**
* The number of resources.
*/
count?: AggCounts;
/**
* The key associated with this group
*/
groupKey?: GroupKey;
}
export type CountsList = Counts[];
export interface CoverageFilterCriteria {
/**
* An array of Amazon Web Services account IDs to return coverage statistics for.
*/
accountId?: CoverageStringFilterList;
/**
* The Amazon EC2 instance tags to filter on.
*/
ec2InstanceTags?: CoverageMapFilterList;
/**
* The Amazon ECR image tags to filter on.
*/
ecrImageTags?: CoverageStringFilterList;
/**
* The Amazon ECR repository name to filter on.
*/
ecrRepositoryName?: CoverageStringFilterList;
/**
* An array of Amazon Web Services resource IDs to return coverage statistics for.
*/
resourceId?: CoverageStringFilterList;
/**
* An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY.
*/
resourceType?: CoverageStringFilterList;
/**
* The scan status code to filter on.
*/
scanStatusCode?: CoverageStringFilterList;
/**
* The scan status reason to filter on.
*/
scanStatusReason?: CoverageStringFilterList;
/**
* An array of Amazon Inspector scan types to return coverage statistics for.
*/
scanType?: CoverageStringFilterList;
}
export type CoverageMapComparison = "EQUALS"|string;
export interface CoverageMapFilter {
/**
* The operator to compare coverage on.
*/
comparison: CoverageMapComparison;
/**
* The tag key associated with the coverage map filter.
*/
key: NonEmptyString;
/**
* The tag value associated with the coverage map filter.
*/
value?: NonEmptyString;
}
export type CoverageMapFilterList = CoverageMapFilter[];
export type CoverageResourceType = "AWS_EC2_INSTANCE"|"AWS_ECR_CONTAINER_IMAGE"|"AWS_ECR_REPOSITORY"|string;
export type CoverageStringComparison = "EQUALS"|"NOT_EQUALS"|string;
export interface CoverageStringFilter {
/**
* The operator to compare strings on.
*/
comparison: CoverageStringComparison;
/**
* The value to compare strings on.
*/
value: CoverageStringInput;
}
export type CoverageStringFilterList = CoverageStringFilter[];
export type CoverageStringInput = string;
export interface CoveredResource {
/**
* The Amazon Web Services account ID of the covered resource.
*/
accountId: AccountId;
/**
* The ID of the covered resource.
*/
resourceId: ResourceId;
/**
* An object that contains details about the metadata.
*/
resourceMetadata?: ResourceScanMetadata;
/**
* The type of the covered resource.
*/
resourceType: CoverageResourceType;
/**
* The status of the scan covering the resource.
*/
scanStatus?: ScanStatus;
/**
* The Amazon Inspector scan type covering the resource.
*/
scanType: ScanType;
}
export type CoveredResources = CoveredResource[];
export interface CreateFilterRequest {
/**
* Defines the action that is to be applied to the findings that match the filter.
*/
action: FilterAction;
/**
* A description of the filter.
*/
description?: FilterDescription;
/**
* Defines the criteria to be used in the filter for querying findings.
*/
filterCriteria: FilterCriteria;
/**
* The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.
*/
name: FilterName;
/**
* The reason for creating the filter.
*/
reason?: FilterReason;
/**
* A list of tags for the filter.
*/
tags?: TagMap;
}
export interface CreateFilterResponse {
/**
* The Amazon Resource Number (ARN) of the successfully created filter.
*/
arn: FilterArn;
}
export interface CreateFindingsReportRequest {
/**
* The filter criteria to apply to the results of the finding report.
*/
filterCriteria?: FilterCriteria;
/**
* The format to generate the report in.
*/
reportFormat: ReportFormat;
/**
* The Amazon S3 export destination for the report.
*/
s3Destination: Destination;
}
export interface CreateFindingsReportResponse {
/**
* The ID of the report.
*/
reportId?: ReportId;
}
export type Currency = "USD"|string;
export interface CvssScore {
/**
* The base CVSS score used for the finding.
*/
baseScore: Double;
/**
* The vector string of the CVSS score.
*/
scoringVector: NonEmptyString;
/**
* The source of the CVSS score.
*/
source: NonEmptyString;
/**
* The version of CVSS used for the score.
*/
version: NonEmptyString;
}
export interface CvssScoreAdjustment {
/**
* The metric used to adjust the CVSS score.
*/
metric: NonEmptyString;
/**
* The reason the CVSS score has been adjustment.
*/
reason: NonEmptyString;
}
export type CvssScoreAdjustmentList = CvssScoreAdjustment[];
export interface CvssScoreDetails {
/**
* An object that contains details about adjustment Amazon Inspector made to the CVSS score.
*/
adjustments?: CvssScoreAdjustmentList;
/**
* The source of the CVSS data.
*/
cvssSource?: NonEmptyString;
/**
* The CVSS score.
*/
score: Double;
/**
* The source for the CVSS score.
*/
scoreSource: NonEmptyString;
/**
* The vector for the CVSS score.
*/
scoringVector: NonEmptyString;
/**
* The CVSS version used in scoring.
*/
version: NonEmptyString;
}
export type CvssScoreList = CvssScore[];
export interface DateFilter {
/**
* A timestamp representing the end of the time period filtered on.
*/
endInclusive?: Timestamp;
/**
* A timestamp representing the start of the time period filtered on.
*/
startInclusive?: Timestamp;
}
export type DateFilterList = DateFilter[];
export type DateTimeTimestamp = Date;
export interface DelegatedAdmin {
/**
* The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.
*/
accountId?: AccountId;
/**
* The status of the Amazon Inspector delegated administrator.
*/
relationshipStatus?: RelationshipStatus;
}
export interface DelegatedAdminAccount {
/**
* The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.
*/
accountId?: AccountId;
/**
* The status of the Amazon Inspector delegated administrator.
*/
status?: DelegatedAdminStatus;
}
export type DelegatedAdminAccountList = DelegatedAdminAccount[];
export type DelegatedAdminStatus = "ENABLED"|"DISABLE_IN_PROGRESS"|string;
export interface DeleteFilterRequest {
/**
* The Amazon Resource Number (ARN) of the filter to be deleted.
*/
arn: FilterArn;
}
export interface DeleteFilterResponse {
/**
* The Amazon Resource Number (ARN) of the filter that has been deleted.
*/
arn: FilterArn;
}
export interface DescribeOrganizationConfigurationRequest {
}
export interface DescribeOrganizationConfigurationResponse {
/**
* The scan types are automatically enabled for new members of your organization.
*/
autoEnable?: AutoEnable;
/**
* Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.
*/
maxAccountLimitReached?: Boolean;
}
export interface Destination {
/**
* The name of the Amazon S3 bucket to export findings to.
*/
bucketName: String;
/**
* The prefix of the KMS key used to export findings.
*/
keyPrefix?: String;
/**
* The ARN of the KMS key used to encrypt data when exporting findings.
*/
kmsKeyArn: String;
}
export interface DisableDelegatedAdminAccountRequest {
/**
* The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.
*/
delegatedAdminAccountId: AccountId;
}
export interface DisableDelegatedAdminAccountResponse {
/**
* The Amazon Web Services account ID of the successfully disabled delegated administrator.
*/
delegatedAdminAccountId: AccountId;
}
export interface DisableRequest {
/**
* An array of account IDs you want to disable Amazon Inspector scans for.
*/
accountIds?: AccountIdSet;
/**
* The resource scan types you want to disable.
*/
resourceTypes?: DisableResourceTypeList;
}
export type DisableResourceTypeList = ResourceScanType[];
export interface DisableResponse {
/**
* Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are provided for each account.
*/
accounts: AccountList;
/**
* Information on any accounts for which Amazon Inspector scans could not be disabled. Details are provided for each account.
*/
failedAccounts?: FailedAccountList;
}
export interface DisassociateMemberRequest {
/**
* The Amazon Web Services account ID of the member account to disassociate.
*/
accountId: AccountId;
}
export interface DisassociateMemberResponse {
/**
* The Amazon Web Services account ID of the successfully disassociated member.
*/
accountId: AccountId;
}
export type Double = number;
export interface Ec2InstanceAggregation {
/**
* The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.
*/
amis?: StringFilterList;
/**
* The Amazon EC2 instance IDs to aggregate findings for.
*/
instanceIds?: StringFilterList;
/**
* The Amazon EC2 instance tags to aggregate findings for.
*/
instanceTags?: MapFilterList;
/**
* The operating system types to aggregate findings for. Valid values must be uppercase and underscore separated, examples are ORACLE_LINUX_7 and ALPINE_LINUX_3_8.
*/
operatingSystems?: StringFilterList;
/**
* The value to sort results by.
*/
sortBy?: Ec2InstanceSortBy;
/**
* The order to sort results by.
*/
sortOrder?: SortOrder;
}
export interface Ec2InstanceAggregationResponse {
/**
* The Amazon Web Services account the Amazon EC2 instance belongs to.
*/
accountId?: String;
/**
* The Amazon Machine Image (AMI) of the Amazon EC2 instance.
*/
ami?: AmiId;
/**
* The Amazon EC2 instance ID.
*/
instanceId: NonEmptyString;
/**
* The tags attached to the instance.
*/
instanceTags?: TagMap;
/**
* The number of network findings for the Amazon EC2 instance.
*/
networkFindings?: Long;
/**
* The operating system of the Amazon EC2 instance.
*/
operatingSystem?: String;
/**
* An object that contains the count of matched findings per severity.
*/
severityCounts?: SeverityCounts;
}
export type Ec2InstanceSortBy = "NETWORK_FINDINGS"|"CRITICAL"|"HIGH"|"ALL"|string;
export interface Ec2Metadata {
/**
* The ID of the Amazon Machine Image (AMI) used to launch the instance.
*/
amiId?: AmiId;
/**
* The platform of the instance.
*/
platform?: Ec2Platform;
/**
* The tags attached to the instance.
*/
tags?: TagMap;
}
export type Ec2Platform = "WINDOWS"|"LINUX"|"UNKNOWN"|string;
export interface EcrConfiguration {
/**
* The ECR automated re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the automated re-scan duration the monitoring state of that image becomes inactive and all associated findings are scheduled for closure.
*/
rescanDuration: EcrRescanDuration;
}
export interface EcrConfigurationState {
/**
* An object that contains details about the state of the ECR automated re-scan setting.
*/
rescanDurationState?: EcrRescanDurationState;
}
export interface EcrContainerImageMetadata {
/**
* Tags associated with the Amazon ECR image metadata.
*/
tags?: TagList;
}
export interface EcrRepositoryMetadata {
/**
* The name of the Amazon ECR repository.
*/
name?: String;
/**
* The frequency of scans.
*/
scanFrequency?: EcrScanFrequency;
}
export type EcrRescanDuration = "LIFETIME"|"DAYS_30"|"DAYS_180"|string;
export interface EcrRescanDurationState {
/**
* The ECR automated re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the automated re-scan duration the monitoring state of that image becomes inactive and all associated findings are scheduled for closure.
*/
rescanDuration?: EcrRescanDuration;
/**
* The status of changes to the ECR automated re-scan duration.
*/
status?: EcrRescanDurationStatus;
/**
* A timestamp representing when the last time the ECR scan duration setting was changed.
*/
updatedAt?: DateTimeTimestamp;
}
export type EcrRescanDurationStatus = "SUCCESS"|"PENDING"|"FAILED"|string;
export type EcrScanFrequency = "MANUAL"|"SCAN_ON_PUSH"|"CONTINUOUS_SCAN"|string;
export interface EnableDelegatedAdminAccountRequest {
/**
* The idempotency token for the request.
*/
clientToken?: ClientToken;
/**
* The Amazon Web Services account ID of the Amazon Inspector delegated administrator.
*/
delegatedAdminAccountId: AccountId;
}
export interface EnableDelegatedAdminAccountResponse {
/**
* The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.
*/
delegatedAdminAccountId: AccountId;
}
export interface EnableRequest {
/**
* A list of account IDs you want to enable Amazon Inspector scans for.
*/
accountIds?: AccountIdSet;
/**
* The idempotency token for the request.
*/
clientToken?: ClientToken;
/**
* The resource scan types you want to enable.
*/
resourceTypes: EnableResourceTypeList;
}
export type EnableResourceTypeList = ResourceScanType[];
export interface EnableResponse {
/**
* Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are provided for each account.
*/
accounts: AccountList;
/**
* Information on any accounts for which Amazon Inspector scans could not be enabled. Details are provided for each account.
*/
failedAccounts?: FailedAccountList;
}
export type ErrorCode = "ALREADY_ENABLED"|"ENABLE_IN_PROGRESS"|"DISABLE_IN_PROGRESS"|"SUSPEND_IN_PROGRESS"|"RESOURCE_NOT_FOUND"|"ACCESS_DENIED"|"INTERNAL_ERROR"|"SSM_UNAVAILABLE"|"SSM_THROTTLED"|"EVENTBRIDGE_UNAVAILABLE"|"EVENTBRIDGE_THROTTLED"|"RESOURCE_SCAN_NOT_DISABLED"|"DISASSOCIATE_ALL_MEMBERS"|"ACCOUNT_IS_ISOLATED"|string;
export type ErrorMessage = string;
export type ExternalReportStatus = "SUCCEEDED"|"IN_PROGRESS"|"CANCELLED"|"FAILED"|string;
export interface FailedAccount {
/**
* The Amazon Web Services account ID.
*/
accountId: AccountId;
/**
* The error code explaining why the account failed to enable Amazon Inspector.
*/
errorCode: ErrorCode;
/**
* The error message received when the account failed to enable Amazon Inspector.
*/
errorMessage: NonEmptyString;
/**
* An object detailing which resources Amazon Inspector is enabled to scan for the account.
*/
resourceStatus?: ResourceStatus;
/**
* The status of Amazon Inspector for the account.
*/
status?: Status;
}
export type FailedAccountList = FailedAccount[];
export type FilePath = string;
export interface Filter {
/**
* The action that is to be applied to the findings that match the filter.
*/
action: FilterAction;
/**
* The Amazon Resource Number (ARN) associated with this filter.
*/
arn: FilterArn;
/**
* The date and time this filter was created at.
*/
createdAt: DateTimeTimestamp;
/**
* Details on the filter criteria associated with this filter.
*/
criteria: FilterCriteria;
/**
* A description of the filter.
*/
description?: FilterDescription;
/**
* The name of the filter.
*/
name: FilterName;
/**
* The Amazon Web Services account ID of the account that created the filter.
*/
ownerId: OwnerId;
/**
* The reason for the filter.
*/
reason?: FilterReason;
/**
* The tags attached to the filter.
*/
tags?: TagMap;
/**
* The date and time the filter was last updated at.
*/
updatedAt: DateTimeTimestamp;
}
export type FilterAction = "NONE"|"SUPPRESS"|string;
export type FilterArn = string;
export type FilterArnList = FilterArn[];
export interface FilterCriteria {
/**
* Details of the Amazon Web Services account IDs used to filter findings.
*/
awsAccountId?: StringFilterList;
/**
* Details of the component IDs used to filter findings.
*/
componentId?: StringFilterList;
/**
* Details of the component types used to filter findings.
*/
componentType?: StringFilterList;
/**
* Details of the Amazon EC2 instance image IDs used to filter findings.
*/
ec2InstanceImageId?: StringFilterList;
/**
* Details of the Amazon EC2 instance subnet IDs used to filter findings.
*/
ec2InstanceSubnetId?: StringFilterList;
/**
* Details of the Amazon EC2 instance VPC IDs used to filter findings.
*/
ec2InstanceVpcId?: StringFilterList;
/**
* Details of the Amazon ECR image architecture types used to filter findings.
*/
ecrImageArchitecture?: StringFilterList;
/**
* Details of the Amazon ECR image hashes used to filter findings.
*/
ecrImageHash?: StringFilterList;
/**
* Details on the Amazon ECR image push date and time used to filter findings.
*/
ecrImagePushedAt?: DateFilterList;
/**
* Details on the Amazon ECR registry used to filter findings.
*/
ecrImageRegistry?: StringFilterList;
/**
* Details on the name of the Amazon ECR repository used to filter findings.
*/
ecrImageRepositoryName?: StringFilterList;
/**
* The tags attached to the Amazon ECR container image.
*/
ecrImageTags?: StringFilterList;
/**
* Details on the finding ARNs used to filter findings.
*/
findingArn?: StringFilterList;
/**
* Details on the finding status types used to filter findings.
*/
findingStatus?: StringFilte