dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/inspector2/2020-06-08/service-2.json

4347 lines
137 KiB
JSON
Raw Normal View History

New upstream version 1.23.34+repack
2022-01-12 23:38:07 +01:00
{
"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":"<p>Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.</p>"
},
"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":"<p>Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.</p>"
},
"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":"<p>Gets free trial status for multiple Amazon Web Services accounts.</p>"
},
"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":"<p>Cancels the given findings report.</p>"
},
"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":"<p>Creates a filter resource using specified filter criteria.</p>"
},
"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":"<p>Creates a finding report.</p>"
},
"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":"<p>Deletes a filter resource.</p>"
},
"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":"<p>Describe Amazon Inspector configuration settings for an Amazon Web Services organization</p>"
},
"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":"<p>Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.</p>"
},
"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":"<p>Disables the Amazon Inspector delegated administrator for your organization.</p>"
},
"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":"<p>Disassociates a member account from an Amazon Inspector delegated administrator.</p>"
},
"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":"<p>Enables Amazon Inspector scans for one or more Amazon Web Services accounts.</p>"
},
"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":"<p>Enables the Amazon Inspector delegated administrator for your Organizations organization.</p>"
},
"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":"<p>Retrieves information about the Amazon Inspector delegated administrator for your organization.</p>"
},
"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":"<p>Gets the status of a findings report.</p>"
},
"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":"<p>Gets member information for your organization.</p>"
},
"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":"<p>Lists the permissions an account has to configure Amazon Inspector.</p>"
},
"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":"<p>Lists coverage details for you environment.</p>"
},
"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":"<p>Lists Amazon Inspector coverage statistics for your environment.</p>"
},
"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":"<p>Lists information about the Amazon Inspector delegated administrator of your organization.</p>"
},
"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":"<p>Lists the filters associated with your account.</p>"
},
"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":"<p>Lists aggregated finding data for your environment based on specific criteria.</p>"
},
"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":"<p>Lists findings for your environment.</p>"
},
"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":"<p>List members associated with the Amazon Inspector delegated administrator for your organization.</p>"
},
"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":"<p>Lists all tags attached to a given resource.</p>"
},
"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":"<p>Lists the Amazon Inspector usage totals over the last 30 days.</p>"
},
"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":"<p>Adds tags to a resource.</p>",
"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":"<p>Removes tags from a resource.</p>"
},
"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":"<p>Specifies the action that is to be applied to the findings that match the filter.</p>"
},
"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":"<p>Updates the configurations for your Amazon Inspector organization.</p>"
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>You do not have sufficient access to perform this action.</p>",
"error":{
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"Account":{
"type":"structure",
"required":[
"accountId",
"resourceStatus",
"status"
],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the Amazon Web Services account.</p>"
},
"resourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Details of the status of Amazon Inspector scans by resource type.</p>"
},
"status":{
"shape":"Status",
"documentation":"<p>The status of Amazon Inspector for the account.</p>"
}
},
"documentation":"<p>An Amazon Web Services account within your environment that Amazon Inspector has been enabled for.</p>"
},
"AccountAggregation":{
"type":"structure",
"members":{
"findingType":{
"shape":"AggregationFindingType",
"documentation":"<p>The type of finding.</p>"
},
"resourceType":{
"shape":"AggregationResourceType",
"documentation":"<p>The type of resource.</p>"
},
"sortBy":{
"shape":"AccountSortBy",
"documentation":"<p>The value to sort by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The sort order (ascending or descending).</p>"
}
},
"documentation":"<p>An object that contains details about an aggregation response based on Amazon Web Services accounts.</p>"
},
"AccountAggregationResponse":{
"type":"structure",
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>The number of findings by severity.</p>"
}
},
"documentation":"<p>An aggregation of findings by Amazon Web Services account ID.</p>"
},
"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":"<p>The Amazon Web Services account ID.</p>"
},
"resourceState":{
"shape":"ResourceState",
"documentation":"<p>An object detailing which resources Amazon Inspector is enabled to scan for the account.</p>"
},
"state":{
"shape":"State",
"documentation":"<p>An object detailing the status of Amazon Inspector for the account.</p>"
}
},
"documentation":"<p>An object with details the status of an Amazon Web Services account within your Amazon Inspector environment</p>"
},
"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":"<p>An object that contains details about an aggregation request based on Amazon Web Services account IDs.</p>"
},
"amiAggregation":{
"shape":"AmiAggregation",
"documentation":"<p>An object that contains details about an aggregation request based on Amazon Machine Images (AMIs).</p>"
},
"awsEcrContainerAggregation":{
"shape":"AwsEcrContainerAggregation",
"documentation":"<p>An object that contains details about an aggregation request based on Amazon ECR container images.</p>"
},
"ec2InstanceAggregation":{
"shape":"Ec2InstanceAggregation",
"documentation":"<p>An object that contains details about an aggregation request based on Amazon EC2 instances.</p>"
},
"findingTypeAggregation":{
"shape":"FindingTypeAggregation",
"documentation":"<p>An object that contains details about an aggregation request based on finding types.</p>"
},
"imageLayerAggregation":{
"shape":"ImageLayerAggregation",
"documentation":"<p>An object that contains details about an aggregation request based on container image layers.</p>"
},
"packageAggregation":{
"shape":"PackageAggregation",
"documentation":"<p>An object that contains details about an aggregation request based on operating system package type.</p>"
},
"repositoryAggregation":{
"shape":"RepositoryAggregation",
"documentation":"<p>An object that contains details about an aggregation request based on Amazon ECR repositories.</p>"
},
"titleAggregation":{
"shape":"TitleAggregation",
"documentation":"<p>An object that contains details about an aggregation request based on finding title.</p>"
}
},
"documentation":"<p>Contains details about an aggregation request.</p>",
"union":true
},
"AggregationResourceType":{
"type":"string",
"enum":[
"AWS_EC2_INSTANCE",
"AWS_ECR_CONTAINER_IMAGE"
]
},
"AggregationResponse":{
"type":"structure",
"members":{
"accountAggregation":{
"shape":"AccountAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on Amazon Web Services account IDs.</p>"
},
"amiAggregation":{
"shape":"AmiAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on Amazon Machine Images (AMIs).</p>"
},
"awsEcrContainerAggregation":{
"shape":"AwsEcrContainerAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on Amazon ECR container images.</p>"
},
"ec2InstanceAggregation":{
"shape":"Ec2InstanceAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on Amazon EC2 instances.</p>"
},
"findingTypeAggregation":{
"shape":"FindingTypeAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on finding types.</p>"
},
"imageLayerAggregation":{
"shape":"ImageLayerAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on container image layers.</p>"
},
"packageAggregation":{
"shape":"PackageAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on operating system package type.</p>"
},
"repositoryAggregation":{
"shape":"RepositoryAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on Amazon ECR repositories.</p>"
},
"titleAggregation":{
"shape":"TitleAggregationResponse",
"documentation":"<p>An object that contains details about an aggregation response based on finding title.</p>"
}
},
"documentation":"<p>A structure that contains details about the results of an aggregation type.</p>",
"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":"<p>The IDs of AMIs to aggregate findings for.</p>"
},
"sortBy":{
"shape":"AmiSortBy",
"documentation":"<p>The value to sort results by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order to sort results by.</p>"
}
},
"documentation":"<p>The details that define an aggregation based on Amazon machine images (AMIs).</p>"
},
"AmiAggregationResponse":{
"type":"structure",
"required":["ami"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID that the AMI belongs.</p>"
},
"affectedInstances":{
"shape":"Long",
"documentation":"<p>The IDs of Amazon EC2 instances using this AMI.</p>"
},
"ami":{
"shape":"AmiId",
"documentation":"<p>The ID of the AMI that findings were aggregated for.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>An object that contains the count of matched findings per severity.</p>"
}
},
"documentation":"<p>A response that contains the results of a finding aggregation by AMI.</p>"
},
"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":"<p>The Amazon Web Services account ID of the member account to be associated.</p>"
}
}
},
"AssociateMemberResponse":{
"type":"structure",
"required":["accountId"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the successfully associated member account.</p>"
}
}
},
"AutoEnable":{
"type":"structure",
"required":[
"ec2",
"ecr"
],
"members":{
"ec2":{
"shape":"Boolean",
"documentation":"<p>Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.</p>"
},
"ecr":{
"shape":"Boolean",
"documentation":"<p>Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.</p>"
}
},
"documentation":"<p>Represents which scan types are automatically enabled for new members of your Amazon Inspector organization.</p>"
},
"AwsEc2InstanceDetails":{
"type":"structure",
"members":{
"iamInstanceProfileArn":{
"shape":"NonEmptyString",
"documentation":"<p>The IAM instance profile ARN of the Amazon EC2 instance.</p>"
},
"imageId":{
"shape":"NonEmptyString",
"documentation":"<p>The image ID of the Amazon EC2 instance.</p>"
},
"ipV4Addresses":{
"shape":"IpV4AddressList",
"documentation":"<p>The IPv4 addresses of the Amazon EC2 instance.</p>"
},
"ipV6Addresses":{
"shape":"IpV6AddressList",
"documentation":"<p>The IPv6 addresses of the Amazon EC2 instance.</p>"
},
"keyName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the key pair used to launch the Amazon EC2 instance.</p>"
},
"launchedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time the Amazon EC2 instance was launched at.</p>"
},
"platform":{
"shape":"Platform",
"documentation":"<p>The platform of the Amazon EC2 instance.</p>"
},
"subnetId":{
"shape":"NonEmptyString",
"documentation":"<p>The subnet ID of the Amazon EC2 instance.</p>"
},
"type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of the Amazon EC2 instance.</p>"
},
"vpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The VPC ID of the Amazon EC2 instance.</p>"
}
},
"documentation":"<p>Details of the Amazon EC2 instance involved in a finding.</p>"
},
"AwsEcrContainerAggregation":{
"type":"structure",
"members":{
"architectures":{
"shape":"StringFilterList",
"documentation":"<p>The architecture of the containers.</p>"
},
"imageShas":{
"shape":"StringFilterList",
"documentation":"<p>The image SHA values.</p>"
},
"imageTags":{
"shape":"StringFilterList",
"documentation":"<p>The image tags.</p>"
},
"repositories":{
"shape":"StringFilterList",
"documentation":"<p>The container repositories.</p>"
},
"resourceIds":{
"shape":"StringFilterList",
"documentation":"<p>The container resource IDs.</p>"
},
"sortBy":{
"shape":"AwsEcrContainerSortBy",
"documentation":"<p>The value to sort by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The sort order (ascending or descending).</p>"
}
},
"documentation":"<p>An aggregation of information about Amazon ECR containers.</p>"
},
"AwsEcrContainerAggregationResponse":{
"type":"structure",
"required":["resourceId"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the account that owns the container.</p>"
},
"architecture":{
"shape":"String",
"documentation":"<p>The architecture of the container.</p>"
},
"imageSha":{
"shape":"String",
"documentation":"<p>The SHA value of the container image.</p>"
},
"imageTags":{
"shape":"StringList",
"documentation":"<p>The container image stags.</p>"
},
"repository":{
"shape":"String",
"documentation":"<p>The container repository.</p>"
},
"resourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The resource ID of the container.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>The number of finding by severity.</p>"
}
},
"documentation":"<p>An aggregation of information about Amazon ECR containers.</p>"
},
"AwsEcrContainerImageDetails":{
"type":"structure",
"required":[
"imageHash",
"registry",
"repositoryName"
],
"members":{
"architecture":{
"shape":"NonEmptyString",
"documentation":"<p>The architecture of the Amazon ECR container image.</p>"
},
"author":{
"shape":"String",
"documentation":"<p>The image author of the Amazon ECR container image.</p>"
},
"imageHash":{
"shape":"ImageHash",
"documentation":"<p>The image hash of the Amazon ECR container image.</p>"
},
"imageTags":{
"shape":"ImageTagList",
"documentation":"<p>The image tags attached to the Amazon ECR container image.</p>"
},
"platform":{
"shape":"Platform",
"documentation":"<p>The platform of the Amazon ECR container image.</p>"
},
"pushedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time the Amazon ECR container image was pushed.</p>"
},
"registry":{
"shape":"NonEmptyString",
"documentation":"<p>The registry the Amazon ECR container image belongs to.</p>"
},
"repositoryName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the repository the Amazon ECR container image resides in.</p>"
}
},
"documentation":"<p>The image details of the Amazon ECR container image.</p>"
},
"AwsEcrContainerSortBy":{
"type":"string",
"enum":[
"CRITICAL",
"HIGH",
"ALL"
]
},
"BadRequestException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>One or more tags submitted as part of the request is not valid.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"BatchGetAccountStatusRequest":{
"type":"structure",
"members":{
"accountIds":{
"shape":"AccountIdSet",
"documentation":"<p>The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.</p>"
}
}
},
"BatchGetAccountStatusResponse":{
"type":"structure",
"required":["accounts"],
"members":{
"accounts":{
"shape":"AccountStateList",
"documentation":"<p>An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.</p>"
},
"failedAccounts":{
"shape":"FailedAccountList",
"documentation":"<p>An array of objects detailing any accounts that failed to enable Amazon Inspector and why.</p>"
}
}
},
"BatchGetFreeTrialInfoRequest":{
"type":"structure",
"required":["accountIds"],
"members":{
"accountIds":{
"shape":"BatchGetFreeTrialInfoRequestAccountIdsList",
"documentation":"<p>The account IDs to get free trial status for.</p>"
}
}
},
"BatchGetFreeTrialInfoRequestAccountIdsList":{
"type":"list",
"member":{"shape":"MeteringAccountId"},
"max":100,
"min":1
},
"BatchGetFreeTrialInfoResponse":{
"type":"structure",
"required":[
"accounts",
"failedAccounts"
],
"members":{
"accounts":{
"shape":"FreeTrialAccountInfoList",
"documentation":"<p>An array of objects that provide Amazon Inspector free trial details for each of the requested accounts. </p>"
},
"failedAccounts":{
"shape":"FreeTrialInfoErrorList",
"documentation":"<p>An array of objects detailing any accounts that free trial data could not be returned for.</p>"
}
}
},
"Boolean":{
"type":"boolean",
"box":true
},
"CancelFindingsReportRequest":{
"type":"structure",
"required":["reportId"],
"members":{
"reportId":{
"shape":"ReportId",
"documentation":"<p>The ID of the report to be canceled.</p>"
}
}
},
"CancelFindingsReportResponse":{
"type":"structure",
"required":["reportId"],
"members":{
"reportId":{
"shape":"ReportId",
"documentation":"<p>The ID of the canceled report.</p>"
}
}
},
"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":"<p>The ID of the conflicting resource.</p>"
},
"resourceType":{
"shape":"String",
"documentation":"<p>The type of the conflicting resource.</p>"
}
},
"documentation":"<p>A conflict occurred.</p>",
"error":{
"httpStatusCode":409,
"senderFault":true
},
"exception":true
},
"Counts":{
"type":"structure",
"members":{
"count":{
"shape":"AggCounts",
"documentation":"<p>The number of resources.</p>"
},
"groupKey":{
"shape":"GroupKey",
"documentation":"<p>The key associated with this group</p>"
}
},
"documentation":"<p>a structure that contains information on the count of resources within a group.</p>"
},
"CountsList":{
"type":"list",
"member":{"shape":"Counts"},
"max":5,
"min":1
},
"CoverageFilterCriteria":{
"type":"structure",
"members":{
"accountId":{
"shape":"CoverageStringFilterList",
"documentation":"<p>An array of Amazon Web Services account IDs to return coverage statistics for.</p>"
},
"ec2InstanceTags":{
"shape":"CoverageMapFilterList",
"documentation":"<p>The Amazon EC2 instance tags to filter on.</p>"
},
"ecrImageTags":{
"shape":"CoverageStringFilterList",
"documentation":"<p>The Amazon ECR image tags to filter on.</p>"
},
"ecrRepositoryName":{
"shape":"CoverageStringFilterList",
"documentation":"<p>The Amazon ECR repository name to filter on.</p>"
},
"resourceId":{
"shape":"CoverageStringFilterList",
"documentation":"<p>An array of Amazon Web Services resource IDs to return coverage statistics for.</p>"
},
"resourceType":{
"shape":"CoverageStringFilterList",
"documentation":"<p>An array of Amazon Web Services resource types to return coverage statistics for.</p>"
},
"scanStatusCode":{
"shape":"CoverageStringFilterList",
"documentation":"<p>The scan status code to filter on.</p>"
},
"scanStatusReason":{
"shape":"CoverageStringFilterList",
"documentation":"<p>The scan status reason to filter on.</p>"
},
"scanType":{
"shape":"CoverageStringFilterList",
"documentation":"<p>An array of Amazon Inspector scan types to return coverage statistics for.</p>"
}
},
"documentation":"<p>A structure that identifies filter criteria for <code>GetCoverageStatistics</code>.</p>"
},
"CoverageMapComparison":{
"type":"string",
"enum":["EQUALS"]
},
"CoverageMapFilter":{
"type":"structure",
"required":[
"comparison",
"key"
],
"members":{
"comparison":{
"shape":"CoverageMapComparison",
"documentation":"<p>The operator to compare coverage on.</p>"
},
"key":{
"shape":"NonEmptyString",
"documentation":"<p>The tag key associated with the coverage map filter.</p>"
},
"value":{
"shape":"NonEmptyString",
"documentation":"<p>The tag value associated with the coverage map filter.</p>"
}
},
"documentation":"<p>Contains details of a coverage map filter.</p>"
},
"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":"<p>The operator to compare strings on.</p>"
},
"value":{
"shape":"CoverageStringInput",
"documentation":"<p>The value to compare strings on.</p>"
}
},
"documentation":"<p>Contains details of a coverage string filter.</p>"
},
"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":"<p>The Amazon Web Services account ID of the covered resource.</p>"
},
"resourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the covered resource.</p>"
},
"resourceMetadata":{
"shape":"ResourceScanMetadata",
"documentation":"<p>An object that contains details about the metadata.</p>"
},
"resourceType":{
"shape":"CoverageResourceType",
"documentation":"<p>The type of the covered resource.</p>"
},
"scanStatus":{
"shape":"ScanStatus",
"documentation":"<p>The status of the scan covering the resource.</p>"
},
"scanType":{
"shape":"ScanType",
"documentation":"<p>The Amazon Inspector scan type covering the resource.</p>"
}
},
"documentation":"<p>An object that contains details about a resource covered by Amazon Inspector.</p>"
},
"CoveredResources":{
"type":"list",
"member":{"shape":"CoveredResource"}
},
"CreateFilterRequest":{
"type":"structure",
"required":[
"action",
"filterCriteria",
"name"
],
"members":{
"action":{
"shape":"FilterAction",
"documentation":"<p>Defines the action that is to be applied to the findings that match the filter.</p>"
},
"description":{
"shape":"FilterDescription",
"documentation":"<p>A description of the filter.</p>"
},
"filterCriteria":{
"shape":"FilterCriteria",
"documentation":"<p>Defines the criteria to be used in the filter for querying findings.</p>"
},
"name":{
"shape":"FilterName",
"documentation":"<p>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.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A list of tags for the filter.</p>"
}
}
},
"CreateFilterResponse":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"FilterArn",
"documentation":"<p>The Amazon Resource Number (ARN) of the successfully created filter.</p>"
}
}
},
"CreateFindingsReportRequest":{
"type":"structure",
"required":[
"reportFormat",
"s3Destination"
],
"members":{
"filterCriteria":{
"shape":"FilterCriteria",
"documentation":"<p>The filter criteria to apply to the results of the finding report.</p>"
},
"reportFormat":{
"shape":"ReportFormat",
"documentation":"<p>The format to generate the report in.</p>"
},
"s3Destination":{
"shape":"Destination",
"documentation":"<p>The Amazon S3 export destination for the report.</p>"
}
}
},
"CreateFindingsReportResponse":{
"type":"structure",
"members":{
"reportId":{
"shape":"ReportId",
"documentation":"<p>The ID of the report.</p>"
}
}
},
"Currency":{
"type":"string",
"enum":["USD"]
},
"CvssScore":{
"type":"structure",
"required":[
"baseScore",
"scoringVector",
"source",
"version"
],
"members":{
"baseScore":{
"shape":"Double",
"documentation":"<p>The base CVSS score used for the finding.</p>"
},
"scoringVector":{
"shape":"NonEmptyString",
"documentation":"<p>The vector string of the CVSS score.</p>"
},
"source":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the CVSS score.</p>"
},
"version":{
"shape":"NonEmptyString",
"documentation":"<p>The version of CVSS used for the score.</p>"
}
},
"documentation":"<p>The CVSS score for a finding.</p>"
},
"CvssScoreAdjustment":{
"type":"structure",
"required":[
"metric",
"reason"
],
"members":{
"metric":{
"shape":"NonEmptyString",
"documentation":"<p>The metric used to adjust the CVSS score.</p>"
},
"reason":{
"shape":"NonEmptyString",
"documentation":"<p>The reason the CVSS score has been adjustment.</p>"
}
},
"documentation":"<p>Details on adjustments Amazon Inspector made to the CVSS score for a finding.</p>"
},
"CvssScoreAdjustmentList":{
"type":"list",
"member":{"shape":"CvssScoreAdjustment"}
},
"CvssScoreDetails":{
"type":"structure",
"required":[
"score",
"scoreSource",
"scoringVector",
"version"
],
"members":{
"adjustments":{
"shape":"CvssScoreAdjustmentList",
"documentation":"<p>An object that contains details about adjustment Amazon Inspector made to the CVSS score.</p>"
},
"cvssSource":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the CVSS data.</p>"
},
"score":{
"shape":"Double",
"documentation":"<p>The CVSS score.</p>"
},
"scoreSource":{
"shape":"NonEmptyString",
"documentation":"<p>The source for the CVSS score.</p>"
},
"scoringVector":{
"shape":"NonEmptyString",
"documentation":"<p>The vector for the CVSS score.</p>"
},
"version":{
"shape":"NonEmptyString",
"documentation":"<p>The CVSS version used in scoring.</p>"
}
},
"documentation":"<p>Information about the CVSS score.</p>"
},
"CvssScoreList":{
"type":"list",
"member":{"shape":"CvssScore"}
},
"DateFilter":{
"type":"structure",
"members":{
"endInclusive":{
"shape":"Timestamp",
"documentation":"<p>A timestamp representing the end of the time period filtered on.</p>"
},
"startInclusive":{
"shape":"Timestamp",
"documentation":"<p>A timestamp representing the start of the time period filtered on.</p>"
}
},
"documentation":"<p>Contains details on the time range used to filter findings.</p>"
},
"DateFilterList":{
"type":"list",
"member":{"shape":"DateFilter"},
"max":10,
"min":1
},
"DateTimeTimestamp":{"type":"timestamp"},
"DelegatedAdmin":{
"type":"structure",
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.</p>"
},
"relationshipStatus":{
"shape":"RelationshipStatus",
"documentation":"<p>The status of the Amazon Inspector delegated administrator.</p>"
}
},
"documentation":"<p>Details of the Amazon Inspector delegated administrator for your organization.</p>"
},
"DelegatedAdminAccount":{
"type":"structure",
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.</p>"
},
"status":{
"shape":"DelegatedAdminStatus",
"documentation":"<p>The status of the Amazon Inspector delegated administrator.</p>"
}
},
"documentation":"<p>Details of the Amazon Inspector delegated administrator for your organization.</p>"
},
"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":"<p>The Amazon Resource Number (ARN) of the filter to be deleted.</p>"
}
}
},
"DeleteFilterResponse":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"FilterArn",
"documentation":"<p>The Amazon Resource Number (ARN) of the filter that has been deleted.</p>"
}
}
},
"DescribeOrganizationConfigurationRequest":{
"type":"structure",
"members":{
}
},
"DescribeOrganizationConfigurationResponse":{
"type":"structure",
"members":{
"autoEnable":{
"shape":"AutoEnable",
"documentation":"<p>The scan types are automatically enabled for new members of your organization.</p>"
},
"maxAccountLimitReached":{
"shape":"Boolean",
"documentation":"<p>Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.</p>"
}
}
},
"Destination":{
"type":"structure",
"required":[
"bucketName",
"kmsKeyArn"
],
"members":{
"bucketName":{
"shape":"String",
"documentation":"<p>The name of the Amazon S3 bucket to export findings to.</p>"
},
"keyPrefix":{
"shape":"String",
"documentation":"<p>The prefix of the KMS key used to export findings.</p>"
},
"kmsKeyArn":{
"shape":"String",
"documentation":"<p>The ARN of the KMS key used to encrypt data when exporting findings.</p>"
}
},
"documentation":"<p>Contains details of the Amazon S3 bucket and KMS key used to export findings.</p>"
},
"DisableDelegatedAdminAccountRequest":{
"type":"structure",
"required":["delegatedAdminAccountId"],
"members":{
"delegatedAdminAccountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.</p>"
}
}
},
"DisableDelegatedAdminAccountResponse":{
"type":"structure",
"required":["delegatedAdminAccountId"],
"members":{
"delegatedAdminAccountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the successfully disabled delegated administrator.</p>"
}
}
},
"DisableRequest":{
"type":"structure",
"members":{
"accountIds":{
"shape":"AccountIdSet",
"documentation":"<p>An array of account IDs you want to disable Amazon Inspector scans for.</p>"
},
"resourceTypes":{
"shape":"DisableResourceTypeList",
"documentation":"<p>The resource scan types you want to disable.</p>"
}
}
},
"DisableResourceTypeList":{
"type":"list",
"member":{"shape":"ResourceScanType"},
"max":2,
"min":0
},
"DisableResponse":{
"type":"structure",
"required":["accounts"],
"members":{
"accounts":{
"shape":"AccountList",
"documentation":"<p>Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are provided for each account.</p>"
},
"failedAccounts":{
"shape":"FailedAccountList",
"documentation":"<p>Information on any accounts for which Amazon Inspector scans could not be disabled. Details are provided for each account.</p>"
}
}
},
"DisassociateMemberRequest":{
"type":"structure",
"required":["accountId"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the member account to disassociate.</p>"
}
}
},
"DisassociateMemberResponse":{
"type":"structure",
"required":["accountId"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the successfully disassociated member.</p>"
}
}
},
"Double":{
"type":"double",
"box":true
},
"Ec2InstanceAggregation":{
"type":"structure",
"members":{
"amis":{
"shape":"StringFilterList",
"documentation":"<p>The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.</p>"
},
"instanceIds":{
"shape":"StringFilterList",
"documentation":"<p>The Amazon EC2 instance IDs to aggregate findings for.</p>"
},
"instanceTags":{
"shape":"MapFilterList",
"documentation":"<p>The Amazon EC2 instance tags to aggregate findings for.</p>"
},
"operatingSystems":{
"shape":"StringFilterList",
"documentation":"<p>The operating system types to aggregate findings for. Valid values must be uppercase and underscore separated, examples are <code>ORACLE_LINUX_7</code> and <code>ALPINE_LINUX_3_8</code>.</p>"
},
"sortBy":{
"shape":"Ec2InstanceSortBy",
"documentation":"<p>The value to sort results by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order to sort results by.</p>"
}
},
"documentation":"<p>The details that define an aggregation based on Amazon EC2 instances.</p>"
},
"Ec2InstanceAggregationResponse":{
"type":"structure",
"required":["instanceId"],
"members":{
"accountId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services account the Amazon EC2 instance belongs to.</p>"
},
"ami":{
"shape":"AmiId",
"documentation":"<p>The Amazon Machine Image (AMI) of the Amazon EC2 instance.</p>"
},
"instanceId":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon EC2 instance ID.</p>"
},
"instanceTags":{
"shape":"TagMap",
"documentation":"<p>The tags attached to the instance.</p>"
},
"networkFindings":{
"shape":"Long",
"documentation":"<p>The number of network findings for the Amazon EC2 instance.</p>"
},
"operatingSystem":{
"shape":"String",
"documentation":"<p>The operating system of the Amazon EC2 instance.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>An object that contains the count of matched findings per severity.</p>"
}
},
"documentation":"<p>A response that contains the results of a finding aggregation by Amazon EC2 instance.</p>"
},
"Ec2InstanceSortBy":{
"type":"string",
"enum":[
"NETWORK_FINDINGS",
"CRITICAL",
"HIGH",
"ALL"
]
},
"Ec2Metadata":{
"type":"structure",
"members":{
"amiId":{
"shape":"AmiId",
"documentation":"<p>The ID of the Amazon Machine Image (AMI) used to launch the instance.</p>"
},
"platform":{
"shape":"Ec2Platform",
"documentation":"<p>The platform of the instance.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags attached to the instance.</p>"
}
},
"documentation":"<p>Meta data details of an Amazon EC2 instance.</p>"
},
"Ec2Platform":{
"type":"string",
"enum":[
"WINDOWS",
"LINUX",
"UNKNOWN"
]
},
"EcrContainerImageMetadata":{
"type":"structure",
"members":{
"tags":{
"shape":"TagList",
"documentation":"<p>Tags associated with the Amazon ECR image metadata.</p>"
}
},
"documentation":"<p>Information on the Amazon ECR image metadata associated with a finding.</p>"
},
"EcrRepositoryMetadata":{
"type":"structure",
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the Amazon ECR repository.</p>"
},
"scanFrequency":{
"shape":"EcrScanFrequency",
"documentation":"<p>The frequency of scans.</p>"
}
},
"documentation":"<p>Information on the Amazon ECR repository metadata associated with a finding.</p>"
},
"EcrScanFrequency":{
"type":"string",
"enum":[
"MANUAL",
"SCAN_ON_PUSH",
"CONTINUOUS_SCAN"
]
},
"EnableDelegatedAdminAccountRequest":{
"type":"structure",
"required":["delegatedAdminAccountId"],
"members":{
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>The idempotency token for the request.</p>",
"idempotencyToken":true
},
"delegatedAdminAccountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator.</p>"
}
}
},
"EnableDelegatedAdminAccountResponse":{
"type":"structure",
"required":["delegatedAdminAccountId"],
"members":{
"delegatedAdminAccountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.</p>"
}
}
},
"EnableRequest":{
"type":"structure",
"required":["resourceTypes"],
"members":{
"accountIds":{
"shape":"AccountIdSet",
"documentation":"<p>A list of account IDs you want to enable Amazon Inspector scans for.</p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>The idempotency token for the request.</p>",
"idempotencyToken":true
},
"resourceTypes":{
"shape":"EnableResourceTypeList",
"documentation":"<p>The resource scan types you want to enable.</p>"
}
}
},
"EnableResourceTypeList":{
"type":"list",
"member":{"shape":"ResourceScanType"},
"max":2,
"min":1
},
"EnableResponse":{
"type":"structure",
"required":["accounts"],
"members":{
"accounts":{
"shape":"AccountList",
"documentation":"<p>Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are provided for each account.</p>"
},
"failedAccounts":{
"shape":"FailedAccountList",
"documentation":"<p>Information on any accounts for which Amazon Inspector scans could not be enabled. Details are provided for each account.</p>"
}
}
},
"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":"<p>The Amazon Web Services account ID.</p>"
},
"errorCode":{
"shape":"ErrorCode",
"documentation":"<p>The error code explaining why the account failed to enable Amazon Inspector.</p>"
},
"errorMessage":{
"shape":"NonEmptyString",
"documentation":"<p>The error message received when the account failed to enable Amazon Inspector.</p>"
},
"resourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>An object detailing which resources Amazon Inspector is enabled to scan for the account.</p>"
},
"status":{
"shape":"Status",
"documentation":"<p>The status of Amazon Inspector for the account.</p>"
}
},
"documentation":"<p>An object with details on why an account failed to enable Amazon Inspector.</p>"
},
"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":"<p>The action that is to be applied to the findings that match the filter.</p>"
},
"arn":{
"shape":"FilterArn",
"documentation":"<p>The Amazon Resource Number (ARN) associated with this filter.</p>"
},
"createdAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time this filter was created at.</p>"
},
"criteria":{
"shape":"FilterCriteria",
"documentation":"<p>Details on the filter criteria associated with this filter.</p>"
},
"description":{
"shape":"FilterDescription",
"documentation":"<p>A description of the filter.</p>"
},
"name":{
"shape":"FilterName",
"documentation":"<p>The name of the filter.</p>"
},
"ownerId":{
"shape":"OwnerId",
"documentation":"<p>The Amazon Web Services account ID of the account that created the filter.</p>"
},
"reason":{
"shape":"FilterReason",
"documentation":"<p>The reason for the filter.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags attached to the filter.</p>"
},
"updatedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time the filter was last updated at.</p>"
}
},
"documentation":"<p>Details about a filter.</p>"
},
"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":"<p>Details of the Amazon Web Services account IDs used to filter findings.</p>"
},
"componentId":{
"shape":"StringFilterList",
"documentation":"<p>Details of the component IDs used to filter findings.</p>"
},
"componentType":{
"shape":"StringFilterList",
"documentation":"<p>Details of the component types used to filter findings.</p>"
},
"ec2InstanceImageId":{
"shape":"StringFilterList",
"documentation":"<p>Details of the Amazon EC2 instance image IDs used to filter findings.</p>"
},
"ec2InstanceSubnetId":{
"shape":"StringFilterList",
"documentation":"<p>Details of the Amazon EC2 instance subnet IDs used to filter findings.</p>"
},
"ec2InstanceVpcId":{
"shape":"StringFilterList",
"documentation":"<p>Details of the Amazon EC2 instance VPC IDs used to filter findings.</p>"
},
"ecrImageArchitecture":{
"shape":"StringFilterList",
"documentation":"<p>Details of the Amazon ECR image architecture types used to filter findings.</p>"
},
"ecrImageHash":{
"shape":"StringFilterList",
"documentation":"<p>Details of the Amazon ECR image hashes used to filter findings.</p>"
},
"ecrImagePushedAt":{
"shape":"DateFilterList",
"documentation":"<p>Details on the Amazon ECR image push date and time used to filter findings.</p>"
},
"ecrImageRegistry":{
"shape":"StringFilterList",
"documentation":"<p>Details on the Amazon ECR registry used to filter findings.</p>"
},
"ecrImageRepositoryName":{
"shape":"StringFilterList",
"documentation":"<p>Details on the name of the Amazon ECR repository used to filter findings.</p>"
},
"ecrImageTags":{
"shape":"StringFilterList",
"documentation":"<p>The tags attached to the Amazon ECR container image.</p>"
},
"findingArn":{
"shape":"StringFilterList",
"documentation":"<p>Details on the finding ARNs used to filter findings.</p>"
},
"findingStatus":{
"shape":"StringFilterList",
"documentation":"<p>Details on the finding status types used to filter findings.</p>"
},
"findingType":{
"shape":"StringFilterList",
"documentation":"<p>Details on the finding types used to filter findings.</p>"
},
"firstObservedAt":{
"shape":"DateFilterList",
"documentation":"<p>Details on the date and time a finding was first seen used to filter findings.</p>"
},
"inspectorScore":{
"shape":"NumberFilterList",
"documentation":"<p>The Amazon Inspector score to filter on.</p>"
},
"lastObservedAt":{
"shape":"DateFilterList",
"documentation":"<p>Details on the date and time a finding was last seen used to filter findings.</p>"
},
"networkProtocol":{
"shape":"StringFilterList",
"documentation":"<p>Details on the ingress source addresses used to filter findings.</p>"
},
"portRange":{
"shape":"PortRangeFilterList",
"documentation":"<p>Details on the port ranges used to filter findings.</p>"
},
"relatedVulnerabilities":{
"shape":"StringFilterList",
"documentation":"<p>Details on the related vulnerabilities used to filter findings.</p>"
},
"resourceId":{
"shape":"StringFilterList",
"documentation":"<p>Details on the resource IDs used to filter findings.</p>"
},
"resourceTags":{
"shape":"MapFilterList",
"documentation":"<p>Details on the resource tags used to filter findings.</p>"
},
"resourceType":{
"shape":"StringFilterList",
"documentation":"<p>Details on the resource types used to filter findings.</p>"
},
"severity":{
"shape":"StringFilterList",
"documentation":"<p>Details on the severity used to filter findings.</p>"
},
"title":{
"shape":"StringFilterList",
"documentation":"<p>Details on the finding title used to filter findings.</p>"
},
"updatedAt":{
"shape":"DateFilterList",
"documentation":"<p>Details on the date and time a finding was last updated at used to filter findings.</p>"
},
"vendorSeverity":{
"shape":"StringFilterList",
"documentation":"<p>Details on the vendor severity used to filter findings.</p>"
},
"vulnerabilityId":{
"shape":"StringFilterList",
"documentation":"<p>Details on the vulnerability ID used to filter findings.</p>"
},
"vulnerabilitySource":{
"shape":"StringFilterList",
"documentation":"<p>Details on the vulnerability type used to filter findings.</p>"
},
"vulnerablePackages":{
"shape":"PackageFilterList",
"documentation":"<p>Details on the vulnerable packages used to filter findings.</p>"
}
},
"documentation":"<p>Details on the criteria used to define the filter.</p>"
},
"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":"<p>The Amazon Web Services account ID associated with the finding.</p>"
},
"description":{
"shape":"FindingDescription",
"documentation":"<p>The description of the finding.</p>"
},
"findingArn":{
"shape":"FindingArn",
"documentation":"<p>The Amazon Resource Number (ARN) of the finding.</p>"
},
"firstObservedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time that the finding was first observed.</p>"
},
"inspectorScore":{
"shape":"Double",
"documentation":"<p>The Amazon Inspector score given to the finding.</p>"
},
"inspectorScoreDetails":{
"shape":"InspectorScoreDetails",
"documentation":"<p>An object that contains details of the Amazon Inspector score.</p>"
},
"lastObservedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time that the finding was last observed.</p>"
},
"networkReachabilityDetails":{
"shape":"NetworkReachabilityDetails",
"documentation":"<p>An object that contains the details of a network reachability finding.</p>"
},
"packageVulnerabilityDetails":{
"shape":"PackageVulnerabilityDetails",
"documentation":"<p>An object that contains the details of a package vulnerability finding.</p>"
},
"remediation":{
"shape":"Remediation",
"documentation":"<p>An object that contains the details about how to remediate a finding.</p>"
},
"resources":{
"shape":"ResourceList",
"documentation":"<p>Contains information on the resources involved in a finding.</p>"
},
"severity":{
"shape":"Severity",
"documentation":"<p>The severity of the finding.</p>"
},
"status":{
"shape":"FindingStatus",
"documentation":"<p>The status of the finding.</p>"
},
"title":{
"shape":"FindingTitle",
"documentation":"<p>The title of the finding.</p>"
},
"type":{
"shape":"FindingType",
"documentation":"<p>The type of the finding.</p>"
},
"updatedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time the finding was last updated at.</p>"
}
},
"documentation":"<p>Details about an Amazon Inspector finding.</p>"
},
"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":"<p>The finding type to aggregate.</p>"
},
"resourceType":{
"shape":"AggregationResourceType",
"documentation":"<p>The resource type to aggregate.</p>"
},
"sortBy":{
"shape":"FindingTypeSortBy",
"documentation":"<p>The value to sort results by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order to sort results by.</p>"
}
},
"documentation":"<p>The details that define an aggregation based on finding type.</p>"
},
"FindingTypeAggregationResponse":{
"type":"structure",
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the Amazon Web Services account associated with the findings.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>The value to sort results by.</p>"
}
},
"documentation":"<p>A response that contains the results of a finding type aggregation.</p>"
},
"FindingTypeSortBy":{
"type":"string",
"enum":[
"CRITICAL",
"HIGH",
"ALL"
]
},
"FreeTrialAccountInfo":{
"type":"structure",
"required":[
"accountId",
"freeTrialInfo"
],
"members":{
"accountId":{
"shape":"MeteringAccountId",
"documentation":"<p>The account associated with the Amazon Inspector free trial information.</p>"
},
"freeTrialInfo":{
"shape":"FreeTrialInfoList",
"documentation":"<p>Contains information about the Amazon Inspector free trial for an account.</p>"
}
},
"documentation":"<p>Information about the Amazon Inspector free trial for an account.</p>"
},
"FreeTrialAccountInfoList":{
"type":"list",
"member":{"shape":"FreeTrialAccountInfo"}
},
"FreeTrialInfo":{
"type":"structure",
"required":[
"end",
"start",
"status",
"type"
],
"members":{
"end":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the Amazon Inspector free trail ends for a given account.</p>"
},
"start":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the Amazon Inspector free trail started for a given account.</p>"
},
"status":{
"shape":"FreeTrialStatus",
"documentation":"<p>The order to sort results by.</p>"
},
"type":{
"shape":"FreeTrialType",
"documentation":"<p>The type of scan covered by the Amazon Inspector free trail.</p>"
}
},
"documentation":"<p>An object that contains information about the Amazon Inspector free trial for an account.</p>"
},
"FreeTrialInfoError":{
"type":"structure",
"required":[
"accountId",
"code",
"message"
],
"members":{
"accountId":{
"shape":"MeteringAccountId",
"documentation":"<p>The account associated with the Amazon Inspector free trial information.</p>"
},
"code":{
"shape":"FreeTrialInfoErrorCode",
"documentation":"<p>The error code.</p>"
},
"message":{
"shape":"String",
"documentation":"<p>The error message returned.</p>"
}
},
"documentation":"<p>Information about an error received while accessing free trail data for an account.</p>"
},
"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":"<p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator.</p>"
}
}
},
"GetFindingsReportStatusRequest":{
"type":"structure",
"members":{
"reportId":{
"shape":"ReportId",
"documentation":"<p>The ID of the report to retrieve the status of.</p>"
}
}
},
"GetFindingsReportStatusResponse":{
"type":"structure",
"members":{
"destination":{
"shape":"Destination",
"documentation":"<p>The destination of the report.</p>"
},
"errorCode":{
"shape":"ReportingErrorCode",
"documentation":"<p>The error code of the report.</p>"
},
"errorMessage":{
"shape":"ErrorMessage",
"documentation":"<p>The error message of the report.</p>"
},
"filterCriteria":{
"shape":"FilterCriteria",
"documentation":"<p>The filter criteria associated with the report.</p>"
},
"reportId":{
"shape":"ReportId",
"documentation":"<p>The ID of the report.</p>"
},
"status":{
"shape":"ExternalReportStatus",
"documentation":"<p>The status of the report.</p>"
}
}
},
"GetMemberRequest":{
"type":"structure",
"required":["accountId"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the member account to retrieve information on.</p>"
}
}
},
"GetMemberResponse":{
"type":"structure",
"members":{
"member":{
"shape":"Member",
"documentation":"<p>Details of the retrieved member account.</p>"
}
}
},
"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":"<p>The hashes associated with the layers.</p>"
},
"repositories":{
"shape":"StringFilterList",
"documentation":"<p>The repository associated with the container image hosting the layers.</p>"
},
"resourceIds":{
"shape":"StringFilterList",
"documentation":"<p>The ID of the container image layer.</p>"
},
"sortBy":{
"shape":"ImageLayerSortBy",
"documentation":"<p>The value to sort results by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order to sort results by.</p>"
}
},
"documentation":"<p>The details that define an aggregation based on container image layers.</p>"
},
"ImageLayerAggregationResponse":{
"type":"structure",
"required":[
"accountId",
"layerHash",
"repository",
"resourceId"
],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the Amazon Web Services account that owns the container image hosting the layer image.</p>"
},
"layerHash":{
"shape":"NonEmptyString",
"documentation":"<p>The layer hash.</p>"
},
"repository":{
"shape":"NonEmptyString",
"documentation":"<p>The repository the layer resides in.</p>"
},
"resourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The resource ID of the container image layer.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>An object that represents the count of matched findings per severity.</p>"
}
},
"documentation":"<p>A response that contains the results of a finding aggregation by image layer.</p>"
},
"ImageLayerSortBy":{
"type":"string",
"enum":[
"CRITICAL",
"HIGH",
"ALL"
]
},
"ImageTagList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"InspectorScoreDetails":{
"type":"structure",
"members":{
"adjustedCvss":{
"shape":"CvssScoreDetails",
"documentation":"<p>An object that contains details about the CVSS score given to a finding.</p>"
}
},
"documentation":"<p>Information about the Amazon Inspector score given to a finding.</p>"
},
"Integer":{
"type":"integer",
"box":true
},
"InternalServerException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"},
"retryAfterSeconds":{
"shape":"Integer",
"documentation":"<p>The number of seconds to wait before retrying the request.</p>",
"location":"header",
"locationName":"Retry-After"
}
},
"documentation":"<p>The request has failed due to an internal failure of the Amazon Inspector service.</p>",
"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":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
},
"service":{
"shape":"Service",
"documentation":"<p>The service scan type to check permissions for.</p>"
}
}
},
"ListAccountPermissionsResponse":{
"type":"structure",
"required":["permissions"],
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
},
"permissions":{
"shape":"Permissions",
"documentation":"<p>Contains details on the permissions an account has to configure Amazon Inspector.</p>"
}
}
},
"ListCoverageMaxResults":{
"type":"integer",
"box":true,
"max":200,
"min":1
},
"ListCoverageRequest":{
"type":"structure",
"members":{
"filterCriteria":{
"shape":"CoverageFilterCriteria",
"documentation":"<p>An object that contains details on the filters to apply to the coverage data for your environment.</p>"
},
"maxResults":{
"shape":"ListCoverageMaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListCoverageResponse":{
"type":"structure",
"members":{
"coveredResources":{
"shape":"CoveredResources",
"documentation":"<p>An object that contains details on the covered resources in your environment.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListCoverageStatisticsRequest":{
"type":"structure",
"members":{
"filterCriteria":{
"shape":"CoverageFilterCriteria",
"documentation":"<p>An object that contains details on the filters to apply to the coverage data for your environment.</p>"
},
"groupBy":{
"shape":"GroupKey",
"documentation":"<p>The value to group the results by.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListCoverageStatisticsResponse":{
"type":"structure",
"required":["totalCounts"],
"members":{
"countsByGroup":{
"shape":"CountsList",
"documentation":"<p>An array with the number for each group.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
},
"totalCounts":{
"shape":"Long",
"documentation":"<p>The total number for all groups.</p>"
}
}
},
"ListDelegatedAdminAccountsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"ListDelegatedAdminMaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListDelegatedAdminAccountsResponse":{
"type":"structure",
"members":{
"delegatedAdminAccounts":{
"shape":"DelegatedAdminAccountList",
"documentation":"<p>Details of the Amazon Inspector delegated administrator of your organization.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"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":"<p>The action the filter applies to matched findings.</p>"
},
"arns":{
"shape":"FilterArnList",
"documentation":"<p>The Amazon resource number (ARN) of the filter.</p>"
},
"maxResults":{
"shape":"ListFilterMaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListFiltersResponse":{
"type":"structure",
"required":["filters"],
"members":{
"filters":{
"shape":"FilterList",
"documentation":"<p>Contains details on the filters associated with your account.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListFindingAggregationsMaxResults":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListFindingAggregationsRequest":{
"type":"structure",
"required":["aggregationType"],
"members":{
"accountIds":{
"shape":"StringFilterList",
"documentation":"<p>The Amazon Web Services account IDs to retrieve finding aggregation data for.</p>"
},
"aggregationRequest":{
"shape":"AggregationRequest",
"documentation":"<p>Details of the aggregation request that is used to filter your aggregation results.</p>"
},
"aggregationType":{
"shape":"AggregationType",
"documentation":"<p>The type of the aggregation request.</p>"
},
"maxResults":{
"shape":"ListFindingAggregationsMaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListFindingAggregationsResponse":{
"type":"structure",
"required":["aggregationType"],
"members":{
"aggregationType":{
"shape":"AggregationType",
"documentation":"<p>The type of aggregation to perform.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
},
"responses":{
"shape":"AggregationResponseList",
"documentation":"<p>Objects that contain the results of an aggregation operation.</p>"
}
}
},
"ListFindingsMaxResults":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListFindingsRequest":{
"type":"structure",
"members":{
"filterCriteria":{
"shape":"FilterCriteria",
"documentation":"<p>Details on the filters to apply to your finding results.</p>"
},
"maxResults":{
"shape":"ListFindingsMaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
},
"sortCriteria":{
"shape":"SortCriteria",
"documentation":"<p>Details on the sort criteria to apply to your finding results.</p>"
}
}
},
"ListFindingsResponse":{
"type":"structure",
"members":{
"findings":{
"shape":"FindingList",
"documentation":"<p>Contains details on the findings in your environment.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListMembersMaxResults":{
"type":"integer",
"box":true,
"max":50,
"min":1
},
"ListMembersRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"ListMembersMaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
},
"onlyAssociated":{
"shape":"Boolean",
"documentation":"<p>Specifies whether to list only currently associated members if <code>True</code> or to list all members within the organization if <code>False</code>.</p>"
}
}
},
"ListMembersResponse":{
"type":"structure",
"members":{
"members":{
"shape":"MemberList",
"documentation":"<p>An object that contains details for each member account.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon resource number (ARN) of the resource to list tags of.</p>",
"location":"uri",
"locationName":"resourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags associated with the resource.</p>"
}
}
},
"ListUsageTotalsMaxResults":{
"type":"integer",
"box":true,
"max":500,
"min":1
},
"ListUsageTotalsNextToken":{
"type":"string",
"min":1
},
"ListUsageTotalsRequest":{
"type":"structure",
"members":{
"accountIds":{
"shape":"UsageAccountIdList",
"documentation":"<p>The Amazon Web Services account IDs to retrieve usage totals for.</p>"
},
"maxResults":{
"shape":"ListUsageTotalsMaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"ListUsageTotalsNextToken",
"documentation":"<p>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 <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>"
}
}
},
"ListUsageTotalsResponse":{
"type":"structure",
"members":{
"nextToken":{
"shape":"ListUsageTotalsNextToken",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>"
},
"totals":{
"shape":"UsageTotalList",
"documentation":"<p>An object with details on the total usage for the requested account.</p>"
}
}
},
"Long":{
"type":"long",
"box":true
},
"MapComparison":{
"type":"string",
"enum":["EQUALS"]
},
"MapFilter":{
"type":"structure",
"required":[
"comparison",
"key"
],
"members":{
"comparison":{
"shape":"MapComparison",
"documentation":"<p>The operator to use when comparing values in the filter.</p>"
},
"key":{
"shape":"MapKey",
"documentation":"<p>The tag key used in the filter.</p>"
},
"value":{
"shape":"MapValue",
"documentation":"<p>The tag value used in the filter.</p>"
}
},
"documentation":"<p>An object that describes details of a map filter.</p>"
},
"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":"<p>The Amazon Web Services account ID of the member account.</p>"
},
"delegatedAdminAccountId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.</p>"
},
"relationshipStatus":{
"shape":"RelationshipStatus",
"documentation":"<p>The status of the member account.</p>"
},
"updatedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>A timestamp showing when the status of this member was last updated.</p>"
}
},
"documentation":"<p>Details on a member account in your organization.</p>"
},
"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":"<p>The details on the steps in the network path.</p>"
}
},
"documentation":"<p>Information on the network path associated with a finding.</p>"
},
"NetworkProtocol":{
"type":"string",
"enum":[
"TCP",
"UDP"
]
},
"NetworkReachabilityDetails":{
"type":"structure",
"required":[
"networkPath",
"openPortRange",
"protocol"
],
"members":{
"networkPath":{
"shape":"NetworkPath",
"documentation":"<p>An object that contains details about a network path associated with a finding.</p>"
},
"openPortRange":{
"shape":"PortRange",
"documentation":"<p>An object that contains details about the open port range associated with a finding.</p>"
},
"protocol":{
"shape":"NetworkProtocol",
"documentation":"<p>The protocol associated with a finding.</p>"
}
},
"documentation":"<p>Contains the details of a network reachability finding.</p>"
},
"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":"<p>The lowest number to be included in the filter.</p>"
},
"upperInclusive":{
"shape":"Double",
"documentation":"<p>The highest number to be included in the filter.</p>"
}
},
"documentation":"<p>An object that describes the details of a number filter.</p>"
},
"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":"<p>The names of packages to aggregate findings on.</p>"
},
"sortBy":{
"shape":"PackageSortBy",
"documentation":"<p>The value to sort results by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order to sort results by.</p>"
}
},
"documentation":"<p>The details that define an aggregation based on operating system package type.</p>"
},
"PackageAggregationResponse":{
"type":"structure",
"required":["packageName"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the Amazon Web Services account associated with the findings.</p>"
},
"packageName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the operating system package.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>An object that contains the count of matched findings per severity.</p>"
}
},
"documentation":"<p>A response that contains the results of a finding aggregation by image layer.</p>"
},
"PackageArchitecture":{
"type":"string",
"max":64,
"min":1
},
"PackageEpoch":{"type":"integer"},
"PackageFilter":{
"type":"structure",
"members":{
"architecture":{
"shape":"StringFilter",
"documentation":"<p>An object that contains details on the package architecture type to filter on.</p>"
},
"epoch":{
"shape":"NumberFilter",
"documentation":"<p>An object that contains details on the package epoch to filter on.</p>"
},
"name":{
"shape":"StringFilter",
"documentation":"<p>An object that contains details on the name of the package to filter on.</p>"
},
"release":{
"shape":"StringFilter",
"documentation":"<p>An object that contains details on the package release to filter on.</p>"
},
"sourceLayerHash":{
"shape":"StringFilter",
"documentation":"<p>An object that contains details on the source layer hash to filter on.</p>"
},
"version":{
"shape":"StringFilter",
"documentation":"<p>The package version to filter on.</p>"
}
},
"documentation":"<p>Contains information on the details of a package filter.</p>"
},
"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":"<p>An object that contains details about the CVSS score of a finding.</p>"
},
"referenceUrls":{
"shape":"NonEmptyStringList",
"documentation":"<p>One or more URLs that contain details about this vulnerability type.</p>"
},
"relatedVulnerabilities":{
"shape":"VulnerabilityIdList",
"documentation":"<p>One or more vulnerabilities related to the one identified in this finding.</p>"
},
"source":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the vulnerability information.</p>"
},
"sourceUrl":{
"shape":"NonEmptyString",
"documentation":"<p>A URL to the source of the vulnerability information.</p>"
},
"vendorCreatedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time that this vulnerability was first added to the vendor's database.</p>"
},
"vendorSeverity":{
"shape":"NonEmptyString",
"documentation":"<p>The severity the vendor has given to this vulnerability type.</p>"
},
"vendorUpdatedAt":{
"shape":"DateTimeTimestamp",
"documentation":"<p>The date and time the vendor last updated this vulnerability in their database.</p>"
},
"vulnerabilityId":{
"shape":"VulnerabilityId",
"documentation":"<p>The ID given to this vulnerability.</p>"
},
"vulnerablePackages":{
"shape":"VulnerablePackageList",
"documentation":"<p>The packages impacted by this vulnerability.</p>"
}
},
"documentation":"<p>Information about a package vulnerability finding.</p>"
},
"Permission":{
"type":"structure",
"required":[
"operation",
"service"
],
"members":{
"operation":{
"shape":"Operation",
"documentation":"<p>The operations that can be performed with the given permissions.</p>"
},
"service":{
"shape":"Service",
"documentation":"<p>The services that the permissions allow an account to perform the given operations for.</p>"
}
},
"documentation":"<p>Contains information on the permissions an account has within Amazon Inspector.</p>"
},
"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":"<p>The beginning port in a port range.</p>"
},
"end":{
"shape":"Port",
"documentation":"<p>The ending port in a port range.</p>"
}
},
"documentation":"<p>Details about the port range associated with a finding.</p>"
},
"PortRangeFilter":{
"type":"structure",
"members":{
"beginInclusive":{
"shape":"Port",
"documentation":"<p>The port number the port range begins at.</p>"
},
"endInclusive":{
"shape":"Port",
"documentation":"<p>The port number the port range ends at.</p>"
}
},
"documentation":"<p>An object that describes the details of a port range filter.</p>"
},
"PortRangeFilterList":{
"type":"list",
"member":{"shape":"PortRangeFilter"},
"max":10,
"min":1
},
"Recommendation":{
"type":"structure",
"members":{
"Url":{
"shape":"NonEmptyString",
"documentation":"<p>The URL address to the CVE remediation recommendations.</p>"
},
"text":{
"shape":"NonEmptyString",
"documentation":"<p>The recommended course of action to remediate the finding.</p>"
}
},
"documentation":"<p>Details about the recommended course of action to remediate the finding.</p>"
},
"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":"<p>An object that contains information about the recommended course of action to remediate the finding.</p>"
}
},
"documentation":"<p>Information on how to remediate a finding.</p>"
},
"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":"<p>The names of repositories to aggregate findings on.</p>"
},
"sortBy":{
"shape":"RepositorySortBy",
"documentation":"<p>The value to sort results by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order to sort results by.</p>"
}
},
"documentation":"<p>The details that define an aggregation based on repository.</p>"
},
"RepositoryAggregationResponse":{
"type":"structure",
"required":["repository"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the Amazon Web Services account associated with the findings.</p>"
},
"affectedImages":{
"shape":"Long",
"documentation":"<p>The number of container images impacted by the findings.</p>"
},
"repository":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the repository associated with the findings.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>An object that represent the count of matched findings per severity.</p>"
}
},
"documentation":"<p>A response that contains details on the results of a finding aggregation by repository.</p>"
},
"RepositorySortBy":{
"type":"string",
"enum":[
"CRITICAL",
"HIGH",
"ALL",
"AFFECTED_IMAGES"
]
},
"Resource":{
"type":"structure",
"required":[
"id",
"type"
],
"members":{
"details":{
"shape":"ResourceDetails",
"documentation":"<p>An object that contains details about the resource involved in a finding.</p>"
},
"id":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the resource.</p>"
},
"partition":{
"shape":"NonEmptyString",
"documentation":"<p>The partition of the resource.</p>"
},
"region":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Web Services Region the impacted resource is located in.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags attached to the resource.</p>"
},
"type":{
"shape":"ResourceType",
"documentation":"<p>The type of resource.</p>"
}
},
"documentation":"<p>Details about the resource involved in a finding.</p>"
},
"ResourceDetails":{
"type":"structure",
"members":{
"awsEc2Instance":{
"shape":"AwsEc2InstanceDetails",
"documentation":"<p>An object that contains details about the Amazon EC2 instance involved in the finding.</p>"
},
"awsEcrContainerImage":{
"shape":"AwsEcrContainerImageDetails",
"documentation":"<p>An object that contains details about the Amazon ECR container image involved in the finding.</p>"
}
},
"documentation":"<p>Contains details about the resource involved in the finding.</p>"
},
"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":"<p>The operation tried to access an invalid resource. Make sure the resource is specified correctly.</p>",
"error":{
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ResourceScanMetadata":{
"type":"structure",
"members":{
"ec2":{
"shape":"Ec2Metadata",
"documentation":"<p>An object that contains metadata details for an Amazon EC2 instance.</p>"
},
"ecrImage":{
"shape":"EcrContainerImageMetadata",
"documentation":"<p>An object that contains details about the container metadata for an Amazon ECR image.</p>"
},
"ecrRepository":{
"shape":"EcrRepositoryMetadata",
"documentation":"<p>An object that contains details about the repository an Amazon ECR image resides in.</p>"
}
},
"documentation":"<p>An object that contains details about the metadata for an Amazon ECR resource.</p>"
},
"ResourceScanType":{
"type":"string",
"enum":[
"EC2",
"ECR"
]
},
"ResourceState":{
"type":"structure",
"required":[
"ec2",
"ecr"
],
"members":{
"ec2":{
"shape":"State",
"documentation":"<p>An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.</p>"
},
"ecr":{
"shape":"State",
"documentation":"<p>An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.</p>"
}
},
"documentation":"<p>Details the state of Amazon Inspector for each resource type Amazon Inspector scans.</p>"
},
"ResourceStatus":{
"type":"structure",
"required":[
"ec2",
"ecr"
],
"members":{
"ec2":{
"shape":"Status",
"documentation":"<p>The status of Amazon Inspector scanning for Amazon EC2 resources.</p>"
},
"ecr":{
"shape":"Status",
"documentation":"<p>The status of Amazon Inspector scanning for Amazon ECR resources.</p>"
}
},
"documentation":"<p>Details the status of Amazon Inspector for each resource type Amazon Inspector scans.</p>"
},
"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":"<p>The reason for the scan.</p>"
},
"statusCode":{
"shape":"ScanStatusCode",
"documentation":"<p>The status code of the scan.</p>"
}
},
"documentation":"<p>The status of the scan.</p>"
},
"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":"<p>The ID of the resource that exceeds a service quota.</p>"
}
},
"documentation":"<p>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.</p>",
"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":"<p>The total count of findings from all severities.</p>"
},
"critical":{
"shape":"Long",
"documentation":"<p>The total count of critical severity findings.</p>"
},
"high":{
"shape":"Long",
"documentation":"<p>The total count of high severity findings.</p>"
},
"medium":{
"shape":"Long",
"documentation":"<p>The total count of medium severity findings.</p>"
}
},
"documentation":"<p>An object that contains the counts of aggregated finding per severity.</p>"
},
"SortCriteria":{
"type":"structure",
"required":[
"field",
"sortOrder"
],
"members":{
"field":{
"shape":"SortField",
"documentation":"<p>The finding detail field by which results are sorted.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order by which findings are sorted.</p>"
}
},
"documentation":"<p>Details about the criteria used to sort finding results.</p>"
},
"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":"<p>The error code explaining why the account failed to enable Amazon Inspector.</p>"
},
"errorMessage":{
"shape":"NonEmptyString",
"documentation":"<p>The error message received when the account failed to enable Amazon Inspector.</p>"
},
"status":{
"shape":"Status",
"documentation":"<p>The status of Amazon Inspector for the account.</p>"
}
},
"documentation":"<p>An object that described the state of Amazon Inspector scans for an account.</p>"
},
"Status":{
"type":"string",
"enum":[
"ENABLING",
"ENABLED",
"DISABLING",
"DISABLED",
"SUSPENDING",
"SUSPENDED"
]
},
"Step":{
"type":"structure",
"required":[
"componentId",
"componentType"
],
"members":{
"componentId":{
"shape":"Component",
"documentation":"<p>The component ID.</p>"
},
"componentType":{
"shape":"ComponentType",
"documentation":"<p>The component type.</p>"
}
},
"documentation":"<p>Details about the step associated with a finding.</p>"
},
"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":"<p>The operator to use when comparing values in the filter</p>"
},
"value":{
"shape":"StringInput",
"documentation":"<p>The value to filter on.</p>"
}
},
"documentation":"<p>An object that describes the details of a string filter.</p>"
},
"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":"<p>The Amazon Resource Name (ARN) of the resource to apply a tag to.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags to be added to a resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"ThrottlingException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The limit on the number of requests per second was exceeded.</p>",
"error":{
"httpStatusCode":429,
"senderFault":true
},
"exception":true
},
"Timestamp":{"type":"timestamp"},
"TitleAggregation":{
"type":"structure",
"members":{
"resourceType":{
"shape":"AggregationResourceType",
"documentation":"<p>The resource type to aggregate on.</p>"
},
"sortBy":{
"shape":"TitleSortBy",
"documentation":"<p>The value to sort results by.</p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order to sort results by.</p>"
},
"titles":{
"shape":"StringFilterList",
"documentation":"<p>The finding titles to aggregate on.</p>"
},
"vulnerabilityIds":{
"shape":"StringFilterList",
"documentation":"<p>The vulnerability IDs of the findings.</p>"
}
},
"documentation":"<p>The details that define an aggregation based on finding title.</p>"
},
"TitleAggregationResponse":{
"type":"structure",
"required":["title"],
"members":{
"accountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the Amazon Web Services account associated with the findings.</p>"
},
"severityCounts":{
"shape":"SeverityCounts",
"documentation":"<p>An object that represent the count of matched findings per severity.</p>"
},
"title":{
"shape":"NonEmptyString",
"documentation":"<p>The title that the findings were aggregated on.</p>"
},
"vulnerabilityId":{
"shape":"String",
"documentation":"<p>The vulnerability ID of the finding.</p>"
}
},
"documentation":"<p>A response that contains details on the results of a finding aggregation by title.</p>"
},
"TitleSortBy":{
"type":"string",
"enum":[
"CRITICAL",
"HIGH",
"ALL"
]
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the resource to remove tags from.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys to remove from the resource.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateFilterRequest":{
"type":"structure",
"required":["filterArn"],
"members":{
"action":{
"shape":"FilterAction",
"documentation":"<p>Specifies the action that is to be applied to the findings that match the filter.</p>"
},
"description":{
"shape":"FilterDescription",
"documentation":"<p>A description of the filter.</p>"
},
"filterArn":{
"shape":"FilterArn",
"documentation":"<p>The Amazon Resource Number (ARN) of the filter to update.</p>"
},
"filterCriteria":{
"shape":"FilterCriteria",
"documentation":"<p>Defines the criteria to be update in the filter.</p>"
},
"name":{
"shape":"FilterName",
"documentation":"<p>The name of the filter.</p>"
}
}
},
"UpdateFilterResponse":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"FilterArn",
"documentation":"<p>The Amazon Resource Number (ARN) of the successfully updated filter.</p>"
}
}
},
"UpdateOrganizationConfigurationRequest":{
"type":"structure",
"required":["autoEnable"],
"members":{
"autoEnable":{
"shape":"AutoEnable",
"documentation":"<p>Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.</p>"
}
}
},
"UpdateOrganizationConfigurationResponse":{
"type":"structure",
"required":["autoEnable"],
"members":{
"autoEnable":{
"shape":"AutoEnable",
"documentation":"<p>The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.</p>"
}
}
},
"Usage":{
"type":"structure",
"members":{
"currency":{
"shape":"Currency",
"documentation":"<p>The currency type used when calculating usage data.</p>"
},
"estimatedMonthlyCost":{
"shape":"MonthlyCostEstimate",
"documentation":"<p>The estimated monthly cost of Amazon Inspector.</p>"
},
"total":{
"shape":"UsageValue",
"documentation":"<p>The total of usage.</p>"
},
"type":{
"shape":"UsageType",
"documentation":"<p>The type scan.</p>"
}
},
"documentation":"<p>Contains usage information about the cost of Amazon Inspector operation.</p>"
},
"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":"<p>The account ID of the account that usage data was retrieved for.</p>"
},
"usage":{
"shape":"UsageList",
"documentation":"<p>An object representing the total usage for an account.</p>"
}
},
"documentation":"<p>The total of usage for an account ID.</p>"
},
"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":"<p>The fields that failed validation.</p>"
},
"message":{"shape":"String"},
"reason":{
"shape":"ValidationExceptionReason",
"documentation":"<p>The reason for the validation failure.</p>"
}
},
"documentation":"<p>The request has failed validation due to missing required fields or having invalid inputs.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ValidationExceptionField":{
"type":"structure",
"required":[
"message",
"name"
],
"members":{
"message":{
"shape":"String",
"documentation":"<p>The validation exception message.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>The name of the validation exception.</p>"
}
},
"documentation":"<p>An object that describes a validation exception.</p>"
},
"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":"<p>The architecture of the vulnerable package.</p>"
},
"epoch":{
"shape":"PackageEpoch",
"documentation":"<p>The epoch of the vulnerable package.</p>"
},
"filePath":{
"shape":"FilePath",
"documentation":"<p>The file path of the vulnerable package.</p>"
},
"fixedInVersion":{
"shape":"PackageVersion",
"documentation":"<p>The version of the package that contains the vulnerability fix.</p>"
},
"name":{
"shape":"PackageName",
"documentation":"<p>The name of the vulnerable package.</p>"
},
"packageManager":{
"shape":"PackageManager",
"documentation":"<p>The package manager of the vulnerable package.</p>"
},
"release":{
"shape":"PackageRelease",
"documentation":"<p>The release of the vulnerable package.</p>"
},
"sourceLayerHash":{
"shape":"SourceLayerHash",
"documentation":"<p>The source layer hash of the vulnerable package.</p>"
},
"version":{
"shape":"PackageVersion",
"documentation":"<p>The version of the vulnerable package.</p>"
}
},
"documentation":"<p>Information on the vulnerable package identified by a finding.</p>"
},
"VulnerablePackageList":{
"type":"list",
"member":{"shape":"VulnerablePackage"}
}
},
"documentation":"<p>Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2 and Amazon ECR environments.</p>"
}
Reference in a new issue Copy permalink