{ "version":"2.0", "metadata":{ "apiVersion":"2020-06-08", "endpointPrefix":"inspector2", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"Inspector2", "serviceFullName":"Inspector2", "serviceId":"Inspector2", "signatureVersion":"v4", "signingName":"inspector2", "uid":"inspector2-2020-06-08" }, "operations":{ "AssociateMember":{ "name":"AssociateMember", "http":{ "method":"POST", "requestUri":"/members/associate", "responseCode":200 }, "input":{"shape":"AssociateMemberRequest"}, "output":{"shape":"AssociateMemberResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.

" }, "BatchGetAccountStatus":{ "name":"BatchGetAccountStatus", "http":{ "method":"POST", "requestUri":"/status/batch/get", "responseCode":200 }, "input":{"shape":"BatchGetAccountStatusRequest"}, "output":{"shape":"BatchGetAccountStatusResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

" }, "BatchGetFreeTrialInfo":{ "name":"BatchGetFreeTrialInfo", "http":{ "method":"POST", "requestUri":"/freetrialinfo/batchget", "responseCode":200 }, "input":{"shape":"BatchGetFreeTrialInfoRequest"}, "output":{"shape":"BatchGetFreeTrialInfoResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets free trial status for multiple Amazon Web Services accounts.

" }, "CancelFindingsReport":{ "name":"CancelFindingsReport", "http":{ "method":"POST", "requestUri":"/reporting/cancel", "responseCode":200 }, "input":{"shape":"CancelFindingsReportRequest"}, "output":{"shape":"CancelFindingsReportResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Cancels the given findings report.

" }, "CreateFilter":{ "name":"CreateFilter", "http":{ "method":"POST", "requestUri":"/filters/create", "responseCode":200 }, "input":{"shape":"CreateFilterRequest"}, "output":{"shape":"CreateFilterResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"BadRequestException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Creates a filter resource using specified filter criteria.

" }, "CreateFindingsReport":{ "name":"CreateFindingsReport", "http":{ "method":"POST", "requestUri":"/reporting/create", "responseCode":200 }, "input":{"shape":"CreateFindingsReportRequest"}, "output":{"shape":"CreateFindingsReportResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Creates a finding report.

" }, "DeleteFilter":{ "name":"DeleteFilter", "http":{ "method":"POST", "requestUri":"/filters/delete", "responseCode":200 }, "input":{"shape":"DeleteFilterRequest"}, "output":{"shape":"DeleteFilterResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Deletes a filter resource.

" }, "DescribeOrganizationConfiguration":{ "name":"DescribeOrganizationConfiguration", "http":{ "method":"POST", "requestUri":"/organizationconfiguration/describe", "responseCode":200 }, "input":{"shape":"DescribeOrganizationConfigurationRequest"}, "output":{"shape":"DescribeOrganizationConfigurationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Describe Amazon Inspector configuration settings for an Amazon Web Services organization

" }, "Disable":{ "name":"Disable", "http":{ "method":"POST", "requestUri":"/disable", "responseCode":200 }, "input":{"shape":"DisableRequest"}, "output":{"shape":"DisableResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.

" }, "DisableDelegatedAdminAccount":{ "name":"DisableDelegatedAdminAccount", "http":{ "method":"POST", "requestUri":"/delegatedadminaccounts/disable", "responseCode":200 }, "input":{"shape":"DisableDelegatedAdminAccountRequest"}, "output":{"shape":"DisableDelegatedAdminAccountResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Disables the Amazon Inspector delegated administrator for your organization.

" }, "DisassociateMember":{ "name":"DisassociateMember", "http":{ "method":"POST", "requestUri":"/members/disassociate", "responseCode":200 }, "input":{"shape":"DisassociateMemberRequest"}, "output":{"shape":"DisassociateMemberResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Disassociates a member account from an Amazon Inspector delegated administrator.

" }, "Enable":{ "name":"Enable", "http":{ "method":"POST", "requestUri":"/enable", "responseCode":200 }, "input":{"shape":"EnableRequest"}, "output":{"shape":"EnableResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

" }, "EnableDelegatedAdminAccount":{ "name":"EnableDelegatedAdminAccount", "http":{ "method":"POST", "requestUri":"/delegatedadminaccounts/enable", "responseCode":200 }, "input":{"shape":"EnableDelegatedAdminAccountRequest"}, "output":{"shape":"EnableDelegatedAdminAccountResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Enables the Amazon Inspector delegated administrator for your Organizations organization.

" }, "GetDelegatedAdminAccount":{ "name":"GetDelegatedAdminAccount", "http":{ "method":"POST", "requestUri":"/delegatedadminaccounts/get", "responseCode":200 }, "input":{"shape":"GetDelegatedAdminAccountRequest"}, "output":{"shape":"GetDelegatedAdminAccountResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves information about the Amazon Inspector delegated administrator for your organization.

" }, "GetFindingsReportStatus":{ "name":"GetFindingsReportStatus", "http":{ "method":"POST", "requestUri":"/reporting/status/get", "responseCode":200 }, "input":{"shape":"GetFindingsReportStatusRequest"}, "output":{"shape":"GetFindingsReportStatusResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the status of a findings report.

" }, "GetMember":{ "name":"GetMember", "http":{ "method":"POST", "requestUri":"/members/get", "responseCode":200 }, "input":{"shape":"GetMemberRequest"}, "output":{"shape":"GetMemberResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets member information for your organization.

" }, "ListAccountPermissions":{ "name":"ListAccountPermissions", "http":{ "method":"POST", "requestUri":"/accountpermissions/list", "responseCode":200 }, "input":{"shape":"ListAccountPermissionsRequest"}, "output":{"shape":"ListAccountPermissionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the permissions an account has to configure Amazon Inspector.

" }, "ListCoverage":{ "name":"ListCoverage", "http":{ "method":"POST", "requestUri":"/coverage/list", "responseCode":200 }, "input":{"shape":"ListCoverageRequest"}, "output":{"shape":"ListCoverageResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists coverage details for you environment.

" }, "ListCoverageStatistics":{ "name":"ListCoverageStatistics", "http":{ "method":"POST", "requestUri":"/coverage/statistics/list", "responseCode":200 }, "input":{"shape":"ListCoverageStatisticsRequest"}, "output":{"shape":"ListCoverageStatisticsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists Amazon Inspector coverage statistics for your environment.

" }, "ListDelegatedAdminAccounts":{ "name":"ListDelegatedAdminAccounts", "http":{ "method":"POST", "requestUri":"/delegatedadminaccounts/list", "responseCode":200 }, "input":{"shape":"ListDelegatedAdminAccountsRequest"}, "output":{"shape":"ListDelegatedAdminAccountsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists information about the Amazon Inspector delegated administrator of your organization.

" }, "ListFilters":{ "name":"ListFilters", "http":{ "method":"POST", "requestUri":"/filters/list", "responseCode":200 }, "input":{"shape":"ListFiltersRequest"}, "output":{"shape":"ListFiltersResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the filters associated with your account.

" }, "ListFindingAggregations":{ "name":"ListFindingAggregations", "http":{ "method":"POST", "requestUri":"/findings/aggregation/list", "responseCode":200 }, "input":{"shape":"ListFindingAggregationsRequest"}, "output":{"shape":"ListFindingAggregationsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists aggregated finding data for your environment based on specific criteria.

" }, "ListFindings":{ "name":"ListFindings", "http":{ "method":"POST", "requestUri":"/findings/list", "responseCode":200 }, "input":{"shape":"ListFindingsRequest"}, "output":{"shape":"ListFindingsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists findings for your environment.

" }, "ListMembers":{ "name":"ListMembers", "http":{ "method":"POST", "requestUri":"/members/list", "responseCode":200 }, "input":{"shape":"ListMembersRequest"}, "output":{"shape":"ListMembersResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

List members associated with the Amazon Inspector delegated administrator for your organization.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists all tags attached to a given resource.

" }, "ListUsageTotals":{ "name":"ListUsageTotals", "http":{ "method":"POST", "requestUri":"/usage/list", "responseCode":200 }, "input":{"shape":"ListUsageTotalsRequest"}, "output":{"shape":"ListUsageTotalsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the Amazon Inspector usage totals over the last 30 days.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Adds tags to a resource.

", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Removes tags from a resource.

" }, "UpdateFilter":{ "name":"UpdateFilter", "http":{ "method":"POST", "requestUri":"/filters/update", "responseCode":200 }, "input":{"shape":"UpdateFilterRequest"}, "output":{"shape":"UpdateFilterResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Specifies the action that is to be applied to the findings that match the filter.

" }, "UpdateOrganizationConfiguration":{ "name":"UpdateOrganizationConfiguration", "http":{ "method":"POST", "requestUri":"/organizationconfiguration/update", "responseCode":200 }, "input":{"shape":"UpdateOrganizationConfigurationRequest"}, "output":{"shape":"UpdateOrganizationConfigurationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Updates the configurations for your Amazon Inspector organization.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

You do not have sufficient access to perform this action.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "Account":{ "type":"structure", "required":[ "accountId", "resourceStatus", "status" ], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The ID of the Amazon Web Services account.

" }, "resourceStatus":{ "shape":"ResourceStatus", "documentation":"

Details of the status of Amazon Inspector scans by resource type.

" }, "status":{ "shape":"Status", "documentation":"

The status of Amazon Inspector for the account.

" } }, "documentation":"

An Amazon Web Services account within your environment that Amazon Inspector has been enabled for.

" }, "AccountAggregation":{ "type":"structure", "members":{ "findingType":{ "shape":"AggregationFindingType", "documentation":"

The type of finding.

" }, "resourceType":{ "shape":"AggregationResourceType", "documentation":"

The type of resource.

" }, "sortBy":{ "shape":"AccountSortBy", "documentation":"

The value to sort by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The sort order (ascending or descending).

" } }, "documentation":"

An object that contains details about an aggregation response based on Amazon Web Services accounts.

" }, "AccountAggregationResponse":{ "type":"structure", "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

The number of findings by severity.

" } }, "documentation":"

An aggregation of findings by Amazon Web Services account ID.

" }, "AccountId":{ "type":"string", "max":12, "min":12, "pattern":"^\\d{12}$" }, "AccountIdSet":{ "type":"list", "member":{"shape":"AccountId"}, "max":100, "min":0 }, "AccountList":{ "type":"list", "member":{"shape":"Account"} }, "AccountSortBy":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "ALL" ] }, "AccountState":{ "type":"structure", "required":[ "accountId", "resourceState", "state" ], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID.

" }, "resourceState":{ "shape":"ResourceState", "documentation":"

An object detailing which resources Amazon Inspector is enabled to scan for the account.

" }, "state":{ "shape":"State", "documentation":"

An object detailing the status of Amazon Inspector for the account.

" } }, "documentation":"

An object with details the status of an Amazon Web Services account within your Amazon Inspector environment

" }, "AccountStateList":{ "type":"list", "member":{"shape":"AccountState"}, "max":100, "min":0 }, "AggCounts":{"type":"long"}, "AggregationFindingType":{ "type":"string", "enum":[ "NETWORK_REACHABILITY", "PACKAGE_VULNERABILITY" ] }, "AggregationRequest":{ "type":"structure", "members":{ "accountAggregation":{ "shape":"AccountAggregation", "documentation":"

An object that contains details about an aggregation request based on Amazon Web Services account IDs.

" }, "amiAggregation":{ "shape":"AmiAggregation", "documentation":"

An object that contains details about an aggregation request based on Amazon Machine Images (AMIs).

" }, "awsEcrContainerAggregation":{ "shape":"AwsEcrContainerAggregation", "documentation":"

An object that contains details about an aggregation request based on Amazon ECR container images.

" }, "ec2InstanceAggregation":{ "shape":"Ec2InstanceAggregation", "documentation":"

An object that contains details about an aggregation request based on Amazon EC2 instances.

" }, "findingTypeAggregation":{ "shape":"FindingTypeAggregation", "documentation":"

An object that contains details about an aggregation request based on finding types.

" }, "imageLayerAggregation":{ "shape":"ImageLayerAggregation", "documentation":"

An object that contains details about an aggregation request based on container image layers.

" }, "packageAggregation":{ "shape":"PackageAggregation", "documentation":"

An object that contains details about an aggregation request based on operating system package type.

" }, "repositoryAggregation":{ "shape":"RepositoryAggregation", "documentation":"

An object that contains details about an aggregation request based on Amazon ECR repositories.

" }, "titleAggregation":{ "shape":"TitleAggregation", "documentation":"

An object that contains details about an aggregation request based on finding title.

" } }, "documentation":"

Contains details about an aggregation request.

", "union":true }, "AggregationResourceType":{ "type":"string", "enum":[ "AWS_EC2_INSTANCE", "AWS_ECR_CONTAINER_IMAGE" ] }, "AggregationResponse":{ "type":"structure", "members":{ "accountAggregation":{ "shape":"AccountAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on Amazon Web Services account IDs.

" }, "amiAggregation":{ "shape":"AmiAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on Amazon Machine Images (AMIs).

" }, "awsEcrContainerAggregation":{ "shape":"AwsEcrContainerAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on Amazon ECR container images.

" }, "ec2InstanceAggregation":{ "shape":"Ec2InstanceAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on Amazon EC2 instances.

" }, "findingTypeAggregation":{ "shape":"FindingTypeAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on finding types.

" }, "imageLayerAggregation":{ "shape":"ImageLayerAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on container image layers.

" }, "packageAggregation":{ "shape":"PackageAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on operating system package type.

" }, "repositoryAggregation":{ "shape":"RepositoryAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on Amazon ECR repositories.

" }, "titleAggregation":{ "shape":"TitleAggregationResponse", "documentation":"

An object that contains details about an aggregation response based on finding title.

" } }, "documentation":"

A structure that contains details about the results of an aggregation type.

", "union":true }, "AggregationResponseList":{ "type":"list", "member":{"shape":"AggregationResponse"} }, "AggregationType":{ "type":"string", "enum":[ "FINDING_TYPE", "PACKAGE", "TITLE", "REPOSITORY", "AMI", "AWS_EC2_INSTANCE", "AWS_ECR_CONTAINER", "IMAGE_LAYER", "ACCOUNT" ] }, "AmiAggregation":{ "type":"structure", "members":{ "amis":{ "shape":"StringFilterList", "documentation":"

The IDs of AMIs to aggregate findings for.

" }, "sortBy":{ "shape":"AmiSortBy", "documentation":"

The value to sort results by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order to sort results by.

" } }, "documentation":"

The details that define an aggregation based on Amazon machine images (AMIs).

" }, "AmiAggregationResponse":{ "type":"structure", "required":["ami"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID that the AMI belongs.

" }, "affectedInstances":{ "shape":"Long", "documentation":"

The IDs of Amazon EC2 instances using this AMI.

" }, "ami":{ "shape":"AmiId", "documentation":"

The ID of the AMI that findings were aggregated for.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

An object that contains the count of matched findings per severity.

" } }, "documentation":"

A response that contains the results of a finding aggregation by AMI.

" }, "AmiId":{ "type":"string", "pattern":"^ami-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" }, "AmiSortBy":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "ALL", "AFFECTED_INSTANCES" ] }, "Arn":{ "type":"string", "max":1011, "min":1 }, "AssociateMemberRequest":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the member account to be associated.

" } } }, "AssociateMemberResponse":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the successfully associated member account.

" } } }, "AutoEnable":{ "type":"structure", "required":[ "ec2", "ecr" ], "members":{ "ec2":{ "shape":"Boolean", "documentation":"

Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.

" }, "ecr":{ "shape":"Boolean", "documentation":"

Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.

" } }, "documentation":"

Represents which scan types are automatically enabled for new members of your Amazon Inspector organization.

" }, "AwsEc2InstanceDetails":{ "type":"structure", "members":{ "iamInstanceProfileArn":{ "shape":"NonEmptyString", "documentation":"

The IAM instance profile ARN of the Amazon EC2 instance.

" }, "imageId":{ "shape":"NonEmptyString", "documentation":"

The image ID of the Amazon EC2 instance.

" }, "ipV4Addresses":{ "shape":"IpV4AddressList", "documentation":"

The IPv4 addresses of the Amazon EC2 instance.

" }, "ipV6Addresses":{ "shape":"IpV6AddressList", "documentation":"

The IPv6 addresses of the Amazon EC2 instance.

" }, "keyName":{ "shape":"NonEmptyString", "documentation":"

The name of the key pair used to launch the Amazon EC2 instance.

" }, "launchedAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time the Amazon EC2 instance was launched at.

" }, "platform":{ "shape":"Platform", "documentation":"

The platform of the Amazon EC2 instance.

" }, "subnetId":{ "shape":"NonEmptyString", "documentation":"

The subnet ID of the Amazon EC2 instance.

" }, "type":{ "shape":"NonEmptyString", "documentation":"

The type of the Amazon EC2 instance.

" }, "vpcId":{ "shape":"NonEmptyString", "documentation":"

The VPC ID of the Amazon EC2 instance.

" } }, "documentation":"

Details of the Amazon EC2 instance involved in a finding.

" }, "AwsEcrContainerAggregation":{ "type":"structure", "members":{ "architectures":{ "shape":"StringFilterList", "documentation":"

The architecture of the containers.

" }, "imageShas":{ "shape":"StringFilterList", "documentation":"

The image SHA values.

" }, "imageTags":{ "shape":"StringFilterList", "documentation":"

The image tags.

" }, "repositories":{ "shape":"StringFilterList", "documentation":"

The container repositories.

" }, "resourceIds":{ "shape":"StringFilterList", "documentation":"

The container resource IDs.

" }, "sortBy":{ "shape":"AwsEcrContainerSortBy", "documentation":"

The value to sort by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The sort order (ascending or descending).

" } }, "documentation":"

An aggregation of information about Amazon ECR containers.

" }, "AwsEcrContainerAggregationResponse":{ "type":"structure", "required":["resourceId"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the account that owns the container.

" }, "architecture":{ "shape":"String", "documentation":"

The architecture of the container.

" }, "imageSha":{ "shape":"String", "documentation":"

The SHA value of the container image.

" }, "imageTags":{ "shape":"StringList", "documentation":"

The container image stags.

" }, "repository":{ "shape":"String", "documentation":"

The container repository.

" }, "resourceId":{ "shape":"NonEmptyString", "documentation":"

The resource ID of the container.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

The number of finding by severity.

" } }, "documentation":"

An aggregation of information about Amazon ECR containers.

" }, "AwsEcrContainerImageDetails":{ "type":"structure", "required":[ "imageHash", "registry", "repositoryName" ], "members":{ "architecture":{ "shape":"NonEmptyString", "documentation":"

The architecture of the Amazon ECR container image.

" }, "author":{ "shape":"String", "documentation":"

The image author of the Amazon ECR container image.

" }, "imageHash":{ "shape":"ImageHash", "documentation":"

The image hash of the Amazon ECR container image.

" }, "imageTags":{ "shape":"ImageTagList", "documentation":"

The image tags attached to the Amazon ECR container image.

" }, "platform":{ "shape":"Platform", "documentation":"

The platform of the Amazon ECR container image.

" }, "pushedAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time the Amazon ECR container image was pushed.

" }, "registry":{ "shape":"NonEmptyString", "documentation":"

The registry the Amazon ECR container image belongs to.

" }, "repositoryName":{ "shape":"NonEmptyString", "documentation":"

The name of the repository the Amazon ECR container image resides in.

" } }, "documentation":"

The image details of the Amazon ECR container image.

" }, "AwsEcrContainerSortBy":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "ALL" ] }, "BadRequestException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

One or more tags submitted as part of the request is not valid.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "BatchGetAccountStatusRequest":{ "type":"structure", "members":{ "accountIds":{ "shape":"AccountIdSet", "documentation":"

The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.

" } } }, "BatchGetAccountStatusResponse":{ "type":"structure", "required":["accounts"], "members":{ "accounts":{ "shape":"AccountStateList", "documentation":"

An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.

" }, "failedAccounts":{ "shape":"FailedAccountList", "documentation":"

An array of objects detailing any accounts that failed to enable Amazon Inspector and why.

" } } }, "BatchGetFreeTrialInfoRequest":{ "type":"structure", "required":["accountIds"], "members":{ "accountIds":{ "shape":"BatchGetFreeTrialInfoRequestAccountIdsList", "documentation":"

The account IDs to get free trial status for.

" } } }, "BatchGetFreeTrialInfoRequestAccountIdsList":{ "type":"list", "member":{"shape":"MeteringAccountId"}, "max":100, "min":1 }, "BatchGetFreeTrialInfoResponse":{ "type":"structure", "required":[ "accounts", "failedAccounts" ], "members":{ "accounts":{ "shape":"FreeTrialAccountInfoList", "documentation":"

An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.

" }, "failedAccounts":{ "shape":"FreeTrialInfoErrorList", "documentation":"

An array of objects detailing any accounts that free trial data could not be returned for.

" } } }, "Boolean":{ "type":"boolean", "box":true }, "CancelFindingsReportRequest":{ "type":"structure", "required":["reportId"], "members":{ "reportId":{ "shape":"ReportId", "documentation":"

The ID of the report to be canceled.

" } } }, "CancelFindingsReportResponse":{ "type":"structure", "required":["reportId"], "members":{ "reportId":{ "shape":"ReportId", "documentation":"

The ID of the canceled report.

" } } }, "ClientToken":{ "type":"string", "max":64, "min":1 }, "Component":{"type":"string"}, "ComponentType":{"type":"string"}, "ConflictException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"

The ID of the conflicting resource.

" }, "resourceType":{ "shape":"String", "documentation":"

The type of the conflicting resource.

" } }, "documentation":"

A conflict occurred.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "Counts":{ "type":"structure", "members":{ "count":{ "shape":"AggCounts", "documentation":"

The number of resources.

" }, "groupKey":{ "shape":"GroupKey", "documentation":"

The key associated with this group

" } }, "documentation":"

a structure that contains information on the count of resources within a group.

" }, "CountsList":{ "type":"list", "member":{"shape":"Counts"}, "max":5, "min":1 }, "CoverageFilterCriteria":{ "type":"structure", "members":{ "accountId":{ "shape":"CoverageStringFilterList", "documentation":"

An array of Amazon Web Services account IDs to return coverage statistics for.

" }, "ec2InstanceTags":{ "shape":"CoverageMapFilterList", "documentation":"

The Amazon EC2 instance tags to filter on.

" }, "ecrImageTags":{ "shape":"CoverageStringFilterList", "documentation":"

The Amazon ECR image tags to filter on.

" }, "ecrRepositoryName":{ "shape":"CoverageStringFilterList", "documentation":"

The Amazon ECR repository name to filter on.

" }, "resourceId":{ "shape":"CoverageStringFilterList", "documentation":"

An array of Amazon Web Services resource IDs to return coverage statistics for.

" }, "resourceType":{ "shape":"CoverageStringFilterList", "documentation":"

An array of Amazon Web Services resource types to return coverage statistics for.

" }, "scanStatusCode":{ "shape":"CoverageStringFilterList", "documentation":"

The scan status code to filter on.

" }, "scanStatusReason":{ "shape":"CoverageStringFilterList", "documentation":"

The scan status reason to filter on.

" }, "scanType":{ "shape":"CoverageStringFilterList", "documentation":"

An array of Amazon Inspector scan types to return coverage statistics for.

" } }, "documentation":"

A structure that identifies filter criteria for GetCoverageStatistics.

" }, "CoverageMapComparison":{ "type":"string", "enum":["EQUALS"] }, "CoverageMapFilter":{ "type":"structure", "required":[ "comparison", "key" ], "members":{ "comparison":{ "shape":"CoverageMapComparison", "documentation":"

The operator to compare coverage on.

" }, "key":{ "shape":"NonEmptyString", "documentation":"

The tag key associated with the coverage map filter.

" }, "value":{ "shape":"NonEmptyString", "documentation":"

The tag value associated with the coverage map filter.

" } }, "documentation":"

Contains details of a coverage map filter.

" }, "CoverageMapFilterList":{ "type":"list", "member":{"shape":"CoverageMapFilter"}, "max":10, "min":1 }, "CoverageResourceType":{ "type":"string", "enum":[ "AWS_EC2_INSTANCE", "AWS_ECR_CONTAINER_IMAGE", "AWS_ECR_REPOSITORY" ] }, "CoverageStringComparison":{ "type":"string", "enum":[ "EQUALS", "NOT_EQUALS" ] }, "CoverageStringFilter":{ "type":"structure", "required":[ "comparison", "value" ], "members":{ "comparison":{ "shape":"CoverageStringComparison", "documentation":"

The operator to compare strings on.

" }, "value":{ "shape":"CoverageStringInput", "documentation":"

The value to compare strings on.

" } }, "documentation":"

Contains details of a coverage string filter.

" }, "CoverageStringFilterList":{ "type":"list", "member":{"shape":"CoverageStringFilter"}, "max":10, "min":1 }, "CoverageStringInput":{ "type":"string", "max":1024, "min":1 }, "CoveredResource":{ "type":"structure", "required":[ "accountId", "resourceId", "resourceType", "scanType" ], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the covered resource.

" }, "resourceId":{ "shape":"ResourceId", "documentation":"

The ID of the covered resource.

" }, "resourceMetadata":{ "shape":"ResourceScanMetadata", "documentation":"

An object that contains details about the metadata.

" }, "resourceType":{ "shape":"CoverageResourceType", "documentation":"

The type of the covered resource.

" }, "scanStatus":{ "shape":"ScanStatus", "documentation":"

The status of the scan covering the resource.

" }, "scanType":{ "shape":"ScanType", "documentation":"

The Amazon Inspector scan type covering the resource.

" } }, "documentation":"

An object that contains details about a resource covered by Amazon Inspector.

" }, "CoveredResources":{ "type":"list", "member":{"shape":"CoveredResource"} }, "CreateFilterRequest":{ "type":"structure", "required":[ "action", "filterCriteria", "name" ], "members":{ "action":{ "shape":"FilterAction", "documentation":"

Defines the action that is to be applied to the findings that match the filter.

" }, "description":{ "shape":"FilterDescription", "documentation":"

A description of the filter.

" }, "filterCriteria":{ "shape":"FilterCriteria", "documentation":"

Defines the criteria to be used in the filter for querying findings.

" }, "name":{ "shape":"FilterName", "documentation":"

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.

" }, "tags":{ "shape":"TagMap", "documentation":"

A list of tags for the filter.

" } } }, "CreateFilterResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"FilterArn", "documentation":"

The Amazon Resource Number (ARN) of the successfully created filter.

" } } }, "CreateFindingsReportRequest":{ "type":"structure", "required":[ "reportFormat", "s3Destination" ], "members":{ "filterCriteria":{ "shape":"FilterCriteria", "documentation":"

The filter criteria to apply to the results of the finding report.

" }, "reportFormat":{ "shape":"ReportFormat", "documentation":"

The format to generate the report in.

" }, "s3Destination":{ "shape":"Destination", "documentation":"

The Amazon S3 export destination for the report.

" } } }, "CreateFindingsReportResponse":{ "type":"structure", "members":{ "reportId":{ "shape":"ReportId", "documentation":"

The ID of the report.

" } } }, "Currency":{ "type":"string", "enum":["USD"] }, "CvssScore":{ "type":"structure", "required":[ "baseScore", "scoringVector", "source", "version" ], "members":{ "baseScore":{ "shape":"Double", "documentation":"

The base CVSS score used for the finding.

" }, "scoringVector":{ "shape":"NonEmptyString", "documentation":"

The vector string of the CVSS score.

" }, "source":{ "shape":"NonEmptyString", "documentation":"

The source of the CVSS score.

" }, "version":{ "shape":"NonEmptyString", "documentation":"

The version of CVSS used for the score.

" } }, "documentation":"

The CVSS score for a finding.

" }, "CvssScoreAdjustment":{ "type":"structure", "required":[ "metric", "reason" ], "members":{ "metric":{ "shape":"NonEmptyString", "documentation":"

The metric used to adjust the CVSS score.

" }, "reason":{ "shape":"NonEmptyString", "documentation":"

The reason the CVSS score has been adjustment.

" } }, "documentation":"

Details on adjustments Amazon Inspector made to the CVSS score for a finding.

" }, "CvssScoreAdjustmentList":{ "type":"list", "member":{"shape":"CvssScoreAdjustment"} }, "CvssScoreDetails":{ "type":"structure", "required":[ "score", "scoreSource", "scoringVector", "version" ], "members":{ "adjustments":{ "shape":"CvssScoreAdjustmentList", "documentation":"

An object that contains details about adjustment Amazon Inspector made to the CVSS score.

" }, "cvssSource":{ "shape":"NonEmptyString", "documentation":"

The source of the CVSS data.

" }, "score":{ "shape":"Double", "documentation":"

The CVSS score.

" }, "scoreSource":{ "shape":"NonEmptyString", "documentation":"

The source for the CVSS score.

" }, "scoringVector":{ "shape":"NonEmptyString", "documentation":"

The vector for the CVSS score.

" }, "version":{ "shape":"NonEmptyString", "documentation":"

The CVSS version used in scoring.

" } }, "documentation":"

Information about the CVSS score.

" }, "CvssScoreList":{ "type":"list", "member":{"shape":"CvssScore"} }, "DateFilter":{ "type":"structure", "members":{ "endInclusive":{ "shape":"Timestamp", "documentation":"

A timestamp representing the end of the time period filtered on.

" }, "startInclusive":{ "shape":"Timestamp", "documentation":"

A timestamp representing the start of the time period filtered on.

" } }, "documentation":"

Contains details on the time range used to filter findings.

" }, "DateFilterList":{ "type":"list", "member":{"shape":"DateFilter"}, "max":10, "min":1 }, "DateTimeTimestamp":{"type":"timestamp"}, "DelegatedAdmin":{ "type":"structure", "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.

" }, "relationshipStatus":{ "shape":"RelationshipStatus", "documentation":"

The status of the Amazon Inspector delegated administrator.

" } }, "documentation":"

Details of the Amazon Inspector delegated administrator for your organization.

" }, "DelegatedAdminAccount":{ "type":"structure", "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.

" }, "status":{ "shape":"DelegatedAdminStatus", "documentation":"

The status of the Amazon Inspector delegated administrator.

" } }, "documentation":"

Details of the Amazon Inspector delegated administrator for your organization.

" }, "DelegatedAdminAccountList":{ "type":"list", "member":{"shape":"DelegatedAdminAccount"}, "max":5, "min":0 }, "DelegatedAdminStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLE_IN_PROGRESS" ] }, "DeleteFilterRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"FilterArn", "documentation":"

The Amazon Resource Number (ARN) of the filter to be deleted.

" } } }, "DeleteFilterResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"FilterArn", "documentation":"

The Amazon Resource Number (ARN) of the filter that has been deleted.

" } } }, "DescribeOrganizationConfigurationRequest":{ "type":"structure", "members":{ } }, "DescribeOrganizationConfigurationResponse":{ "type":"structure", "members":{ "autoEnable":{ "shape":"AutoEnable", "documentation":"

The scan types are automatically enabled for new members of your organization.

" }, "maxAccountLimitReached":{ "shape":"Boolean", "documentation":"

Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.

" } } }, "Destination":{ "type":"structure", "required":[ "bucketName", "kmsKeyArn" ], "members":{ "bucketName":{ "shape":"String", "documentation":"

The name of the Amazon S3 bucket to export findings to.

" }, "keyPrefix":{ "shape":"String", "documentation":"

The prefix of the KMS key used to export findings.

" }, "kmsKeyArn":{ "shape":"String", "documentation":"

The ARN of the KMS key used to encrypt data when exporting findings.

" } }, "documentation":"

Contains details of the Amazon S3 bucket and KMS key used to export findings.

" }, "DisableDelegatedAdminAccountRequest":{ "type":"structure", "required":["delegatedAdminAccountId"], "members":{ "delegatedAdminAccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.

" } } }, "DisableDelegatedAdminAccountResponse":{ "type":"structure", "required":["delegatedAdminAccountId"], "members":{ "delegatedAdminAccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the successfully disabled delegated administrator.

" } } }, "DisableRequest":{ "type":"structure", "members":{ "accountIds":{ "shape":"AccountIdSet", "documentation":"

An array of account IDs you want to disable Amazon Inspector scans for.

" }, "resourceTypes":{ "shape":"DisableResourceTypeList", "documentation":"

The resource scan types you want to disable.

" } } }, "DisableResourceTypeList":{ "type":"list", "member":{"shape":"ResourceScanType"}, "max":2, "min":0 }, "DisableResponse":{ "type":"structure", "required":["accounts"], "members":{ "accounts":{ "shape":"AccountList", "documentation":"

Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are provided for each account.

" }, "failedAccounts":{ "shape":"FailedAccountList", "documentation":"

Information on any accounts for which Amazon Inspector scans could not be disabled. Details are provided for each account.

" } } }, "DisassociateMemberRequest":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the member account to disassociate.

" } } }, "DisassociateMemberResponse":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the successfully disassociated member.

" } } }, "Double":{ "type":"double", "box":true }, "Ec2InstanceAggregation":{ "type":"structure", "members":{ "amis":{ "shape":"StringFilterList", "documentation":"

The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.

" }, "instanceIds":{ "shape":"StringFilterList", "documentation":"

The Amazon EC2 instance IDs to aggregate findings for.

" }, "instanceTags":{ "shape":"MapFilterList", "documentation":"

The Amazon EC2 instance tags to aggregate findings for.

" }, "operatingSystems":{ "shape":"StringFilterList", "documentation":"

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.

" }, "sortBy":{ "shape":"Ec2InstanceSortBy", "documentation":"

The value to sort results by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order to sort results by.

" } }, "documentation":"

The details that define an aggregation based on Amazon EC2 instances.

" }, "Ec2InstanceAggregationResponse":{ "type":"structure", "required":["instanceId"], "members":{ "accountId":{ "shape":"String", "documentation":"

The Amazon Web Services account the Amazon EC2 instance belongs to.

" }, "ami":{ "shape":"AmiId", "documentation":"

The Amazon Machine Image (AMI) of the Amazon EC2 instance.

" }, "instanceId":{ "shape":"NonEmptyString", "documentation":"

The Amazon EC2 instance ID.

" }, "instanceTags":{ "shape":"TagMap", "documentation":"

The tags attached to the instance.

" }, "networkFindings":{ "shape":"Long", "documentation":"

The number of network findings for the Amazon EC2 instance.

" }, "operatingSystem":{ "shape":"String", "documentation":"

The operating system of the Amazon EC2 instance.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

An object that contains the count of matched findings per severity.

" } }, "documentation":"

A response that contains the results of a finding aggregation by Amazon EC2 instance.

" }, "Ec2InstanceSortBy":{ "type":"string", "enum":[ "NETWORK_FINDINGS", "CRITICAL", "HIGH", "ALL" ] }, "Ec2Metadata":{ "type":"structure", "members":{ "amiId":{ "shape":"AmiId", "documentation":"

The ID of the Amazon Machine Image (AMI) used to launch the instance.

" }, "platform":{ "shape":"Ec2Platform", "documentation":"

The platform of the instance.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags attached to the instance.

" } }, "documentation":"

Meta data details of an Amazon EC2 instance.

" }, "Ec2Platform":{ "type":"string", "enum":[ "WINDOWS", "LINUX", "UNKNOWN" ] }, "EcrContainerImageMetadata":{ "type":"structure", "members":{ "tags":{ "shape":"TagList", "documentation":"

Tags associated with the Amazon ECR image metadata.

" } }, "documentation":"

Information on the Amazon ECR image metadata associated with a finding.

" }, "EcrRepositoryMetadata":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the Amazon ECR repository.

" }, "scanFrequency":{ "shape":"EcrScanFrequency", "documentation":"

The frequency of scans.

" } }, "documentation":"

Information on the Amazon ECR repository metadata associated with a finding.

" }, "EcrScanFrequency":{ "type":"string", "enum":[ "MANUAL", "SCAN_ON_PUSH", "CONTINUOUS_SCAN" ] }, "EnableDelegatedAdminAccountRequest":{ "type":"structure", "required":["delegatedAdminAccountId"], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"

The idempotency token for the request.

", "idempotencyToken":true }, "delegatedAdminAccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

" } } }, "EnableDelegatedAdminAccountResponse":{ "type":"structure", "required":["delegatedAdminAccountId"], "members":{ "delegatedAdminAccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.

" } } }, "EnableRequest":{ "type":"structure", "required":["resourceTypes"], "members":{ "accountIds":{ "shape":"AccountIdSet", "documentation":"

A list of account IDs you want to enable Amazon Inspector scans for.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

The idempotency token for the request.

", "idempotencyToken":true }, "resourceTypes":{ "shape":"EnableResourceTypeList", "documentation":"

The resource scan types you want to enable.

" } } }, "EnableResourceTypeList":{ "type":"list", "member":{"shape":"ResourceScanType"}, "max":2, "min":1 }, "EnableResponse":{ "type":"structure", "required":["accounts"], "members":{ "accounts":{ "shape":"AccountList", "documentation":"

Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are provided for each account.

" }, "failedAccounts":{ "shape":"FailedAccountList", "documentation":"

Information on any accounts for which Amazon Inspector scans could not be enabled. Details are provided for each account.

" } } }, "ErrorCode":{ "type":"string", "enum":[ "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" ] }, "ErrorMessage":{"type":"string"}, "ExternalReportStatus":{ "type":"string", "enum":[ "SUCCEEDED", "IN_PROGRESS", "CANCELLED", "FAILED" ] }, "FailedAccount":{ "type":"structure", "required":[ "accountId", "errorCode", "errorMessage" ], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID.

" }, "errorCode":{ "shape":"ErrorCode", "documentation":"

The error code explaining why the account failed to enable Amazon Inspector.

" }, "errorMessage":{ "shape":"NonEmptyString", "documentation":"

The error message received when the account failed to enable Amazon Inspector.

" }, "resourceStatus":{ "shape":"ResourceStatus", "documentation":"

An object detailing which resources Amazon Inspector is enabled to scan for the account.

" }, "status":{ "shape":"Status", "documentation":"

The status of Amazon Inspector for the account.

" } }, "documentation":"

An object with details on why an account failed to enable Amazon Inspector.

" }, "FailedAccountList":{ "type":"list", "member":{"shape":"FailedAccount"}, "max":100, "min":0 }, "FilePath":{ "type":"string", "max":1024, "min":1 }, "Filter":{ "type":"structure", "required":[ "action", "arn", "createdAt", "criteria", "name", "ownerId", "updatedAt" ], "members":{ "action":{ "shape":"FilterAction", "documentation":"

The action that is to be applied to the findings that match the filter.

" }, "arn":{ "shape":"FilterArn", "documentation":"

The Amazon Resource Number (ARN) associated with this filter.

" }, "createdAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time this filter was created at.

" }, "criteria":{ "shape":"FilterCriteria", "documentation":"

Details on the filter criteria associated with this filter.

" }, "description":{ "shape":"FilterDescription", "documentation":"

A description of the filter.

" }, "name":{ "shape":"FilterName", "documentation":"

The name of the filter.

" }, "ownerId":{ "shape":"OwnerId", "documentation":"

The Amazon Web Services account ID of the account that created the filter.

" }, "reason":{ "shape":"FilterReason", "documentation":"

The reason for the filter.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags attached to the filter.

" }, "updatedAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time the filter was last updated at.

" } }, "documentation":"

Details about a filter.

" }, "FilterAction":{ "type":"string", "enum":[ "NONE", "SUPPRESS" ] }, "FilterArn":{ "type":"string", "max":128, "min":1 }, "FilterArnList":{ "type":"list", "member":{"shape":"FilterArn"} }, "FilterCriteria":{ "type":"structure", "members":{ "awsAccountId":{ "shape":"StringFilterList", "documentation":"

Details of the Amazon Web Services account IDs used to filter findings.

" }, "componentId":{ "shape":"StringFilterList", "documentation":"

Details of the component IDs used to filter findings.

" }, "componentType":{ "shape":"StringFilterList", "documentation":"

Details of the component types used to filter findings.

" }, "ec2InstanceImageId":{ "shape":"StringFilterList", "documentation":"

Details of the Amazon EC2 instance image IDs used to filter findings.

" }, "ec2InstanceSubnetId":{ "shape":"StringFilterList", "documentation":"

Details of the Amazon EC2 instance subnet IDs used to filter findings.

" }, "ec2InstanceVpcId":{ "shape":"StringFilterList", "documentation":"

Details of the Amazon EC2 instance VPC IDs used to filter findings.

" }, "ecrImageArchitecture":{ "shape":"StringFilterList", "documentation":"

Details of the Amazon ECR image architecture types used to filter findings.

" }, "ecrImageHash":{ "shape":"StringFilterList", "documentation":"

Details of the Amazon ECR image hashes used to filter findings.

" }, "ecrImagePushedAt":{ "shape":"DateFilterList", "documentation":"

Details on the Amazon ECR image push date and time used to filter findings.

" }, "ecrImageRegistry":{ "shape":"StringFilterList", "documentation":"

Details on the Amazon ECR registry used to filter findings.

" }, "ecrImageRepositoryName":{ "shape":"StringFilterList", "documentation":"

Details on the name of the Amazon ECR repository used to filter findings.

" }, "ecrImageTags":{ "shape":"StringFilterList", "documentation":"

The tags attached to the Amazon ECR container image.

" }, "findingArn":{ "shape":"StringFilterList", "documentation":"

Details on the finding ARNs used to filter findings.

" }, "findingStatus":{ "shape":"StringFilterList", "documentation":"

Details on the finding status types used to filter findings.

" }, "findingType":{ "shape":"StringFilterList", "documentation":"

Details on the finding types used to filter findings.

" }, "firstObservedAt":{ "shape":"DateFilterList", "documentation":"

Details on the date and time a finding was first seen used to filter findings.

" }, "inspectorScore":{ "shape":"NumberFilterList", "documentation":"

The Amazon Inspector score to filter on.

" }, "lastObservedAt":{ "shape":"DateFilterList", "documentation":"

Details on the date and time a finding was last seen used to filter findings.

" }, "networkProtocol":{ "shape":"StringFilterList", "documentation":"

Details on the ingress source addresses used to filter findings.

" }, "portRange":{ "shape":"PortRangeFilterList", "documentation":"

Details on the port ranges used to filter findings.

" }, "relatedVulnerabilities":{ "shape":"StringFilterList", "documentation":"

Details on the related vulnerabilities used to filter findings.

" }, "resourceId":{ "shape":"StringFilterList", "documentation":"

Details on the resource IDs used to filter findings.

" }, "resourceTags":{ "shape":"MapFilterList", "documentation":"

Details on the resource tags used to filter findings.

" }, "resourceType":{ "shape":"StringFilterList", "documentation":"

Details on the resource types used to filter findings.

" }, "severity":{ "shape":"StringFilterList", "documentation":"

Details on the severity used to filter findings.

" }, "title":{ "shape":"StringFilterList", "documentation":"

Details on the finding title used to filter findings.

" }, "updatedAt":{ "shape":"DateFilterList", "documentation":"

Details on the date and time a finding was last updated at used to filter findings.

" }, "vendorSeverity":{ "shape":"StringFilterList", "documentation":"

Details on the vendor severity used to filter findings.

" }, "vulnerabilityId":{ "shape":"StringFilterList", "documentation":"

Details on the vulnerability ID used to filter findings.

" }, "vulnerabilitySource":{ "shape":"StringFilterList", "documentation":"

Details on the vulnerability type used to filter findings.

" }, "vulnerablePackages":{ "shape":"PackageFilterList", "documentation":"

Details on the vulnerable packages used to filter findings.

" } }, "documentation":"

Details on the criteria used to define the filter.

" }, "FilterDescription":{ "type":"string", "max":512, "min":1 }, "FilterList":{ "type":"list", "member":{"shape":"Filter"} }, "FilterName":{ "type":"string", "max":128, "min":1 }, "FilterReason":{ "type":"string", "max":512, "min":1 }, "Finding":{ "type":"structure", "required":[ "awsAccountId", "description", "findingArn", "firstObservedAt", "lastObservedAt", "remediation", "resources", "severity", "status", "type" ], "members":{ "awsAccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID associated with the finding.

" }, "description":{ "shape":"FindingDescription", "documentation":"

The description of the finding.

" }, "findingArn":{ "shape":"FindingArn", "documentation":"

The Amazon Resource Number (ARN) of the finding.

" }, "firstObservedAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time that the finding was first observed.

" }, "inspectorScore":{ "shape":"Double", "documentation":"

The Amazon Inspector score given to the finding.

" }, "inspectorScoreDetails":{ "shape":"InspectorScoreDetails", "documentation":"

An object that contains details of the Amazon Inspector score.

" }, "lastObservedAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time that the finding was last observed.

" }, "networkReachabilityDetails":{ "shape":"NetworkReachabilityDetails", "documentation":"

An object that contains the details of a network reachability finding.

" }, "packageVulnerabilityDetails":{ "shape":"PackageVulnerabilityDetails", "documentation":"

An object that contains the details of a package vulnerability finding.

" }, "remediation":{ "shape":"Remediation", "documentation":"

An object that contains the details about how to remediate a finding.

" }, "resources":{ "shape":"ResourceList", "documentation":"

Contains information on the resources involved in a finding.

" }, "severity":{ "shape":"Severity", "documentation":"

The severity of the finding.

" }, "status":{ "shape":"FindingStatus", "documentation":"

The status of the finding.

" }, "title":{ "shape":"FindingTitle", "documentation":"

The title of the finding.

" }, "type":{ "shape":"FindingType", "documentation":"

The type of the finding.

" }, "updatedAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time the finding was last updated at.

" } }, "documentation":"

Details about an Amazon Inspector finding.

" }, "FindingArn":{ "type":"string", "max":1024, "min":1 }, "FindingDescription":{ "type":"string", "max":1024, "min":1 }, "FindingList":{ "type":"list", "member":{"shape":"Finding"}, "max":25, "min":0 }, "FindingStatus":{ "type":"string", "enum":[ "ACTIVE", "SUPPRESSED", "CLOSED" ] }, "FindingTitle":{ "type":"string", "max":1024, "min":1 }, "FindingType":{ "type":"string", "enum":[ "NETWORK_REACHABILITY", "PACKAGE_VULNERABILITY" ] }, "FindingTypeAggregation":{ "type":"structure", "members":{ "findingType":{ "shape":"AggregationFindingType", "documentation":"

The finding type to aggregate.

" }, "resourceType":{ "shape":"AggregationResourceType", "documentation":"

The resource type to aggregate.

" }, "sortBy":{ "shape":"FindingTypeSortBy", "documentation":"

The value to sort results by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order to sort results by.

" } }, "documentation":"

The details that define an aggregation based on finding type.

" }, "FindingTypeAggregationResponse":{ "type":"structure", "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The ID of the Amazon Web Services account associated with the findings.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

The value to sort results by.

" } }, "documentation":"

A response that contains the results of a finding type aggregation.

" }, "FindingTypeSortBy":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "ALL" ] }, "FreeTrialAccountInfo":{ "type":"structure", "required":[ "accountId", "freeTrialInfo" ], "members":{ "accountId":{ "shape":"MeteringAccountId", "documentation":"

The account associated with the Amazon Inspector free trial information.

" }, "freeTrialInfo":{ "shape":"FreeTrialInfoList", "documentation":"

Contains information about the Amazon Inspector free trial for an account.

" } }, "documentation":"

Information about the Amazon Inspector free trial for an account.

" }, "FreeTrialAccountInfoList":{ "type":"list", "member":{"shape":"FreeTrialAccountInfo"} }, "FreeTrialInfo":{ "type":"structure", "required":[ "end", "start", "status", "type" ], "members":{ "end":{ "shape":"Timestamp", "documentation":"

The date and time that the Amazon Inspector free trail ends for a given account.

" }, "start":{ "shape":"Timestamp", "documentation":"

The date and time that the Amazon Inspector free trail started for a given account.

" }, "status":{ "shape":"FreeTrialStatus", "documentation":"

The order to sort results by.

" }, "type":{ "shape":"FreeTrialType", "documentation":"

The type of scan covered by the Amazon Inspector free trail.

" } }, "documentation":"

An object that contains information about the Amazon Inspector free trial for an account.

" }, "FreeTrialInfoError":{ "type":"structure", "required":[ "accountId", "code", "message" ], "members":{ "accountId":{ "shape":"MeteringAccountId", "documentation":"

The account associated with the Amazon Inspector free trial information.

" }, "code":{ "shape":"FreeTrialInfoErrorCode", "documentation":"

The error code.

" }, "message":{ "shape":"String", "documentation":"

The error message returned.

" } }, "documentation":"

Information about an error received while accessing free trail data for an account.

" }, "FreeTrialInfoErrorCode":{ "type":"string", "enum":[ "ACCESS_DENIED", "INTERNAL_ERROR" ] }, "FreeTrialInfoErrorList":{ "type":"list", "member":{"shape":"FreeTrialInfoError"} }, "FreeTrialInfoList":{ "type":"list", "member":{"shape":"FreeTrialInfo"} }, "FreeTrialStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "FreeTrialType":{ "type":"string", "enum":[ "EC2", "ECR" ] }, "GetDelegatedAdminAccountRequest":{ "type":"structure", "members":{ } }, "GetDelegatedAdminAccountResponse":{ "type":"structure", "members":{ "delegatedAdmin":{ "shape":"DelegatedAdmin", "documentation":"

The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

" } } }, "GetFindingsReportStatusRequest":{ "type":"structure", "members":{ "reportId":{ "shape":"ReportId", "documentation":"

The ID of the report to retrieve the status of.

" } } }, "GetFindingsReportStatusResponse":{ "type":"structure", "members":{ "destination":{ "shape":"Destination", "documentation":"

The destination of the report.

" }, "errorCode":{ "shape":"ReportingErrorCode", "documentation":"

The error code of the report.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message of the report.

" }, "filterCriteria":{ "shape":"FilterCriteria", "documentation":"

The filter criteria associated with the report.

" }, "reportId":{ "shape":"ReportId", "documentation":"

The ID of the report.

" }, "status":{ "shape":"ExternalReportStatus", "documentation":"

The status of the report.

" } } }, "GetMemberRequest":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the member account to retrieve information on.

" } } }, "GetMemberResponse":{ "type":"structure", "members":{ "member":{ "shape":"Member", "documentation":"

Details of the retrieved member account.

" } } }, "GroupKey":{ "type":"string", "enum":[ "SCAN_STATUS_CODE", "SCAN_STATUS_REASON", "ACCOUNT_ID", "RESOURCE_TYPE", "ECR_REPOSITORY_NAME" ] }, "ImageHash":{ "type":"string", "max":71, "min":71, "pattern":"^sha256:[a-z0-9]{64}$" }, "ImageLayerAggregation":{ "type":"structure", "members":{ "layerHashes":{ "shape":"StringFilterList", "documentation":"

The hashes associated with the layers.

" }, "repositories":{ "shape":"StringFilterList", "documentation":"

The repository associated with the container image hosting the layers.

" }, "resourceIds":{ "shape":"StringFilterList", "documentation":"

The ID of the container image layer.

" }, "sortBy":{ "shape":"ImageLayerSortBy", "documentation":"

The value to sort results by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order to sort results by.

" } }, "documentation":"

The details that define an aggregation based on container image layers.

" }, "ImageLayerAggregationResponse":{ "type":"structure", "required":[ "accountId", "layerHash", "repository", "resourceId" ], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The ID of the Amazon Web Services account that owns the container image hosting the layer image.

" }, "layerHash":{ "shape":"NonEmptyString", "documentation":"

The layer hash.

" }, "repository":{ "shape":"NonEmptyString", "documentation":"

The repository the layer resides in.

" }, "resourceId":{ "shape":"NonEmptyString", "documentation":"

The resource ID of the container image layer.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

An object that represents the count of matched findings per severity.

" } }, "documentation":"

A response that contains the results of a finding aggregation by image layer.

" }, "ImageLayerSortBy":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "ALL" ] }, "ImageTagList":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "InspectorScoreDetails":{ "type":"structure", "members":{ "adjustedCvss":{ "shape":"CvssScoreDetails", "documentation":"

An object that contains details about the CVSS score given to a finding.

" } }, "documentation":"

Information about the Amazon Inspector score given to a finding.

" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "retryAfterSeconds":{ "shape":"Integer", "documentation":"

The number of seconds to wait before retrying the request.

", "location":"header", "locationName":"Retry-After" } }, "documentation":"

The request has failed due to an internal failure of the Amazon Inspector service.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "IpV4Address":{ "type":"string", "max":15, "min":7, "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" }, "IpV4AddressList":{ "type":"list", "member":{"shape":"IpV4Address"} }, "IpV6Address":{ "type":"string", "max":47, "min":1 }, "IpV6AddressList":{ "type":"list", "member":{"shape":"IpV6Address"} }, "ListAccountPermissionsMaxResults":{ "type":"integer", "box":true, "max":1024, "min":1 }, "ListAccountPermissionsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListAccountPermissionsMaxResults", "documentation":"

The maximum number of results to return in the response.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" }, "service":{ "shape":"Service", "documentation":"

The service scan type to check permissions for.

" } } }, "ListAccountPermissionsResponse":{ "type":"structure", "required":["permissions"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" }, "permissions":{ "shape":"Permissions", "documentation":"

Contains details on the permissions an account has to configure Amazon Inspector.

" } } }, "ListCoverageMaxResults":{ "type":"integer", "box":true, "max":200, "min":1 }, "ListCoverageRequest":{ "type":"structure", "members":{ "filterCriteria":{ "shape":"CoverageFilterCriteria", "documentation":"

An object that contains details on the filters to apply to the coverage data for your environment.

" }, "maxResults":{ "shape":"ListCoverageMaxResults", "documentation":"

The maximum number of results to return in the response.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListCoverageResponse":{ "type":"structure", "members":{ "coveredResources":{ "shape":"CoveredResources", "documentation":"

An object that contains details on the covered resources in your environment.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListCoverageStatisticsRequest":{ "type":"structure", "members":{ "filterCriteria":{ "shape":"CoverageFilterCriteria", "documentation":"

An object that contains details on the filters to apply to the coverage data for your environment.

" }, "groupBy":{ "shape":"GroupKey", "documentation":"

The value to group the results by.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListCoverageStatisticsResponse":{ "type":"structure", "required":["totalCounts"], "members":{ "countsByGroup":{ "shape":"CountsList", "documentation":"

An array with the number for each group.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" }, "totalCounts":{ "shape":"Long", "documentation":"

The total number for all groups.

" } } }, "ListDelegatedAdminAccountsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListDelegatedAdminMaxResults", "documentation":"

The maximum number of results to return in the response.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListDelegatedAdminAccountsResponse":{ "type":"structure", "members":{ "delegatedAdminAccounts":{ "shape":"DelegatedAdminAccountList", "documentation":"

Details of the Amazon Inspector delegated administrator of your organization.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListDelegatedAdminMaxResults":{ "type":"integer", "box":true, "max":5, "min":1 }, "ListFilterMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListFiltersRequest":{ "type":"structure", "members":{ "action":{ "shape":"FilterAction", "documentation":"

The action the filter applies to matched findings.

" }, "arns":{ "shape":"FilterArnList", "documentation":"

The Amazon resource number (ARN) of the filter.

" }, "maxResults":{ "shape":"ListFilterMaxResults", "documentation":"

The maximum number of results to return in the response.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListFiltersResponse":{ "type":"structure", "required":["filters"], "members":{ "filters":{ "shape":"FilterList", "documentation":"

Contains details on the filters associated with your account.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListFindingAggregationsMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListFindingAggregationsRequest":{ "type":"structure", "required":["aggregationType"], "members":{ "accountIds":{ "shape":"StringFilterList", "documentation":"

The Amazon Web Services account IDs to retrieve finding aggregation data for.

" }, "aggregationRequest":{ "shape":"AggregationRequest", "documentation":"

Details of the aggregation request that is used to filter your aggregation results.

" }, "aggregationType":{ "shape":"AggregationType", "documentation":"

The type of the aggregation request.

" }, "maxResults":{ "shape":"ListFindingAggregationsMaxResults", "documentation":"

The maximum number of results to return in the response.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListFindingAggregationsResponse":{ "type":"structure", "required":["aggregationType"], "members":{ "aggregationType":{ "shape":"AggregationType", "documentation":"

The type of aggregation to perform.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" }, "responses":{ "shape":"AggregationResponseList", "documentation":"

Objects that contain the results of an aggregation operation.

" } } }, "ListFindingsMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListFindingsRequest":{ "type":"structure", "members":{ "filterCriteria":{ "shape":"FilterCriteria", "documentation":"

Details on the filters to apply to your finding results.

" }, "maxResults":{ "shape":"ListFindingsMaxResults", "documentation":"

The maximum number of results to return in the response.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" }, "sortCriteria":{ "shape":"SortCriteria", "documentation":"

Details on the sort criteria to apply to your finding results.

" } } }, "ListFindingsResponse":{ "type":"structure", "members":{ "findings":{ "shape":"FindingList", "documentation":"

Contains details on the findings in your environment.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListMembersMaxResults":{ "type":"integer", "box":true, "max":50, "min":1 }, "ListMembersRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListMembersMaxResults", "documentation":"

The maximum number of results to return in the response.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" }, "onlyAssociated":{ "shape":"Boolean", "documentation":"

Specifies whether to list only currently associated members if True or to list all members within the organization if False.

" } } }, "ListMembersResponse":{ "type":"structure", "members":{ "members":{ "shape":"MemberList", "documentation":"

An object that contains details for each member account.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The pagination parameter to be used on the next list operation to retrieve more items.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The Amazon resource number (ARN) of the resource to list tags of.

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"

The tags associated with the resource.

" } } }, "ListUsageTotalsMaxResults":{ "type":"integer", "box":true, "max":500, "min":1 }, "ListUsageTotalsNextToken":{ "type":"string", "min":1 }, "ListUsageTotalsRequest":{ "type":"structure", "members":{ "accountIds":{ "shape":"UsageAccountIdList", "documentation":"

The Amazon Web Services account IDs to retrieve usage totals for.

" }, "maxResults":{ "shape":"ListUsageTotalsMaxResults", "documentation":"

The maximum number of results to return in the response.

" }, "nextToken":{ "shape":"ListUsageTotalsNextToken", "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } }, "ListUsageTotalsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"ListUsageTotalsNextToken", "documentation":"

The pagination parameter to be used on the next list operation to retrieve more items.

" }, "totals":{ "shape":"UsageTotalList", "documentation":"

An object with details on the total usage for the requested account.

" } } }, "Long":{ "type":"long", "box":true }, "MapComparison":{ "type":"string", "enum":["EQUALS"] }, "MapFilter":{ "type":"structure", "required":[ "comparison", "key" ], "members":{ "comparison":{ "shape":"MapComparison", "documentation":"

The operator to use when comparing values in the filter.

" }, "key":{ "shape":"MapKey", "documentation":"

The tag key used in the filter.

" }, "value":{ "shape":"MapValue", "documentation":"

The tag value used in the filter.

" } }, "documentation":"

An object that describes details of a map filter.

" }, "MapFilterList":{ "type":"list", "member":{"shape":"MapFilter"}, "max":10, "min":1 }, "MapKey":{ "type":"string", "max":128, "min":1 }, "MapValue":{ "type":"string", "max":256, "min":0 }, "Member":{ "type":"structure", "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the member account.

" }, "delegatedAdminAccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.

" }, "relationshipStatus":{ "shape":"RelationshipStatus", "documentation":"

The status of the member account.

" }, "updatedAt":{ "shape":"DateTimeTimestamp", "documentation":"

A timestamp showing when the status of this member was last updated.

" } }, "documentation":"

Details on a member account in your organization.

" }, "MemberList":{ "type":"list", "member":{"shape":"Member"}, "max":50, "min":0 }, "MeteringAccountId":{ "type":"string", "pattern":"[0-9]{12}" }, "MonthlyCostEstimate":{ "type":"double", "min":0 }, "NetworkPath":{ "type":"structure", "members":{ "steps":{ "shape":"StepList", "documentation":"

The details on the steps in the network path.

" } }, "documentation":"

Information on the network path associated with a finding.

" }, "NetworkProtocol":{ "type":"string", "enum":[ "TCP", "UDP" ] }, "NetworkReachabilityDetails":{ "type":"structure", "required":[ "networkPath", "openPortRange", "protocol" ], "members":{ "networkPath":{ "shape":"NetworkPath", "documentation":"

An object that contains details about a network path associated with a finding.

" }, "openPortRange":{ "shape":"PortRange", "documentation":"

An object that contains details about the open port range associated with a finding.

" }, "protocol":{ "shape":"NetworkProtocol", "documentation":"

The protocol associated with a finding.

" } }, "documentation":"

Contains the details of a network reachability finding.

" }, "NextToken":{ "type":"string", "max":1000000, "min":0 }, "NonEmptyString":{ "type":"string", "min":1 }, "NonEmptyStringList":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "NumberFilter":{ "type":"structure", "members":{ "lowerInclusive":{ "shape":"Double", "documentation":"

The lowest number to be included in the filter.

" }, "upperInclusive":{ "shape":"Double", "documentation":"

The highest number to be included in the filter.

" } }, "documentation":"

An object that describes the details of a number filter.

" }, "NumberFilterList":{ "type":"list", "member":{"shape":"NumberFilter"}, "max":10, "min":1 }, "Operation":{ "type":"string", "enum":[ "ENABLE_SCANNING", "DISABLE_SCANNING", "ENABLE_REPOSITORY", "DISABLE_REPOSITORY" ] }, "OwnerId":{ "type":"string", "max":34, "min":12, "pattern":"(^\\d{12}$)|(^o-[a-z0-9]{10,32}$)" }, "PackageAggregation":{ "type":"structure", "members":{ "packageNames":{ "shape":"StringFilterList", "documentation":"

The names of packages to aggregate findings on.

" }, "sortBy":{ "shape":"PackageSortBy", "documentation":"

The value to sort results by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order to sort results by.

" } }, "documentation":"

The details that define an aggregation based on operating system package type.

" }, "PackageAggregationResponse":{ "type":"structure", "required":["packageName"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The ID of the Amazon Web Services account associated with the findings.

" }, "packageName":{ "shape":"NonEmptyString", "documentation":"

The name of the operating system package.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

An object that contains the count of matched findings per severity.

" } }, "documentation":"

A response that contains the results of a finding aggregation by image layer.

" }, "PackageArchitecture":{ "type":"string", "max":64, "min":1 }, "PackageEpoch":{"type":"integer"}, "PackageFilter":{ "type":"structure", "members":{ "architecture":{ "shape":"StringFilter", "documentation":"

An object that contains details on the package architecture type to filter on.

" }, "epoch":{ "shape":"NumberFilter", "documentation":"

An object that contains details on the package epoch to filter on.

" }, "name":{ "shape":"StringFilter", "documentation":"

An object that contains details on the name of the package to filter on.

" }, "release":{ "shape":"StringFilter", "documentation":"

An object that contains details on the package release to filter on.

" }, "sourceLayerHash":{ "shape":"StringFilter", "documentation":"

An object that contains details on the source layer hash to filter on.

" }, "version":{ "shape":"StringFilter", "documentation":"

The package version to filter on.

" } }, "documentation":"

Contains information on the details of a package filter.

" }, "PackageFilterList":{ "type":"list", "member":{"shape":"PackageFilter"}, "max":10, "min":1 }, "PackageManager":{ "type":"string", "enum":[ "BUNDLER", "CARGO", "COMPOSER", "NPM", "NUGET", "PIPENV", "POETRY", "YARN", "GOBINARY", "GOMOD", "JAR", "OS" ] }, "PackageName":{ "type":"string", "max":1024, "min":1 }, "PackageRelease":{ "type":"string", "max":1024, "min":1 }, "PackageSortBy":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "ALL" ] }, "PackageVersion":{ "type":"string", "max":1024, "min":1 }, "PackageVulnerabilityDetails":{ "type":"structure", "required":[ "source", "vulnerabilityId", "vulnerablePackages" ], "members":{ "cvss":{ "shape":"CvssScoreList", "documentation":"

An object that contains details about the CVSS score of a finding.

" }, "referenceUrls":{ "shape":"NonEmptyStringList", "documentation":"

One or more URLs that contain details about this vulnerability type.

" }, "relatedVulnerabilities":{ "shape":"VulnerabilityIdList", "documentation":"

One or more vulnerabilities related to the one identified in this finding.

" }, "source":{ "shape":"NonEmptyString", "documentation":"

The source of the vulnerability information.

" }, "sourceUrl":{ "shape":"NonEmptyString", "documentation":"

A URL to the source of the vulnerability information.

" }, "vendorCreatedAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time that this vulnerability was first added to the vendor's database.

" }, "vendorSeverity":{ "shape":"NonEmptyString", "documentation":"

The severity the vendor has given to this vulnerability type.

" }, "vendorUpdatedAt":{ "shape":"DateTimeTimestamp", "documentation":"

The date and time the vendor last updated this vulnerability in their database.

" }, "vulnerabilityId":{ "shape":"VulnerabilityId", "documentation":"

The ID given to this vulnerability.

" }, "vulnerablePackages":{ "shape":"VulnerablePackageList", "documentation":"

The packages impacted by this vulnerability.

" } }, "documentation":"

Information about a package vulnerability finding.

" }, "Permission":{ "type":"structure", "required":[ "operation", "service" ], "members":{ "operation":{ "shape":"Operation", "documentation":"

The operations that can be performed with the given permissions.

" }, "service":{ "shape":"Service", "documentation":"

The services that the permissions allow an account to perform the given operations for.

" } }, "documentation":"

Contains information on the permissions an account has within Amazon Inspector.

" }, "Permissions":{ "type":"list", "member":{"shape":"Permission"}, "max":1024, "min":0 }, "Platform":{ "type":"string", "max":1024, "min":1 }, "Port":{ "type":"integer", "box":true, "max":65535, "min":0 }, "PortRange":{ "type":"structure", "required":[ "begin", "end" ], "members":{ "begin":{ "shape":"Port", "documentation":"

The beginning port in a port range.

" }, "end":{ "shape":"Port", "documentation":"

The ending port in a port range.

" } }, "documentation":"

Details about the port range associated with a finding.

" }, "PortRangeFilter":{ "type":"structure", "members":{ "beginInclusive":{ "shape":"Port", "documentation":"

The port number the port range begins at.

" }, "endInclusive":{ "shape":"Port", "documentation":"

The port number the port range ends at.

" } }, "documentation":"

An object that describes the details of a port range filter.

" }, "PortRangeFilterList":{ "type":"list", "member":{"shape":"PortRangeFilter"}, "max":10, "min":1 }, "Recommendation":{ "type":"structure", "members":{ "Url":{ "shape":"NonEmptyString", "documentation":"

The URL address to the CVE remediation recommendations.

" }, "text":{ "shape":"NonEmptyString", "documentation":"

The recommended course of action to remediate the finding.

" } }, "documentation":"

Details about the recommended course of action to remediate the finding.

" }, "RelationshipStatus":{ "type":"string", "enum":[ "CREATED", "INVITED", "DISABLED", "ENABLED", "REMOVED", "RESIGNED", "DELETED", "EMAIL_VERIFICATION_IN_PROGRESS", "EMAIL_VERIFICATION_FAILED", "REGION_DISABLED", "ACCOUNT_SUSPENDED", "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER" ] }, "Remediation":{ "type":"structure", "members":{ "recommendation":{ "shape":"Recommendation", "documentation":"

An object that contains information about the recommended course of action to remediate the finding.

" } }, "documentation":"

Information on how to remediate a finding.

" }, "ReportFormat":{ "type":"string", "enum":[ "CSV", "JSON" ] }, "ReportId":{ "type":"string", "pattern":"\\b[a-f0-9]{8}\\b-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-\\b[a-f0-9]{12}\\b" }, "ReportingErrorCode":{ "type":"string", "enum":[ "INTERNAL_ERROR", "INVALID_PERMISSIONS" ] }, "RepositoryAggregation":{ "type":"structure", "members":{ "repositories":{ "shape":"StringFilterList", "documentation":"

The names of repositories to aggregate findings on.

" }, "sortBy":{ "shape":"RepositorySortBy", "documentation":"

The value to sort results by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order to sort results by.

" } }, "documentation":"

The details that define an aggregation based on repository.

" }, "RepositoryAggregationResponse":{ "type":"structure", "required":["repository"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The ID of the Amazon Web Services account associated with the findings.

" }, "affectedImages":{ "shape":"Long", "documentation":"

The number of container images impacted by the findings.

" }, "repository":{ "shape":"NonEmptyString", "documentation":"

The name of the repository associated with the findings.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

An object that represent the count of matched findings per severity.

" } }, "documentation":"

A response that contains details on the results of a finding aggregation by repository.

" }, "RepositorySortBy":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "ALL", "AFFECTED_IMAGES" ] }, "Resource":{ "type":"structure", "required":[ "id", "type" ], "members":{ "details":{ "shape":"ResourceDetails", "documentation":"

An object that contains details about the resource involved in a finding.

" }, "id":{ "shape":"NonEmptyString", "documentation":"

The ID of the resource.

" }, "partition":{ "shape":"NonEmptyString", "documentation":"

The partition of the resource.

" }, "region":{ "shape":"NonEmptyString", "documentation":"

The Amazon Web Services Region the impacted resource is located in.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags attached to the resource.

" }, "type":{ "shape":"ResourceType", "documentation":"

The type of resource.

" } }, "documentation":"

Details about the resource involved in a finding.

" }, "ResourceDetails":{ "type":"structure", "members":{ "awsEc2Instance":{ "shape":"AwsEc2InstanceDetails", "documentation":"

An object that contains details about the Amazon EC2 instance involved in the finding.

" }, "awsEcrContainerImage":{ "shape":"AwsEcrContainerImageDetails", "documentation":"

An object that contains details about the Amazon ECR container image involved in the finding.

" } }, "documentation":"

Contains details about the resource involved in the finding.

" }, "ResourceId":{ "type":"string", "max":341, "min":10, "pattern":"(^arn:.*:ecr:.*:\\d{12}:repository\\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\\/sha256:[a-z0-9]{64})?$)|(^i-([a-z0-9]{8}|[a-z0-9]{17}|\\\\*)$)" }, "ResourceList":{ "type":"list", "member":{"shape":"Resource"}, "max":10, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceScanMetadata":{ "type":"structure", "members":{ "ec2":{ "shape":"Ec2Metadata", "documentation":"

An object that contains metadata details for an Amazon EC2 instance.

" }, "ecrImage":{ "shape":"EcrContainerImageMetadata", "documentation":"

An object that contains details about the container metadata for an Amazon ECR image.

" }, "ecrRepository":{ "shape":"EcrRepositoryMetadata", "documentation":"

An object that contains details about the repository an Amazon ECR image resides in.

" } }, "documentation":"

An object that contains details about the metadata for an Amazon ECR resource.

" }, "ResourceScanType":{ "type":"string", "enum":[ "EC2", "ECR" ] }, "ResourceState":{ "type":"structure", "required":[ "ec2", "ecr" ], "members":{ "ec2":{ "shape":"State", "documentation":"

An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.

" }, "ecr":{ "shape":"State", "documentation":"

An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.

" } }, "documentation":"

Details the state of Amazon Inspector for each resource type Amazon Inspector scans.

" }, "ResourceStatus":{ "type":"structure", "required":[ "ec2", "ecr" ], "members":{ "ec2":{ "shape":"Status", "documentation":"

The status of Amazon Inspector scanning for Amazon EC2 resources.

" }, "ecr":{ "shape":"Status", "documentation":"

The status of Amazon Inspector scanning for Amazon ECR resources.

" } }, "documentation":"

Details the status of Amazon Inspector for each resource type Amazon Inspector scans.

" }, "ResourceType":{ "type":"string", "enum":[ "AWS_EC2_INSTANCE", "AWS_ECR_CONTAINER_IMAGE", "AWS_ECR_REPOSITORY" ] }, "ScanStatus":{ "type":"structure", "required":[ "reason", "statusCode" ], "members":{ "reason":{ "shape":"ScanStatusReason", "documentation":"

The reason for the scan.

" }, "statusCode":{ "shape":"ScanStatusCode", "documentation":"

The status code of the scan.

" } }, "documentation":"

The status of the scan.

" }, "ScanStatusCode":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "ScanStatusReason":{ "type":"string", "enum":[ "PENDING_INITIAL_SCAN", "ACCESS_DENIED", "INTERNAL_ERROR", "UNMANAGED_EC2_INSTANCE", "UNSUPPORTED_OS", "SCAN_ELIGIBILITY_EXPIRED", "RESOURCE_TERMINATED", "SUCCESSFUL", "NO_RESOURCES_FOUND", "IMAGE_SIZE_EXCEEDED", "SCAN_FREQUENCY_MANUAL", "SCAN_FREQUENCY_SCAN_ON_PUSH", "EC2_INSTANCE_STOPPED" ] }, "ScanType":{ "type":"string", "enum":[ "NETWORK", "PACKAGE" ] }, "Service":{ "type":"string", "enum":[ "EC2", "ECR" ] }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "resourceId" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"

The ID of the resource that exceeds a service quota.

" } }, "documentation":"

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "Severity":{ "type":"string", "enum":[ "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL", "UNTRIAGED" ] }, "SeverityCounts":{ "type":"structure", "members":{ "all":{ "shape":"Long", "documentation":"

The total count of findings from all severities.

" }, "critical":{ "shape":"Long", "documentation":"

The total count of critical severity findings.

" }, "high":{ "shape":"Long", "documentation":"

The total count of high severity findings.

" }, "medium":{ "shape":"Long", "documentation":"

The total count of medium severity findings.

" } }, "documentation":"

An object that contains the counts of aggregated finding per severity.

" }, "SortCriteria":{ "type":"structure", "required":[ "field", "sortOrder" ], "members":{ "field":{ "shape":"SortField", "documentation":"

The finding detail field by which results are sorted.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order by which findings are sorted.

" } }, "documentation":"

Details about the criteria used to sort finding results.

" }, "SortField":{ "type":"string", "enum":[ "AWS_ACCOUNT_ID", "FINDING_TYPE", "SEVERITY", "FIRST_OBSERVED_AT", "LAST_OBSERVED_AT", "FINDING_STATUS", "RESOURCE_TYPE", "ECR_IMAGE_PUSHED_AT", "ECR_IMAGE_REPOSITORY_NAME", "ECR_IMAGE_REGISTRY", "NETWORK_PROTOCOL", "COMPONENT_TYPE", "VULNERABILITY_ID", "VULNERABILITY_SOURCE", "INSPECTOR_SCORE", "VENDOR_SEVERITY" ] }, "SortOrder":{ "type":"string", "enum":[ "ASC", "DESC" ] }, "SourceLayerHash":{ "type":"string", "max":71, "min":71, "pattern":"^sha256:[a-z0-9]{64}$" }, "State":{ "type":"structure", "required":[ "errorCode", "errorMessage", "status" ], "members":{ "errorCode":{ "shape":"ErrorCode", "documentation":"

The error code explaining why the account failed to enable Amazon Inspector.

" }, "errorMessage":{ "shape":"NonEmptyString", "documentation":"

The error message received when the account failed to enable Amazon Inspector.

" }, "status":{ "shape":"Status", "documentation":"

The status of Amazon Inspector for the account.

" } }, "documentation":"

An object that described the state of Amazon Inspector scans for an account.

" }, "Status":{ "type":"string", "enum":[ "ENABLING", "ENABLED", "DISABLING", "DISABLED", "SUSPENDING", "SUSPENDED" ] }, "Step":{ "type":"structure", "required":[ "componentId", "componentType" ], "members":{ "componentId":{ "shape":"Component", "documentation":"

The component ID.

" }, "componentType":{ "shape":"ComponentType", "documentation":"

The component type.

" } }, "documentation":"

Details about the step associated with a finding.

" }, "StepList":{ "type":"list", "member":{"shape":"Step"}, "max":30, "min":1 }, "String":{"type":"string"}, "StringComparison":{ "type":"string", "enum":[ "EQUALS", "PREFIX", "NOT_EQUALS" ] }, "StringFilter":{ "type":"structure", "required":[ "comparison", "value" ], "members":{ "comparison":{ "shape":"StringComparison", "documentation":"

The operator to use when comparing values in the filter

" }, "value":{ "shape":"StringInput", "documentation":"

The value to filter on.

" } }, "documentation":"

An object that describes the details of a string filter.

" }, "StringFilterList":{ "type":"list", "member":{"shape":"StringFilter"}, "max":10, "min":1 }, "StringInput":{ "type":"string", "max":1024, "min":1 }, "StringList":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0 }, "TagList":{ "type":"list", "member":{"shape":"String"} }, "TagMap":{ "type":"map", "key":{"shape":"MapKey"}, "value":{"shape":"MapValue"} }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource to apply a tag to.

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"

The tags to be added to a resource.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The limit on the number of requests per second was exceeded.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Timestamp":{"type":"timestamp"}, "TitleAggregation":{ "type":"structure", "members":{ "resourceType":{ "shape":"AggregationResourceType", "documentation":"

The resource type to aggregate on.

" }, "sortBy":{ "shape":"TitleSortBy", "documentation":"

The value to sort results by.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order to sort results by.

" }, "titles":{ "shape":"StringFilterList", "documentation":"

The finding titles to aggregate on.

" }, "vulnerabilityIds":{ "shape":"StringFilterList", "documentation":"

The vulnerability IDs of the findings.

" } }, "documentation":"

The details that define an aggregation based on finding title.

" }, "TitleAggregationResponse":{ "type":"structure", "required":["title"], "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The ID of the Amazon Web Services account associated with the findings.

" }, "severityCounts":{ "shape":"SeverityCounts", "documentation":"

An object that represent the count of matched findings per severity.

" }, "title":{ "shape":"NonEmptyString", "documentation":"

The title that the findings were aggregated on.

" }, "vulnerabilityId":{ "shape":"String", "documentation":"

The vulnerability ID of the finding.

" } }, "documentation":"

A response that contains details on the results of a finding aggregation by title.

" }, "TitleSortBy":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "ALL" ] }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) for the resource to remove tags from.

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

The tag keys to remove from the resource.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateFilterRequest":{ "type":"structure", "required":["filterArn"], "members":{ "action":{ "shape":"FilterAction", "documentation":"

Specifies the action that is to be applied to the findings that match the filter.

" }, "description":{ "shape":"FilterDescription", "documentation":"

A description of the filter.

" }, "filterArn":{ "shape":"FilterArn", "documentation":"

The Amazon Resource Number (ARN) of the filter to update.

" }, "filterCriteria":{ "shape":"FilterCriteria", "documentation":"

Defines the criteria to be update in the filter.

" }, "name":{ "shape":"FilterName", "documentation":"

The name of the filter.

" } } }, "UpdateFilterResponse":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"FilterArn", "documentation":"

The Amazon Resource Number (ARN) of the successfully updated filter.

" } } }, "UpdateOrganizationConfigurationRequest":{ "type":"structure", "required":["autoEnable"], "members":{ "autoEnable":{ "shape":"AutoEnable", "documentation":"

Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.

" } } }, "UpdateOrganizationConfigurationResponse":{ "type":"structure", "required":["autoEnable"], "members":{ "autoEnable":{ "shape":"AutoEnable", "documentation":"

The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.

" } } }, "Usage":{ "type":"structure", "members":{ "currency":{ "shape":"Currency", "documentation":"

The currency type used when calculating usage data.

" }, "estimatedMonthlyCost":{ "shape":"MonthlyCostEstimate", "documentation":"

The estimated monthly cost of Amazon Inspector.

" }, "total":{ "shape":"UsageValue", "documentation":"

The total of usage.

" }, "type":{ "shape":"UsageType", "documentation":"

The type scan.

" } }, "documentation":"

Contains usage information about the cost of Amazon Inspector operation.

" }, "UsageAccountId":{ "type":"string", "pattern":"[0-9]{12}" }, "UsageAccountIdList":{ "type":"list", "member":{"shape":"UsageAccountId"}, "max":5000, "min":1 }, "UsageList":{ "type":"list", "member":{"shape":"Usage"} }, "UsageTotal":{ "type":"structure", "members":{ "accountId":{ "shape":"MeteringAccountId", "documentation":"

The account ID of the account that usage data was retrieved for.

" }, "usage":{ "shape":"UsageList", "documentation":"

An object representing the total usage for an account.

" } }, "documentation":"

The total of usage for an account ID.

" }, "UsageTotalList":{ "type":"list", "member":{"shape":"UsageTotal"} }, "UsageType":{ "type":"string", "enum":[ "EC2_INSTANCE_HOURS", "ECR_INITIAL_SCAN", "ECR_RESCAN" ] }, "UsageValue":{ "type":"double", "min":0 }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "fields":{ "shape":"ValidationExceptionFields", "documentation":"

The fields that failed validation.

" }, "message":{"shape":"String"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"

The reason for the validation failure.

" } }, "documentation":"

The request has failed validation due to missing required fields or having invalid inputs.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "message", "name" ], "members":{ "message":{ "shape":"String", "documentation":"

The validation exception message.

" }, "name":{ "shape":"String", "documentation":"

The name of the validation exception.

" } }, "documentation":"

An object that describes a validation exception.

" }, "ValidationExceptionFields":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "CANNOT_PARSE", "FIELD_VALIDATION_FAILED", "OTHER" ] }, "VulnerabilityId":{ "type":"string", "max":64, "min":1 }, "VulnerabilityIdList":{ "type":"list", "member":{"shape":"VulnerabilityId"} }, "VulnerablePackage":{ "type":"structure", "required":[ "name", "version" ], "members":{ "arch":{ "shape":"PackageArchitecture", "documentation":"

The architecture of the vulnerable package.

" }, "epoch":{ "shape":"PackageEpoch", "documentation":"

The epoch of the vulnerable package.

" }, "filePath":{ "shape":"FilePath", "documentation":"

The file path of the vulnerable package.

" }, "fixedInVersion":{ "shape":"PackageVersion", "documentation":"

The version of the package that contains the vulnerability fix.

" }, "name":{ "shape":"PackageName", "documentation":"

The name of the vulnerable package.

" }, "packageManager":{ "shape":"PackageManager", "documentation":"

The package manager of the vulnerable package.

" }, "release":{ "shape":"PackageRelease", "documentation":"

The release of the vulnerable package.

" }, "sourceLayerHash":{ "shape":"SourceLayerHash", "documentation":"

The source layer hash of the vulnerable package.

" }, "version":{ "shape":"PackageVersion", "documentation":"

The version of the vulnerable package.

" } }, "documentation":"

Information on the vulnerable package identified by a finding.

" }, "VulnerablePackageList":{ "type":"list", "member":{"shape":"VulnerablePackage"} } }, "documentation":"

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2 and Amazon ECR environments.

" }