dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/securityhub/2018-10-26/service-2.json
Noah Meyerhans e34454e86c New upstream version 1.20.35+repack
2021-03-23 16:16:10 -07:00

9740 lines
436 KiB
JSON
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"version":"2.0",
"metadata":{
"apiVersion":"2018-10-26",
"endpointPrefix":"securityhub",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS SecurityHub",
"serviceId":"SecurityHub",
"signatureVersion":"v4",
"signingName":"securityhub",
"uid":"securityhub-2018-10-26"
},
"operations":{
"AcceptInvitation":{
"name":"AcceptInvitation",
"http":{
"method":"POST",
"requestUri":"/master"
},
"input":{"shape":"AcceptInvitationRequest"},
"output":{"shape":"AcceptInvitationResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from.</p> <p>This operation is only used by member accounts that are not added through Organizations.</p> <p>When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.</p>"
},
"BatchDisableStandards":{
"name":"BatchDisableStandards",
"http":{
"method":"POST",
"requestUri":"/standards/deregister"
},
"input":{"shape":"BatchDisableStandardsRequest"},
"output":{"shape":"BatchDisableStandardsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Disables the standards specified by the provided <code>StandardsSubscriptionArns</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Security Standards</a> section of the <i>AWS Security Hub User Guide</i>.</p>"
},
"BatchEnableStandards":{
"name":"BatchEnableStandards",
"http":{
"method":"POST",
"requestUri":"/standards/register"
},
"input":{"shape":"BatchEnableStandardsRequest"},
"output":{"shape":"BatchEnableStandardsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Enables the standards specified by the provided <code>StandardsArn</code>. To obtain the ARN for a standard, use the <code> <a>DescribeStandards</a> </code> operation.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Security Standards</a> section of the <i>AWS Security Hub User Guide</i>.</p>"
},
"BatchImportFindings":{
"name":"BatchImportFindings",
"http":{
"method":"POST",
"requestUri":"/findings/import"
},
"input":{"shape":"BatchImportFindingsRequest"},
"output":{"shape":"BatchImportFindingsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Imports security findings generated from an integrated product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.</p> <p>The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.</p> <p>After a finding is created, <code>BatchImportFindings</code> cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.</p> <ul> <li> <p> <code>Note</code> </p> </li> <li> <p> <code>UserDefinedFields</code> </p> </li> <li> <p> <code>VerificationState</code> </p> </li> <li> <p> <code>Workflow</code> </p> </li> </ul> <p>Finding providers also should not use <code>BatchImportFindings</code> to update the following attributes.</p> <ul> <li> <p> <code>Confidence</code> </p> </li> <li> <p> <code>Criticality</code> </p> </li> <li> <p> <code>RelatedFindings</code> </p> </li> <li> <p> <code>Severity</code> </p> </li> <li> <p> <code>Types</code> </p> </li> </ul> <p>Instead, finding providers use <code>FindingProviderFields</code> to provide values for these attributes.</p>"
},
"BatchUpdateFindings":{
"name":"BatchUpdateFindings",
"http":{
"method":"PATCH",
"requestUri":"/findings/batchupdate"
},
"input":{"shape":"BatchUpdateFindingsRequest"},
"output":{"shape":"BatchUpdateFindingsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Used by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.</p> <p>Updates from <code>BatchUpdateFindings</code> do not affect the value of <code>UpdatedAt</code> for a finding.</p> <p>Master and member accounts can use <code>BatchUpdateFindings</code> to update the following finding fields and objects.</p> <ul> <li> <p> <code>Confidence</code> </p> </li> <li> <p> <code>Criticality</code> </p> </li> <li> <p> <code>Note</code> </p> </li> <li> <p> <code>RelatedFindings</code> </p> </li> <li> <p> <code>Severity</code> </p> </li> <li> <p> <code>Types</code> </p> </li> <li> <p> <code>UserDefinedFields</code> </p> </li> <li> <p> <code>VerificationState</code> </p> </li> <li> <p> <code>Workflow</code> </p> </li> </ul> <p>You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access\">Configuring access to BatchUpdateFindings</a> in the <i>AWS Security Hub User Guide</i>.</p>"
},
"CreateActionTarget":{
"name":"CreateActionTarget",
"http":{
"method":"POST",
"requestUri":"/actionTargets"
},
"input":{"shape":"CreateActionTargetRequest"},
"output":{"shape":"CreateActionTargetResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>Creates a custom action target in Security Hub.</p> <p>You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.</p>"
},
"CreateInsight":{
"name":"CreateInsight",
"http":{
"method":"POST",
"requestUri":"/insights"
},
"input":{"shape":"CreateInsightRequest"},
"output":{"shape":"CreateInsightResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.</p> <p>To group the related findings in the insight, use the <code>GroupByAttribute</code>.</p>"
},
"CreateMembers":{
"name":"CreateMembers",
"http":{
"method":"POST",
"requestUri":"/members"
},
"input":{"shape":"CreateMembersRequest"},
"output":{"shape":"CreateMembersResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. If you are integrated with Organizations, then the master account is the Security Hub administrator account that is designated by the organization management account.</p> <p> <code>CreateMembers</code> is always used to add accounts that are not organization members.</p> <p>For accounts that are part of an organization, <code>CreateMembers</code> is only used in the following cases:</p> <ul> <li> <p>Security Hub is not configured to automatically add new accounts in an organization.</p> </li> <li> <p>The account was disassociated or deleted in Security Hub.</p> </li> </ul> <p>This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the <code> <a>EnableSecurityHub</a> </code> operation.</p> <p>For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the <code> <a>InviteMembers</a> </code> operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.</p> <p>Accounts that are part of an organization do not receive an invitation. They automatically become a member account in Security Hub.</p> <p>A permissions policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in a member account, findings are sent to both the member and master accounts. </p> <p>To remove the association between the master and member accounts, use the <code> <a>DisassociateFromMasterAccount</a> </code> or <code> <a>DisassociateMembers</a> </code> operation.</p>"
},
"DeclineInvitations":{
"name":"DeclineInvitations",
"http":{
"method":"POST",
"requestUri":"/invitations/decline"
},
"input":{"shape":"DeclineInvitationsRequest"},
"output":{"shape":"DeclineInvitationsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Declines invitations to become a member account.</p> <p>This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.</p>"
},
"DeleteActionTarget":{
"name":"DeleteActionTarget",
"http":{
"method":"DELETE",
"requestUri":"/actionTargets/{ActionTargetArn+}"
},
"input":{"shape":"DeleteActionTargetRequest"},
"output":{"shape":"DeleteActionTargetResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes a custom action target from Security Hub.</p> <p>Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.</p>"
},
"DeleteInsight":{
"name":"DeleteInsight",
"http":{
"method":"DELETE",
"requestUri":"/insights/{InsightArn+}"
},
"input":{"shape":"DeleteInsightRequest"},
"output":{"shape":"DeleteInsightResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the insight specified by the <code>InsightArn</code>.</p>"
},
"DeleteInvitations":{
"name":"DeleteInvitations",
"http":{
"method":"POST",
"requestUri":"/invitations/delete"
},
"input":{"shape":"DeleteInvitationsRequest"},
"output":{"shape":"DeleteInvitationsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Deletes invitations received by the AWS account to become a member account.</p> <p>This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.</p>"
},
"DeleteMembers":{
"name":"DeleteMembers",
"http":{
"method":"POST",
"requestUri":"/members/delete"
},
"input":{"shape":"DeleteMembersRequest"},
"output":{"shape":"DeleteMembersResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the specified member accounts from Security Hub.</p> <p>Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.</p>"
},
"DescribeActionTargets":{
"name":"DescribeActionTargets",
"http":{
"method":"POST",
"requestUri":"/actionTargets/get"
},
"input":{"shape":"DescribeActionTargetsRequest"},
"output":{"shape":"DescribeActionTargetsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns a list of the custom action targets in Security Hub in your account.</p>"
},
"DescribeHub":{
"name":"DescribeHub",
"http":{
"method":"GET",
"requestUri":"/accounts"
},
"input":{"shape":"DescribeHubRequest"},
"output":{"shape":"DescribeHubResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns details about the Hub resource in your account, including the <code>HubArn</code> and the time when you enabled Security Hub.</p>"
},
"DescribeOrganizationConfiguration":{
"name":"DescribeOrganizationConfiguration",
"http":{
"method":"GET",
"requestUri":"/organization/configuration"
},
"input":{"shape":"DescribeOrganizationConfigurationRequest"},
"output":{"shape":"DescribeOrganizationConfigurationResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.</p>"
},
"DescribeProducts":{
"name":"DescribeProducts",
"http":{
"method":"GET",
"requestUri":"/products"
},
"input":{"shape":"DescribeProductsRequest"},
"output":{"shape":"DescribeProductsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns information about product integrations in Security Hub.</p> <p>You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.</p> <p>If you do not provide an integration ARN, then the results include all of the available product integrations. </p>"
},
"DescribeStandards":{
"name":"DescribeStandards",
"http":{
"method":"GET",
"requestUri":"/standards"
},
"input":{"shape":"DescribeStandardsRequest"},
"output":{"shape":"DescribeStandardsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Returns a list of the available standards in Security Hub.</p> <p>For each standard, the results include the standard ARN, the name, and a description. </p>"
},
"DescribeStandardsControls":{
"name":"DescribeStandardsControls",
"http":{
"method":"GET",
"requestUri":"/standards/controls/{StandardsSubscriptionArn+}"
},
"input":{"shape":"DescribeStandardsControlsRequest"},
"output":{"shape":"DescribeStandardsControlsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns a list of security standards controls.</p> <p>For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.</p>"
},
"DisableImportFindingsForProduct":{
"name":"DisableImportFindingsForProduct",
"http":{
"method":"DELETE",
"requestUri":"/productSubscriptions/{ProductSubscriptionArn+}"
},
"input":{"shape":"DisableImportFindingsForProductRequest"},
"output":{"shape":"DisableImportFindingsForProductResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.</p>"
},
"DisableOrganizationAdminAccount":{
"name":"DisableOrganizationAdminAccount",
"http":{
"method":"POST",
"requestUri":"/organization/admin/disable"
},
"input":{"shape":"DisableOrganizationAdminAccountRequest"},
"output":{"shape":"DisableOrganizationAdminAccountResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Disables a Security Hub administrator account. Can only be called by the organization management account.</p>"
},
"DisableSecurityHub":{
"name":"DisableSecurityHub",
"http":{
"method":"DELETE",
"requestUri":"/accounts"
},
"input":{"shape":"DisableSecurityHubRequest"},
"output":{"shape":"DisableSecurityHubResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.</p> <p>When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts.</p> <p>When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed.</p> <p>If you want to save your existing findings, you must export them before you disable Security Hub.</p>"
},
"DisassociateFromMasterAccount":{
"name":"DisassociateFromMasterAccount",
"http":{
"method":"POST",
"requestUri":"/master/disassociate"
},
"input":{"shape":"DisassociateFromMasterAccountRequest"},
"output":{"shape":"DisassociateFromMasterAccountResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disassociates the current Security Hub member account from the associated master account.</p> <p>This operation is only used by accounts that are not part of an organization. For organization accounts, only the master account (the designated Security Hub administrator) can disassociate a member account.</p>"
},
"DisassociateMembers":{
"name":"DisassociateMembers",
"http":{
"method":"POST",
"requestUri":"/members/disassociate"
},
"input":{"shape":"DisassociateMembersRequest"},
"output":{"shape":"DisassociateMembersResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disassociates the specified member accounts from the associated master account.</p> <p>Can be used to disassociate both accounts that are in an organization and accounts that were invited manually.</p>"
},
"EnableImportFindingsForProduct":{
"name":"EnableImportFindingsForProduct",
"http":{
"method":"POST",
"requestUri":"/productSubscriptions"
},
"input":{"shape":"EnableImportFindingsForProductRequest"},
"output":{"shape":"EnableImportFindingsForProductResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceConflictException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub.</p> <p>When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.</p>"
},
"EnableOrganizationAdminAccount":{
"name":"EnableOrganizationAdminAccount",
"http":{
"method":"POST",
"requestUri":"/organization/admin/enable"
},
"input":{"shape":"EnableOrganizationAdminAccountRequest"},
"output":{"shape":"EnableOrganizationAdminAccountResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.</p>"
},
"EnableSecurityHub":{
"name":"EnableSecurityHub",
"http":{
"method":"POST",
"requestUri":"/accounts"
},
"input":{"shape":"EnableSecurityHubRequest"},
"output":{"shape":"EnableSecurityHubResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceConflictException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Enables Security Hub for your account in the current Region or the Region you specify in the request.</p> <p>When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.</p> <p>When you use the <code>EnableSecurityHub</code> operation to enable Security Hub, you also automatically enable the following standards.</p> <ul> <li> <p>CIS AWS Foundations</p> </li> <li> <p>AWS Foundational Security Best Practices</p> </li> </ul> <p>You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. </p> <p>To not enable the automatically enabled standards, set <code>EnableDefaultStandards</code> to <code>false</code>.</p> <p>After you enable Security Hub, to enable a standard, use the <code> <a>BatchEnableStandards</a> </code> operation. To disable a standard, use the <code> <a>BatchDisableStandards</a> </code> operation.</p> <p>To learn more, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html\">Setting Up AWS Security Hub</a> in the <i>AWS Security Hub User Guide</i>.</p>"
},
"GetEnabledStandards":{
"name":"GetEnabledStandards",
"http":{
"method":"POST",
"requestUri":"/standards/get"
},
"input":{"shape":"GetEnabledStandardsRequest"},
"output":{"shape":"GetEnabledStandardsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Returns a list of the standards that are currently enabled.</p>"
},
"GetFindings":{
"name":"GetFindings",
"http":{
"method":"POST",
"requestUri":"/findings"
},
"input":{"shape":"GetFindingsRequest"},
"output":{"shape":"GetFindingsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Returns a list of findings that match the specified criteria.</p>"
},
"GetInsightResults":{
"name":"GetInsightResults",
"http":{
"method":"GET",
"requestUri":"/insights/results/{InsightArn+}"
},
"input":{"shape":"GetInsightResultsRequest"},
"output":{"shape":"GetInsightResultsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the results of the Security Hub insight specified by the insight ARN.</p>"
},
"GetInsights":{
"name":"GetInsights",
"http":{
"method":"POST",
"requestUri":"/insights/get"
},
"input":{"shape":"GetInsightsRequest"},
"output":{"shape":"GetInsightsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists and describes insights for the specified insight ARNs.</p>"
},
"GetInvitationsCount":{
"name":"GetInvitationsCount",
"http":{
"method":"GET",
"requestUri":"/invitations/count"
},
"input":{"shape":"GetInvitationsCountRequest"},
"output":{"shape":"GetInvitationsCountResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation. </p>"
},
"GetMasterAccount":{
"name":"GetMasterAccount",
"http":{
"method":"GET",
"requestUri":"/master"
},
"input":{"shape":"GetMasterAccountRequest"},
"output":{"shape":"GetMasterAccountResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Provides the details for the Security Hub master account for the current member account.</p> <p>Can be used by both member accounts that are in an organization and accounts that were invited manually.</p>"
},
"GetMembers":{
"name":"GetMembers",
"http":{
"method":"POST",
"requestUri":"/members/get"
},
"input":{"shape":"GetMembersRequest"},
"output":{"shape":"GetMembersResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns the details for the Security Hub member accounts for the specified account IDs.</p> <p>A master account can be either a delegated Security Hub administrator account for an organization or a master account that enabled Security Hub manually.</p> <p>The results include both member accounts that are in an organization and accounts that were invited manually.</p>"
},
"InviteMembers":{
"name":"InviteMembers",
"http":{
"method":"POST",
"requestUri":"/members/invite"
},
"input":{"shape":"InviteMembersRequest"},
"output":{"shape":"InviteMembersResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.</p> <p>This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.</p> <p>Before you can use this action to invite a member, you must first use the <code> <a>CreateMembers</a> </code> action to create the member account in Security Hub.</p> <p>When the account owner enables Security Hub and accepts the invitation to become a member account, the master account can view the findings generated from the member account.</p>"
},
"ListEnabledProductsForImport":{
"name":"ListEnabledProductsForImport",
"http":{
"method":"GET",
"requestUri":"/productSubscriptions"
},
"input":{"shape":"ListEnabledProductsForImportRequest"},
"output":{"shape":"ListEnabledProductsForImportResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.</p>"
},
"ListInvitations":{
"name":"ListInvitations",
"http":{
"method":"GET",
"requestUri":"/invitations"
},
"input":{"shape":"ListInvitationsRequest"},
"output":{"shape":"ListInvitationsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Lists all Security Hub membership invitations that were sent to the current AWS account.</p> <p>This operation is only used by accounts that do not belong to an organization. Organization accounts do not receive invitations.</p>"
},
"ListMembers":{
"name":"ListMembers",
"http":{
"method":"GET",
"requestUri":"/members"
},
"input":{"shape":"ListMembersRequest"},
"output":{"shape":"ListMembersResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Lists details about all member accounts for the current Security Hub master account.</p> <p>The results include both member accounts that belong to an organization and member accounts that were invited manually.</p>"
},
"ListOrganizationAdminAccounts":{
"name":"ListOrganizationAdminAccounts",
"http":{
"method":"GET",
"requestUri":"/organization/admin"
},
"input":{"shape":"ListOrganizationAdminAccountsRequest"},
"output":{"shape":"ListOrganizationAdminAccountsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Lists the Security Hub administrator accounts. Can only be called by the organization management account.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{ResourceArn}"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns a list of tags associated with a resource.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{ResourceArn}"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds one or more tags to a resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{ResourceArn}"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Removes one or more tags from a resource.</p>"
},
"UpdateActionTarget":{
"name":"UpdateActionTarget",
"http":{
"method":"PATCH",
"requestUri":"/actionTargets/{ActionTargetArn+}"
},
"input":{"shape":"UpdateActionTargetRequest"},
"output":{"shape":"UpdateActionTargetResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates the name and description of a custom action target in Security Hub.</p>"
},
"UpdateFindings":{
"name":"UpdateFindings",
"http":{
"method":"PATCH",
"requestUri":"/findings"
},
"input":{"shape":"UpdateFindingsRequest"},
"output":{"shape":"UpdateFindingsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p> <code>UpdateFindings</code> is deprecated. Instead of <code>UpdateFindings</code>, use <code>BatchUpdateFindings</code>.</p> <p>Updates the <code>Note</code> and <code>RecordState</code> of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.</p>"
},
"UpdateInsight":{
"name":"UpdateInsight",
"http":{
"method":"PATCH",
"requestUri":"/insights/{InsightArn+}"
},
"input":{"shape":"UpdateInsightRequest"},
"output":{"shape":"UpdateInsightResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates the Security Hub insight identified by the specified insight ARN.</p>"
},
"UpdateOrganizationConfiguration":{
"name":"UpdateOrganizationConfiguration",
"http":{
"method":"POST",
"requestUri":"/organization/configuration"
},
"input":{"shape":"UpdateOrganizationConfigurationRequest"},
"output":{"shape":"UpdateOrganizationConfigurationResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.</p>"
},
"UpdateSecurityHubConfiguration":{
"name":"UpdateSecurityHubConfiguration",
"http":{
"method":"PATCH",
"requestUri":"/accounts"
},
"input":{"shape":"UpdateSecurityHubConfigurationRequest"},
"output":{"shape":"UpdateSecurityHubConfigurationResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates configuration options for Security Hub.</p>"
},
"UpdateStandardsControl":{
"name":"UpdateStandardsControl",
"http":{
"method":"PATCH",
"requestUri":"/standards/control/{StandardsControlArn+}"
},
"input":{"shape":"UpdateStandardsControlRequest"},
"output":{"shape":"UpdateStandardsControlResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Used to control whether an individual security standard control is enabled or disabled.</p>"
}
},
"shapes":{
"AcceptInvitationRequest":{
"type":"structure",
"required":[
"MasterId",
"InvitationId"
],
"members":{
"MasterId":{
"shape":"NonEmptyString",
"documentation":"<p>The account ID of the Security Hub master account that sent the invitation.</p>"
},
"InvitationId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the invitation sent from the Security Hub master account.</p>"
}
}
},
"AcceptInvitationResponse":{
"type":"structure",
"members":{
}
},
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"NonEmptyString"},
"Code":{"shape":"NonEmptyString"}
},
"documentation":"<p>You don't have permission to perform the action specified in the request.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"AccountDetails":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The ID of an AWS account.</p>"
},
"Email":{
"shape":"NonEmptyString",
"documentation":"<p>The email of an AWS account.</p>"
}
},
"documentation":"<p>The details of an AWS account.</p>"
},
"AccountDetailsList":{
"type":"list",
"member":{"shape":"AccountDetails"}
},
"AccountId":{"type":"string"},
"AccountIdList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"Action":{
"type":"structure",
"members":{
"ActionType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of action that was detected. The possible action types are:</p> <ul> <li> <p> <code>NETWORK_CONNECTION</code> </p> </li> <li> <p> <code>AWS_API_CALL</code> </p> </li> <li> <p> <code>DNS_REQUEST</code> </p> </li> <li> <p> <code>PORT_PROBE</code> </p> </li> </ul>"
},
"NetworkConnectionAction":{
"shape":"NetworkConnectionAction",
"documentation":"<p>Included if <code>ActionType</code> is <code>NETWORK_CONNECTION</code>. Provides details about the network connection that was detected.</p>"
},
"AwsApiCallAction":{
"shape":"AwsApiCallAction",
"documentation":"<p>Included if <code>ActionType</code> is <code>AWS_API_CALL</code>. Provides details about the API call that was detected. </p>"
},
"DnsRequestAction":{
"shape":"DnsRequestAction",
"documentation":"<p>Included if <code>ActionType</code> is <code>DNS_REQUEST</code>. Provides details about the DNS request that was detected. </p>"
},
"PortProbeAction":{
"shape":"PortProbeAction",
"documentation":"<p>Included if <code>ActionType</code> is <code>PORT_PROBE</code>. Provides details about the port probe that was detected. </p>"
}
},
"documentation":"<p>Provides details about one of the following actions that affects or that was taken on a resource:</p> <ul> <li> <p>A remote IP address issued an AWS API call</p> </li> <li> <p>A DNS request was received</p> </li> <li> <p>A remote IP address attempted to connect to an EC2 instance</p> </li> <li> <p>A remote IP address attempted a port probe on an EC2 instance</p> </li> </ul>"
},
"ActionLocalIpDetails":{
"type":"structure",
"members":{
"IpAddressV4":{
"shape":"NonEmptyString",
"documentation":"<p>The IP address.</p>"
}
},
"documentation":"<p>Provides information about the IP address where the scanned port is located.</p>"
},
"ActionLocalPortDetails":{
"type":"structure",
"members":{
"Port":{
"shape":"Integer",
"documentation":"<p>The number of the port.</p>"
},
"PortName":{
"shape":"NonEmptyString",
"documentation":"<p>The port name of the local connection.</p>"
}
},
"documentation":"<p>For <code>NetworkConnectionAction</code> and <code>PortProbeDetails</code>, <code>LocalPortDetails</code> provides information about the local port that was involved in the action.</p>"
},
"ActionRemoteIpDetails":{
"type":"structure",
"members":{
"IpAddressV4":{
"shape":"NonEmptyString",
"documentation":"<p>The IP address.</p>"
},
"Organization":{
"shape":"IpOrganizationDetails",
"documentation":"<p>The internet service provider (ISP) organization associated with the remote IP address.</p>"
},
"Country":{
"shape":"Country",
"documentation":"<p>The country where the remote IP address is located.</p>"
},
"City":{
"shape":"City",
"documentation":"<p>The city where the remote IP address is located.</p>"
},
"GeoLocation":{
"shape":"GeoLocation",
"documentation":"<p>The coordinates of the location of the remote IP address.</p>"
}
},
"documentation":"<p>For <code>AwsApiAction</code>, <code>NetworkConnectionAction</code>, and <code>PortProbeAction</code>, <code>RemoteIpDetails</code> provides information about the remote IP address that was involved in the action.</p>"
},
"ActionRemotePortDetails":{
"type":"structure",
"members":{
"Port":{
"shape":"Integer",
"documentation":"<p>The number of the port.</p>"
},
"PortName":{
"shape":"NonEmptyString",
"documentation":"<p>The port name of the remote connection.</p>"
}
},
"documentation":"<p>Provides information about the remote port that was involved in an attempted network connection.</p>"
},
"ActionTarget":{
"type":"structure",
"required":[
"ActionTargetArn",
"Name",
"Description"
],
"members":{
"ActionTargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN for the target action.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the action target.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>The description of the target action.</p>"
}
},
"documentation":"<p>An <code>ActionTarget</code> object.</p>"
},
"ActionTargetList":{
"type":"list",
"member":{"shape":"ActionTarget"}
},
"AdminAccount":{
"type":"structure",
"members":{
"AccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account identifier of the Security Hub administrator account.</p>"
},
"Status":{
"shape":"AdminStatus",
"documentation":"<p>The current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator.</p>"
}
},
"documentation":"<p>Represents a Security Hub administrator account designated by an organization management account.</p>"
},
"AdminAccounts":{
"type":"list",
"member":{"shape":"AdminAccount"}
},
"AdminStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLE_IN_PROGRESS"
]
},
"AdminsMaxResults":{
"type":"integer",
"max":10,
"min":1
},
"ArnList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"AvailabilityZone":{
"type":"structure",
"members":{
"ZoneName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the Availability Zone.</p>"
},
"SubnetId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the subnet. You can specify one subnet per Availability Zone.</p>"
}
},
"documentation":"<p>Information about an Availability Zone.</p>"
},
"AvailabilityZones":{
"type":"list",
"member":{"shape":"AvailabilityZone"}
},
"AwsApiCallAction":{
"type":"structure",
"members":{
"Api":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the API method that was issued.</p>"
},
"ServiceName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the AWS service that the API method belongs to.</p>"
},
"CallerType":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates whether the API call originated from a remote IP address (<code>remoteip</code>) or from a DNS domain (<code>domain</code>).</p>"
},
"RemoteIpDetails":{
"shape":"ActionRemoteIpDetails",
"documentation":"<p>Provided if <code>CallerType</code> is <code>remoteIp</code>. Provides information about the remote IP address that the API call originated from.</p>"
},
"DomainDetails":{
"shape":"AwsApiCallActionDomainDetails",
"documentation":"<p>Provided if <code>CallerType</code> is <code>domain</code>. Provides information about the DNS domain that the API call originated from.</p>"
},
"AffectedResources":{
"shape":"FieldMap",
"documentation":"<p>Identifies the resources that were affected by the API call.</p>"
},
"FirstSeen":{
"shape":"NonEmptyString",
"documentation":"<p>An ISO8601-formatted timestamp that indicates when the API call was first observed.</p>"
},
"LastSeen":{
"shape":"NonEmptyString",
"documentation":"<p>An ISO8601-formatted timestamp that indicates when the API call was most recently observed.</p>"
}
},
"documentation":"<p>Provided if <code>ActionType</code> is <code>AWS_API_CALL</code>. It provides details about the API call that was detected.</p>"
},
"AwsApiCallActionDomainDetails":{
"type":"structure",
"members":{
"Domain":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the DNS domain that issued the API call.</p>"
}
},
"documentation":"<p>Provided if <code>CallerType</code> is <code>domain</code>. It provides information about the DNS domain that issued the API call.</p>"
},
"AwsApiGatewayAccessLogSettings":{
"type":"structure",
"members":{
"Format":{
"shape":"NonEmptyString",
"documentation":"<p>A single-line format of the access logs of data, as specified by selected <code>$context</code> variables. The format must include at least <code>$context.requestId</code>.</p>"
},
"DestinationArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the CloudWatch Logs log group that receives the access logs.</p>"
}
},
"documentation":"<p>Contains information about settings for logging access for the stage.</p>"
},
"AwsApiGatewayCanarySettings":{
"type":"structure",
"members":{
"PercentTraffic":{
"shape":"Double",
"documentation":"<p>The percentage of traffic that is diverted to a canary deployment.</p>"
},
"DeploymentId":{
"shape":"NonEmptyString",
"documentation":"<p>The deployment identifier for the canary deployment.</p>"
},
"StageVariableOverrides":{
"shape":"FieldMap",
"documentation":"<p>Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.</p> <p>Each variable is represented as a string-to-string map between the stage variable name and the variable value.</p>"
},
"UseStageCache":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the canary deployment uses the stage cache.</p>"
}
},
"documentation":"<p>Contains information about settings for canary deployment in the stage.</p>"
},
"AwsApiGatewayEndpointConfiguration":{
"type":"structure",
"members":{
"Types":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of endpoint types for the REST API.</p> <p>For an edge-optimized API, the endpoint type is <code>EDGE</code>. For a Regional API, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</p>"
}
},
"documentation":"<p>Contains information about the endpoints for the API.</p>"
},
"AwsApiGatewayMethodSettings":{
"type":"structure",
"members":{
"MetricsEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether CloudWatch metrics are enabled for the method. </p>"
},
"LoggingLevel":{
"shape":"NonEmptyString",
"documentation":"<p>The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.</p> <p>If the logging level is <code>ERROR</code>, then the logs only include error-level entries.</p> <p>If the logging level is <code>INFO</code>, then the logs include both <code>ERROR</code> events and extra informational events.</p> <p>Valid values: <code>OFF</code> | <code>ERROR</code> | <code>INFO</code> </p>"
},
"DataTraceEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.</p>"
},
"ThrottlingBurstLimit":{
"shape":"Integer",
"documentation":"<p>The throttling burst limit for the method.</p>"
},
"ThrottlingRateLimit":{
"shape":"Double",
"documentation":"<p>The throttling rate limit for the method.</p>"
},
"CachingEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.</p>"
},
"CacheTtlInSeconds":{
"shape":"Integer",
"documentation":"<p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.</p>"
},
"CacheDataEncrypted":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the cached responses are encrypted. </p>"
},
"RequireAuthorizationForCacheControl":{
"shape":"Boolean",
"documentation":"<p>Indicates whether authorization is required for a cache invalidation request.</p>"
},
"UnauthorizedCacheControlHeaderStrategy":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates how to handle unauthorized requests for cache invalidation.</p> <p>Valid values: <code>FAIL_WITH_403</code> | <code>SUCCEED_WITH_RESPONSE_HEADER</code> | <code>SUCCEED_WITHOUT_RESPONSE_HEADER</code> </p>"
},
"HttpMethod":{
"shape":"NonEmptyString",
"documentation":"<p>The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.</p>"
},
"ResourcePath":{
"shape":"NonEmptyString",
"documentation":"<p>The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.</p> <p>For example, the path value <code>/resource/subresource</code> must be encoded as <code>/~1resource~1subresource</code>.</p> <p>To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.</p>"
}
},
"documentation":"<p>Defines settings for a method for the stage.</p>"
},
"AwsApiGatewayMethodSettingsList":{
"type":"list",
"member":{"shape":"AwsApiGatewayMethodSettings"}
},
"AwsApiGatewayRestApiDetails":{
"type":"structure",
"members":{
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the REST API.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the REST API.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the REST API.</p>"
},
"CreatedDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the API was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Version":{
"shape":"NonEmptyString",
"documentation":"<p>The version identifier for the REST API.</p>"
},
"BinaryMediaTypes":{
"shape":"NonEmptyStringList",
"documentation":"<p>The list of binary media types supported by the REST API.</p>"
},
"MinimumCompressionSize":{
"shape":"Integer",
"documentation":"<p>The minimum size in bytes of a payload before compression is enabled.</p> <p>If <code>null</code>, then compression is disabled.</p> <p>If 0, then all payloads are compressed.</p>"
},
"ApiKeySource":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the API key for metering requests according to a usage plan.</p> <p> <code>HEADER</code> indicates whether to read the API key from the X-API-Key header of a request.</p> <p> <code>AUTHORIZER</code> indicates whether to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</p>"
},
"EndpointConfiguration":{
"shape":"AwsApiGatewayEndpointConfiguration",
"documentation":"<p>The endpoint configuration of the REST API.</p>"
}
},
"documentation":"<p>contains information about a REST API in version 1 of Amazon API Gateway.</p>"
},
"AwsApiGatewayStageDetails":{
"type":"structure",
"members":{
"DeploymentId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the deployment that the stage points to.</p>"
},
"ClientCertificateId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the client certificate for the stage.</p>"
},
"StageName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the stage.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the stage.</p>"
},
"CacheClusterEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a cache cluster is enabled for the stage.</p>"
},
"CacheClusterSize":{
"shape":"NonEmptyString",
"documentation":"<p>If a cache cluster is enabled, the size of the cache cluster.</p>"
},
"CacheClusterStatus":{
"shape":"NonEmptyString",
"documentation":"<p>If a cache cluster is enabled, the status of the cache cluster.</p>"
},
"MethodSettings":{
"shape":"AwsApiGatewayMethodSettingsList",
"documentation":"<p>Defines the method settings for the stage.</p>"
},
"Variables":{
"shape":"FieldMap",
"documentation":"<p>A map that defines the stage variables for the stage.</p> <p>Variable names can have alphanumeric and underscore characters.</p> <p>Variable values can contain the following characters:</p> <ul> <li> <p>Uppercase and lowercase letters</p> </li> <li> <p>Numbers</p> </li> <li> <p>Special characters -._~:/?#&amp;=,</p> </li> </ul>"
},
"DocumentationVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The version of the API documentation that is associated with the stage.</p>"
},
"AccessLogSettings":{
"shape":"AwsApiGatewayAccessLogSettings",
"documentation":"<p>Settings for logging access for the stage.</p>"
},
"CanarySettings":{
"shape":"AwsApiGatewayCanarySettings",
"documentation":"<p>Information about settings for canary deployment in the stage.</p>"
},
"TracingEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether active tracing with AWS X-Ray is enabled for the stage.</p>"
},
"CreatedDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the stage was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"LastUpdatedDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the stage was most recently updated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"WebAclArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the web ACL associated with the stage.</p>"
}
},
"documentation":"<p>Provides information about a version 1 Amazon API Gateway stage.</p>"
},
"AwsApiGatewayV2ApiDetails":{
"type":"structure",
"members":{
"ApiEndpoint":{
"shape":"NonEmptyString",
"documentation":"<p>The URI of the API. </p> <p>Uses the format <code> <i>&lt;api-id&gt;</i>.execute-api.<i>&lt;region&gt;</i>.amazonaws.com</code> </p> <p>The stage name is typically appended to the URI to form a complete path to a deployed API stage.</p>"
},
"ApiId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the API.</p>"
},
"ApiKeySelectionExpression":{
"shape":"NonEmptyString",
"documentation":"<p>An API key selection expression. Supported only for WebSocket APIs. </p>"
},
"CreatedDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the API was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the API.</p>"
},
"Version":{
"shape":"NonEmptyString",
"documentation":"<p>The version identifier for the API.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the API.</p>"
},
"ProtocolType":{
"shape":"NonEmptyString",
"documentation":"<p>The API protocol for the API.</p> <p>Valid values: <code>WEBSOCKET</code> | <code>HTTP</code> </p>"
},
"RouteSelectionExpression":{
"shape":"NonEmptyString",
"documentation":"<p>The route selection expression for the API.</p> <p>For HTTP APIs, must be <code>${request.method} ${request.path}</code>. This is the default value for HTTP APIs.</p> <p>For WebSocket APIs, there is no default value.</p>"
},
"CorsConfiguration":{
"shape":"AwsCorsConfiguration",
"documentation":"<p>A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.</p>"
}
},
"documentation":"<p>Contains information about a version 2 API in Amazon API Gateway.</p>"
},
"AwsApiGatewayV2RouteSettings":{
"type":"structure",
"members":{
"DetailedMetricsEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether detailed metrics are enabled.</p>"
},
"LoggingLevel":{
"shape":"NonEmptyString",
"documentation":"<p>The logging level. The logging level affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.</p> <p>If the logging level is <code>ERROR</code>, then the logs only include error-level entries.</p> <p>If the logging level is <code>INFO</code>, then the logs include both <code>ERROR</code> events and extra informational events.</p> <p>Valid values: <code>OFF</code> | <code>ERROR</code> | <code>INFO</code> </p>"
},
"DataTraceEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether data trace logging is enabled. Data trace logging affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.</p>"
},
"ThrottlingBurstLimit":{
"shape":"Integer",
"documentation":"<p>The throttling burst limit.</p>"
},
"ThrottlingRateLimit":{
"shape":"Double",
"documentation":"<p>The throttling rate limit.</p>"
}
},
"documentation":"<p>Contains route settings for a stage.</p>"
},
"AwsApiGatewayV2StageDetails":{
"type":"structure",
"members":{
"CreatedDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the stage was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>The description of the stage.</p>"
},
"DefaultRouteSettings":{
"shape":"AwsApiGatewayV2RouteSettings",
"documentation":"<p>Default route settings for the stage.</p>"
},
"DeploymentId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the deployment that the stage is associated with. </p>"
},
"LastUpdatedDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the stage was most recently updated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"RouteSettings":{
"shape":"AwsApiGatewayV2RouteSettings",
"documentation":"<p>The route settings for the stage.</p>"
},
"StageName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the stage.</p>"
},
"StageVariables":{
"shape":"FieldMap",
"documentation":"<p>A map that defines the stage variables for the stage.</p> <p>Variable names can have alphanumeric and underscore characters.</p> <p>Variable values can contain the following characters:</p> <ul> <li> <p>Uppercase and lowercase letters</p> </li> <li> <p>Numbers</p> </li> <li> <p>Special characters -._~:/?#&amp;=,</p> </li> </ul>"
},
"AccessLogSettings":{
"shape":"AwsApiGatewayAccessLogSettings",
"documentation":"<p>Information about settings for logging access for the stage.</p>"
},
"AutoDeploy":{
"shape":"Boolean",
"documentation":"<p>Indicates whether updates to an API automatically trigger a new deployment.</p>"
},
"LastDeploymentStatusMessage":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.</p>"
},
"ApiGatewayManaged":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the stage is managed by API Gateway.</p>"
}
},
"documentation":"<p>Contains information about a version 2 stage for Amazon API Gateway.</p>"
},
"AwsAutoScalingAutoScalingGroupDetails":{
"type":"structure",
"members":{
"LaunchConfigurationName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the launch configuration.</p>"
},
"LoadBalancerNames":{
"shape":"StringList",
"documentation":"<p>The list of load balancers associated with the group.</p>"
},
"HealthCheckType":{
"shape":"NonEmptyString",
"documentation":"<p>The service to use for the health checks.</p>"
},
"HealthCheckGracePeriod":{
"shape":"Integer",
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the health status of an EC2 instance that has come into service.</p>"
},
"CreatedTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the auto scaling group was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>Provides details about an auto scaling group.</p>"
},
"AwsCertificateManagerCertificateDetails":{
"type":"structure",
"members":{
"CertificateAuthorityArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the private certificate authority (CA) that will be used to issue the certificate.</p>"
},
"CreatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the certificate was requested.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"DomainName":{
"shape":"NonEmptyString",
"documentation":"<p>The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.</p>"
},
"DomainValidationOptions":{
"shape":"AwsCertificateManagerCertificateDomainValidationOptions",
"documentation":"<p>Contains information about the initial validation of each domain name that occurs as a result of the <code>RequestCertificate</code> request.</p> <p>Only provided if the certificate type is <code>AMAZON_ISSUED</code>.</p>"
},
"ExtendedKeyUsages":{
"shape":"AwsCertificateManagerCertificateExtendedKeyUsages",
"documentation":"<p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).</p>"
},
"FailureReason":{
"shape":"NonEmptyString",
"documentation":"<p>For a failed certificate request, the reason for the failure.</p> <p>Valid values: <code>NO_AVAILABLE_CONTACTS</code> | <code>ADDITIONAL_VERIFICATION_REQUIRED</code> | <code>DOMAIN_NOT_ALLOWED</code> | <code>INVALID_PUBLIC_DOMAIN</code> | <code>DOMAIN_VALIDATION_DENIED</code> | <code>CAA_ERROR</code> | <code>PCA_LIMIT_EXCEEDED</code> | <code>PCA_INVALID_ARN</code> | <code>PCA_INVALID_STATE</code> | <code>PCA_REQUEST_FAILED</code> | <code>PCA_NAME_CONSTRAINTS_VALIDATION</code> | <code>PCA_RESOURCE_NOT_FOUND</code> | <code>PCA_INVALID_ARGS</code> | <code>PCA_INVALID_DURATION</code> | <code>PCA_ACCESS_DENIED</code> | <code>SLR_NOT_FOUND</code> | <code>OTHER</code> </p>"
},
"ImportedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the certificate was imported. Provided if the certificate type is <code>IMPORTED</code>.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"InUseBy":{
"shape":"StringList",
"documentation":"<p>The list of ARNs for the AWS resources that use the certificate.</p>"
},
"IssuedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the certificate was issued. Provided if the certificate type is <code>AMAZON_ISSUED</code>.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Issuer":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the certificate authority that issued and signed the certificate.</p>"
},
"KeyAlgorithm":{
"shape":"NonEmptyString",
"documentation":"<p>The algorithm that was used to generate the public-private key pair.</p> <p>Valid values: <code>RSA_2048</code> | <code>RSA_1024</code> |<code> RSA_4096</code> | <code>EC_prime256v1</code> | <code>EC_secp384r1</code> | <code>EC_secp521r1</code> </p>"
},
"KeyUsages":{
"shape":"AwsCertificateManagerCertificateKeyUsages",
"documentation":"<p>A list of key usage X.509 v3 extension objects.</p>"
},
"NotAfter":{
"shape":"NonEmptyString",
"documentation":"<p>The time after which the certificate becomes invalid.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"NotBefore":{
"shape":"NonEmptyString",
"documentation":"<p>The time before which the certificate is not valid.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Options":{
"shape":"AwsCertificateManagerCertificateOptions",
"documentation":"<p>Provides a value that specifies whether to add the certificate to a transparency log.</p>"
},
"RenewalEligibility":{
"shape":"NonEmptyString",
"documentation":"<p>Whether the certificate is eligible for renewal.</p> <p>Valid values: <code>ELIGIBLE</code> | <code>INELIGIBLE</code> </p>"
},
"RenewalSummary":{
"shape":"AwsCertificateManagerCertificateRenewalSummary",
"documentation":"<p>Information about the status of the AWS Certificate Manager managed renewal for the certificate. Provided only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
},
"Serial":{
"shape":"NonEmptyString",
"documentation":"<p>The serial number of the certificate.</p>"
},
"SignatureAlgorithm":{
"shape":"NonEmptyString",
"documentation":"<p>The algorithm that was used to sign the certificate.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the certificate.</p> <p>Valid values: <code>PENDING_VALIDATION</code> | <code>ISSUED</code> | <code>INACTIVE</code> | <code>EXPIRED</code> | <code>VALIDATION_TIMED_OUT</code> | <code>REVOKED</code> | <code>FAILED</code> </p>"
},
"Subject":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the entity that is associated with the public key contained in the certificate.</p>"
},
"SubjectAlternativeNames":{
"shape":"StringList",
"documentation":"<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate.</p> <p>The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the certificate. For certificates that AWS Certificate Manager provides, <code>Type</code> is <code>AMAZON_ISSUED</code>. For certificates that are imported with <code>ImportCertificate</code>, <code>Type</code> is <code>IMPORTED</code>.</p> <p>Valid values: <code>IMPORTED</code> | <code>AMAZON_ISSUED</code> | <code>PRIVATE</code> </p>"
}
},
"documentation":"<p>Provides details about an AWS Certificate Manager certificate.</p>"
},
"AwsCertificateManagerCertificateDomainValidationOption":{
"type":"structure",
"members":{
"DomainName":{
"shape":"NonEmptyString",
"documentation":"<p>A fully qualified domain name (FQDN) in the certificate.</p>"
},
"ResourceRecord":{
"shape":"AwsCertificateManagerCertificateResourceRecord",
"documentation":"<p>The CNAME record that is added to the DNS database for domain validation.</p>"
},
"ValidationDomain":{
"shape":"NonEmptyString",
"documentation":"<p>The domain name that AWS Certificate Manager uses to send domain validation emails.</p>"
},
"ValidationEmails":{
"shape":"StringList",
"documentation":"<p>A list of email addresses that AWS Certificate Manager uses to send domain validation emails.</p>"
},
"ValidationMethod":{
"shape":"NonEmptyString",
"documentation":"<p>The method used to validate the domain name.</p>"
},
"ValidationStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The validation status of the domain name.</p>"
}
},
"documentation":"<p>Contains information about one of the following:</p> <ul> <li> <p>The initial validation of each domain name that occurs as a result of the <code>RequestCertificate</code> request</p> </li> <li> <p>The validation of each domain name in the certificate, as it pertains to AWS Certificate Manager managed renewal</p> </li> </ul>"
},
"AwsCertificateManagerCertificateDomainValidationOptions":{
"type":"list",
"member":{"shape":"AwsCertificateManagerCertificateDomainValidationOption"}
},
"AwsCertificateManagerCertificateExtendedKeyUsage":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of an extension value. Indicates the purpose for which the certificate public key can be used.</p>"
},
"OId":{
"shape":"NonEmptyString",
"documentation":"<p>An object identifier (OID) for the extension value.</p> <p>The format is numbers separated by periods.</p>"
}
},
"documentation":"<p>Contains information about an extended key usage X.509 v3 extension object.</p>"
},
"AwsCertificateManagerCertificateExtendedKeyUsages":{
"type":"list",
"member":{"shape":"AwsCertificateManagerCertificateExtendedKeyUsage"}
},
"AwsCertificateManagerCertificateKeyUsage":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The key usage extension name.</p>"
}
},
"documentation":"<p>Contains information about a key usage X.509 v3 extension object.</p>"
},
"AwsCertificateManagerCertificateKeyUsages":{
"type":"list",
"member":{"shape":"AwsCertificateManagerCertificateKeyUsage"}
},
"AwsCertificateManagerCertificateOptions":{
"type":"structure",
"members":{
"CertificateTransparencyLoggingPreference":{
"shape":"NonEmptyString",
"documentation":"<p>Whether to add the certificate to a transparency log.</p> <p>Valid values: <code>DISABLED</code> | <code>ENABLED</code> </p>"
}
},
"documentation":"<p>Contains other options for the certificate.</p>"
},
"AwsCertificateManagerCertificateRenewalSummary":{
"type":"structure",
"members":{
"DomainValidationOptions":{
"shape":"AwsCertificateManagerCertificateDomainValidationOptions",
"documentation":"<p>Information about the validation of each domain name in the certificate, as it pertains to AWS Certificate Manager managed renewal. Provided only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
},
"RenewalStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the AWS Certificate Manager managed renewal of the certificate.</p> <p>Valid values: <code>PENDING_AUTO_RENEWAL</code> | <code>PENDING_VALIDATION</code> | <code>SUCCESS</code> | <code>FAILED</code> </p>"
},
"RenewalStatusReason":{
"shape":"NonEmptyString",
"documentation":"<p>The reason that a renewal request was unsuccessful.</p> <p>Valid values: <code>NO_AVAILABLE_CONTACTS</code> | <code>ADDITIONAL_VERIFICATION_REQUIRED</code> | <code>DOMAIN_NOT_ALLOWED</code> | <code>INVALID_PUBLIC_DOMAIN</code> | <code>DOMAIN_VALIDATION_DENIED</code> | <code>CAA_ERROR</code> | <code>PCA_LIMIT_EXCEEDED</code> | <code>PCA_INVALID_ARN</code> | <code>PCA_INVALID_STATE</code> | <code>PCA_REQUEST_FAILED</code> | <code>PCA_NAME_CONSTRAINTS_VALIDATION</code> | <code>PCA_RESOURCE_NOT_FOUND</code> | <code>PCA_INVALID_ARGS</code> | <code>PCA_INVALID_DURATION</code> | <code>PCA_ACCESS_DENIED</code> | <code>SLR_NOT_FOUND</code> | <code>OTHER</code> </p>"
},
"UpdatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the renewal summary was last updated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>Contains information about the AWS Certificate Manager managed renewal for an <code>AMAZON_ISSUED</code> certificate.</p>"
},
"AwsCertificateManagerCertificateResourceRecord":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the resource.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of resource.</p>"
},
"Value":{
"shape":"NonEmptyString",
"documentation":"<p>The value of the resource.</p>"
}
},
"documentation":"<p>Provides details about the CNAME record that is added to the DNS database for domain validation.</p>"
},
"AwsCloudFrontDistributionCacheBehavior":{
"type":"structure",
"members":{
"ViewerProtocolPolicy":{
"shape":"NonEmptyString",
"documentation":"<p>The protocol that viewers can use to access the files in an origin. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code> - Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code> - CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit.</p> </li> <li> <p> <code>https-only</code> - CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).</p> </li> </ul>"
}
},
"documentation":"<p>Information about a cache behavior for the distribution.</p>"
},
"AwsCloudFrontDistributionCacheBehaviors":{
"type":"structure",
"members":{
"Items":{
"shape":"AwsCloudFrontDistributionCacheBehaviorsItemList",
"documentation":"<p>The cache behaviors for the distribution.</p>"
}
},
"documentation":"<p>Provides information about caching for the distribution.</p>"
},
"AwsCloudFrontDistributionCacheBehaviorsItemList":{
"type":"list",
"member":{"shape":"AwsCloudFrontDistributionCacheBehavior"}
},
"AwsCloudFrontDistributionDefaultCacheBehavior":{
"type":"structure",
"members":{
"ViewerProtocolPolicy":{
"shape":"NonEmptyString",
"documentation":"<p>The protocol that viewers can use to access the files in an origin. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code> - Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code> - CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit.</p> </li> <li> <p> <code>https-only</code> - CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).</p> </li> </ul>"
}
},
"documentation":"<p>Contains information about the default cache configuration for the distribution.</p>"
},
"AwsCloudFrontDistributionDetails":{
"type":"structure",
"members":{
"CacheBehaviors":{
"shape":"AwsCloudFrontDistributionCacheBehaviors",
"documentation":"<p>Provides information about the cache configuration for the distribution.</p>"
},
"DefaultCacheBehavior":{
"shape":"AwsCloudFrontDistributionDefaultCacheBehavior",
"documentation":"<p>The default cache behavior for the configuration.</p>"
},
"DefaultRootObject":{
"shape":"NonEmptyString",
"documentation":"<p>The object that CloudFront sends in response to requests from the origin (for example, index.html) when a viewer requests the root URL for the distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). </p>"
},
"DomainName":{
"shape":"NonEmptyString",
"documentation":"<p>The domain name corresponding to the distribution.</p>"
},
"ETag":{
"shape":"NonEmptyString",
"documentation":"<p>The entity tag is a hash of the object.</p>"
},
"LastModifiedTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when that the distribution was last modified.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Logging":{
"shape":"AwsCloudFrontDistributionLogging",
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p>"
},
"Origins":{
"shape":"AwsCloudFrontDistributionOrigins",
"documentation":"<p>A complex type that contains information about origins for this distribution.</p>"
},
"OriginGroups":{
"shape":"AwsCloudFrontDistributionOriginGroups",
"documentation":"<p>Provides information about the origin groups in the distribution.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates the current status of the distribution.</p>"
},
"WebAclId":{
"shape":"NonEmptyString",
"documentation":"<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.</p>"
}
},
"documentation":"<p>A distribution configuration.</p>"
},
"AwsCloudFrontDistributionLogging":{
"type":"structure",
"members":{
"Bucket":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon S3 bucket to store the access logs in.</p>"
},
"Enabled":{
"shape":"Boolean",
"documentation":"<p>With this field, you can enable or disable the selected distribution.</p>"
},
"IncludeCookies":{
"shape":"Boolean",
"documentation":"<p>Specifies whether you want CloudFront to include cookies in access logs.</p>"
},
"Prefix":{
"shape":"NonEmptyString",
"documentation":"<p>An optional string that you want CloudFront to use as a prefix to the access log filenames for this distribution.</p>"
}
},
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p>"
},
"AwsCloudFrontDistributionOriginGroup":{
"type":"structure",
"members":{
"FailoverCriteria":{
"shape":"AwsCloudFrontDistributionOriginGroupFailover",
"documentation":"<p>Provides the criteria for an origin group to fail over.</p>"
}
},
"documentation":"<p>Information about an origin group for the distribution.</p>"
},
"AwsCloudFrontDistributionOriginGroupFailover":{
"type":"structure",
"members":{
"StatusCodes":{
"shape":"AwsCloudFrontDistributionOriginGroupFailoverStatusCodes",
"documentation":"<p>Information about the status codes that cause an origin group to fail over.</p>"
}
},
"documentation":"<p>Provides information about when an origin group fails over.</p>"
},
"AwsCloudFrontDistributionOriginGroupFailoverStatusCodes":{
"type":"structure",
"members":{
"Items":{
"shape":"AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList",
"documentation":"<p>The list of status code values that can cause a failover to the next origin.</p>"
},
"Quantity":{
"shape":"Integer",
"documentation":"<p>The number of status codes that can cause a failover.</p>"
}
},
"documentation":"<p>The status codes that cause an origin group to fail over.</p>"
},
"AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList":{
"type":"list",
"member":{"shape":"Integer"}
},
"AwsCloudFrontDistributionOriginGroups":{
"type":"structure",
"members":{
"Items":{
"shape":"AwsCloudFrontDistributionOriginGroupsItemList",
"documentation":"<p>The list of origin groups.</p>"
}
},
"documentation":"<p>Provides information about origin groups that are associated with the distribution.</p>"
},
"AwsCloudFrontDistributionOriginGroupsItemList":{
"type":"list",
"member":{"shape":"AwsCloudFrontDistributionOriginGroup"}
},
"AwsCloudFrontDistributionOriginItem":{
"type":"structure",
"members":{
"DomainName":{
"shape":"NonEmptyString",
"documentation":"<p>Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin.</p>"
},
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>A unique identifier for the origin or origin group.</p>"
},
"OriginPath":{
"shape":"NonEmptyString",
"documentation":"<p>An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.</p>"
},
"S3OriginConfig":{
"shape":"AwsCloudFrontDistributionOriginS3OriginConfig",
"documentation":"<p>An origin that is an S3 bucket that is not configured with static website hosting.</p>"
}
},
"documentation":"<p>A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon Elemental MediaStore, or other server from which CloudFront gets your files.</p>"
},
"AwsCloudFrontDistributionOriginItemList":{
"type":"list",
"member":{"shape":"AwsCloudFrontDistributionOriginItem"}
},
"AwsCloudFrontDistributionOriginS3OriginConfig":{
"type":"structure",
"members":{
"OriginAccessIdentity":{
"shape":"NonEmptyString",
"documentation":"<p>The CloudFront origin access identity to associate with the origin.</p>"
}
},
"documentation":"<p>Information about an origin that is an S3 bucket that is not configured with static website hosting.</p>"
},
"AwsCloudFrontDistributionOrigins":{
"type":"structure",
"members":{
"Items":{
"shape":"AwsCloudFrontDistributionOriginItemList",
"documentation":"<p>A complex type that contains origins or origin groups for this distribution.</p>"
}
},
"documentation":"<p>A complex type that contains information about origins and origin groups for this distribution.</p>"
},
"AwsCloudTrailTrailDetails":{
"type":"structure",
"members":{
"CloudWatchLogsLogGroupArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the log group that CloudTrail logs are delivered to.</p>"
},
"CloudWatchLogsRoleArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the role that the CloudWatch Logs endpoint assumes when it writes to the log group.</p>"
},
"HasCustomEventSelectors":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the trail has custom event selectors.</p>"
},
"HomeRegion":{
"shape":"NonEmptyString",
"documentation":"<p>The Region where the trail was created.</p>"
},
"IncludeGlobalServiceEvents":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the trail publishes events from global services such as IAM to the log files.</p>"
},
"IsMultiRegionTrail":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the trail applies only to the current Region or to all Regions.</p>"
},
"IsOrganizationTrail":{
"shape":"Boolean",
"documentation":"<p>Whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS KMS key ID to use to encrypt the logs.</p>"
},
"LogFileValidationEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether CloudTrail log file validation is enabled.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the trail.</p>"
},
"S3BucketName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the S3 bucket where the log files are published.</p>"
},
"S3KeyPrefix":{
"shape":"NonEmptyString",
"documentation":"<p>The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log files are published.</p>"
},
"SnsTopicArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the SNS topic that is used for notifications of log file delivery.</p>"
},
"SnsTopicName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the SNS topic that is used for notifications of log file delivery.</p>"
},
"TrailArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the trail.</p>"
}
},
"documentation":"<p>Provides details about a CloudTrail trail.</p>"
},
"AwsCodeBuildProjectDetails":{
"type":"structure",
"members":{
"EncryptionKey":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the build output artifacts.</p> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK alias (using the format alias/alias-name). </p>"
},
"Environment":{
"shape":"AwsCodeBuildProjectEnvironment",
"documentation":"<p>Information about the build environment for this build project.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the build project.</p>"
},
"Source":{
"shape":"AwsCodeBuildProjectSource",
"documentation":"<p>Information about the build input source code for this build project.</p>"
},
"ServiceRole":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>"
},
"VpcConfig":{
"shape":"AwsCodeBuildProjectVpcConfig",
"documentation":"<p>Information about the VPC configuration that AWS CodeBuild accesses.</p>"
}
},
"documentation":"<p>Information about an AWS CodeBuild project.</p>"
},
"AwsCodeBuildProjectEnvironment":{
"type":"structure",
"members":{
"Certificate":{
"shape":"NonEmptyString",
"documentation":"<p>The certificate to use with this build project.</p>"
},
"ImagePullCredentialsType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of credentials AWS CodeBuild uses to pull images in your build.</p> <p>Valid values:</p> <ul> <li> <p> <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the AWS CodeBuild service principal.</p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role.</p> </li> </ul> <p>When you use a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When you use an AWS CodeBuild curated image, you must use <code>CODEBUILD</code> credentials.</p>"
},
"RegistryCredential":{
"shape":"AwsCodeBuildProjectEnvironmentRegistryCredential",
"documentation":"<p>The credentials for access to a private registry.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of build environment to use for related builds.</p> <p>The environment type <code>ARM_CONTAINER</code> is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).</p> <p>The environment type <code>LINUX_CONTAINER</code> with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> <p>Valid values: <code>WINDOWS_CONTAINER</code> | <code>LINUX_CONTAINER</code> | <code>LINUX_GPU_CONTAINER</code> | <code>ARM_CONTAINER</code> </p>"
}
},
"documentation":"<p>Information about the build environment for this build project.</p>"
},
"AwsCodeBuildProjectEnvironmentRegistryCredential":{
"type":"structure",
"members":{
"Credential":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.</p> <note> <p>The credential can use the name of the credentials only if they exist in your current AWS Region. </p> </note>"
},
"CredentialProvider":{
"shape":"NonEmptyString",
"documentation":"<p>The service that created the credentials to access a private Docker registry.</p> <p>The valid value,<code> SECRETS_MANAGER</code>, is for AWS Secrets Manager.</p>"
}
},
"documentation":"<p>The credentials for access to a private registry.</p>"
},
"AwsCodeBuildProjectSource":{
"type":"structure",
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of repository that contains the source code to be built. Valid values are:</p> <ul> <li> <p> <code>BITBUCKET</code> - The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code> - The source code is in an AWS CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code> - The source code settings are specified in the source action of a pipeline in AWS CodePipeline.</p> </li> <li> <p> <code>GITHUB</code> - The source code is in a GitHub repository.</p> </li> <li> <p> <code>GITHUB_ENTERPRISE</code> - The source code is in a GitHub Enterprise repository.</p> </li> <li> <p> <code>NO_SOURCE</code> - The project does not have input source code.</p> </li> <li> <p> <code>S3</code> - The source code is in an S3 input bucket. </p> </li> </ul>"
},
"Location":{
"shape":"NonEmptyString",
"documentation":"<p>Information about the location of the source code to be built.</p> <p>Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec file (for example, <code>https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name</code> ).</p> </li> <li> <p>For source code in an S3 input bucket, one of the following.</p> <ul> <li> <p>The path to the ZIP file that contains the source code (for example, <code>bucket-name/path/to/object-name.zip</code>).</p> </li> <li> <p> The path to the folder that contains the source code (for example, <code>bucket-name/path/to/source-code/folder/</code>).</p> </li> </ul> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec file.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec file. </p> </li> </ul>"
},
"GitCloneDepth":{
"shape":"Integer",
"documentation":"<p>Information about the Git clone depth for the build project.</p>"
},
"InsecureSsl":{
"shape":"Boolean",
"documentation":"<p>Whether to ignore SSL warnings while connecting to the project source code.</p>"
}
},
"documentation":"<p>Information about the build input source code for this build project.</p>"
},
"AwsCodeBuildProjectVpcConfig":{
"type":"structure",
"members":{
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC.</p>"
},
"Subnets":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of one or more subnet IDs in your Amazon VPC.</p>"
},
"SecurityGroupIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of one or more security group IDs in your Amazon VPC.</p>"
}
},
"documentation":"<p>Information about the VPC configuration that AWS CodeBuild accesses.</p>"
},
"AwsCorsConfiguration":{
"type":"structure",
"members":{
"AllowOrigins":{
"shape":"NonEmptyStringList",
"documentation":"<p>The allowed origins for CORS requests.</p>"
},
"AllowCredentials":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the CORS request includes credentials.</p>"
},
"ExposeHeaders":{
"shape":"NonEmptyStringList",
"documentation":"<p>The exposed headers for CORS requests.</p>"
},
"MaxAge":{
"shape":"Integer",
"documentation":"<p>The number of seconds for which the browser caches preflight request results.</p>"
},
"AllowMethods":{
"shape":"NonEmptyStringList",
"documentation":"<p>The allowed methods for CORS requests.</p>"
},
"AllowHeaders":{
"shape":"NonEmptyStringList",
"documentation":"<p>The allowed headers for CORS requests.</p>"
}
},
"documentation":"<p>Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is only supported for HTTP APIs.</p>"
},
"AwsDynamoDbTableAttributeDefinition":{
"type":"structure",
"members":{
"AttributeName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the attribute.</p>"
},
"AttributeType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of the attribute.</p>"
}
},
"documentation":"<p>Contains a definition of an attribute for the table.</p>"
},
"AwsDynamoDbTableAttributeDefinitionList":{
"type":"list",
"member":{"shape":"AwsDynamoDbTableAttributeDefinition"}
},
"AwsDynamoDbTableBillingModeSummary":{
"type":"structure",
"members":{
"BillingMode":{
"shape":"NonEmptyString",
"documentation":"<p>The method used to charge for read and write throughput and to manage capacity.</p>"
},
"LastUpdateToPayPerRequestDateTime":{
"shape":"NonEmptyString",
"documentation":"<p>If the billing mode is <code>PAY_PER_REQUEST</code>, indicates when the billing mode was set to that value.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>Provides information about the billing for read/write capacity on the table.</p>"
},
"AwsDynamoDbTableDetails":{
"type":"structure",
"members":{
"AttributeDefinitions":{
"shape":"AwsDynamoDbTableAttributeDefinitionList",
"documentation":"<p>A list of attribute definitions for the table.</p>"
},
"BillingModeSummary":{
"shape":"AwsDynamoDbTableBillingModeSummary",
"documentation":"<p>Information about the billing for read/write capacity on the table.</p>"
},
"CreationDateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the table was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"GlobalSecondaryIndexes":{
"shape":"AwsDynamoDbTableGlobalSecondaryIndexList",
"documentation":"<p>List of global secondary indexes for the table.</p>"
},
"GlobalTableVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The version of global tables being used.</p>"
},
"ItemCount":{
"shape":"Integer",
"documentation":"<p>The number of items in the table.</p>"
},
"KeySchema":{
"shape":"AwsDynamoDbTableKeySchemaList",
"documentation":"<p>The primary key structure for the table.</p>"
},
"LatestStreamArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the latest stream for the table.</p>"
},
"LatestStreamLabel":{
"shape":"NonEmptyString",
"documentation":"<p>The label of the latest stream. The label is not a unique identifier.</p>"
},
"LocalSecondaryIndexes":{
"shape":"AwsDynamoDbTableLocalSecondaryIndexList",
"documentation":"<p>The list of local secondary indexes for the table.</p>"
},
"ProvisionedThroughput":{
"shape":"AwsDynamoDbTableProvisionedThroughput",
"documentation":"<p>Information about the provisioned throughput for the table.</p>"
},
"Replicas":{
"shape":"AwsDynamoDbTableReplicaList",
"documentation":"<p>The list of replicas of this table.</p>"
},
"RestoreSummary":{
"shape":"AwsDynamoDbTableRestoreSummary",
"documentation":"<p>Information about the restore for the table.</p>"
},
"SseDescription":{
"shape":"AwsDynamoDbTableSseDescription",
"documentation":"<p>Information about the server-side encryption for the table.</p>"
},
"StreamSpecification":{
"shape":"AwsDynamoDbTableStreamSpecification",
"documentation":"<p>The current DynamoDB Streams configuration for the table.</p>"
},
"TableId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the table.</p>"
},
"TableName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the table.</p>"
},
"TableSizeBytes":{
"shape":"SizeBytes",
"documentation":"<p>The total size of the table in bytes.</p>"
},
"TableStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The current status of the table.</p>"
}
},
"documentation":"<p>Provides details about a DynamoDB table.</p>"
},
"AwsDynamoDbTableGlobalSecondaryIndex":{
"type":"structure",
"members":{
"Backfilling":{
"shape":"Boolean",
"documentation":"<p>Whether the index is currently backfilling.</p>"
},
"IndexArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the index.</p>"
},
"IndexName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the index.</p>"
},
"IndexSizeBytes":{
"shape":"SizeBytes",
"documentation":"<p>The total size in bytes of the index.</p>"
},
"IndexStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The current status of the index.</p>"
},
"ItemCount":{
"shape":"Integer",
"documentation":"<p>The number of items in the index.</p>"
},
"KeySchema":{
"shape":"AwsDynamoDbTableKeySchemaList",
"documentation":"<p>The key schema for the index.</p>"
},
"Projection":{
"shape":"AwsDynamoDbTableProjection",
"documentation":"<p>Attributes that are copied from the table into an index.</p>"
},
"ProvisionedThroughput":{
"shape":"AwsDynamoDbTableProvisionedThroughput",
"documentation":"<p>Information about the provisioned throughput settings for the indexes.</p>"
}
},
"documentation":"<p>Information abut a global secondary index for the table.</p>"
},
"AwsDynamoDbTableGlobalSecondaryIndexList":{
"type":"list",
"member":{"shape":"AwsDynamoDbTableGlobalSecondaryIndex"}
},
"AwsDynamoDbTableKeySchema":{
"type":"structure",
"members":{
"AttributeName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the key schema attribute.</p>"
},
"KeyType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of key used for the key schema attribute.</p>"
}
},
"documentation":"<p>A component of the key schema for the DynamoDB table, a global secondary index, or a local secondary index.</p>"
},
"AwsDynamoDbTableKeySchemaList":{
"type":"list",
"member":{"shape":"AwsDynamoDbTableKeySchema"}
},
"AwsDynamoDbTableLocalSecondaryIndex":{
"type":"structure",
"members":{
"IndexArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the index.</p>"
},
"IndexName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the index.</p>"
},
"KeySchema":{
"shape":"AwsDynamoDbTableKeySchemaList",
"documentation":"<p>The complete key schema for the index.</p>"
},
"Projection":{
"shape":"AwsDynamoDbTableProjection",
"documentation":"<p>Attributes that are copied from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>"
}
},
"documentation":"<p>Information about a local secondary index for a DynamoDB table.</p>"
},
"AwsDynamoDbTableLocalSecondaryIndexList":{
"type":"list",
"member":{"shape":"AwsDynamoDbTableLocalSecondaryIndex"}
},
"AwsDynamoDbTableProjection":{
"type":"structure",
"members":{
"NonKeyAttributes":{
"shape":"StringList",
"documentation":"<p>The nonkey attributes that are projected into the index. For each attribute, provide the attribute name.</p>"
},
"ProjectionType":{
"shape":"NonEmptyString",
"documentation":"<p>The types of attributes that are projected into the index.</p>"
}
},
"documentation":"<p>For global and local secondary indexes, identifies the attributes that are copied from the table into the index.</p>"
},
"AwsDynamoDbTableProvisionedThroughput":{
"type":"structure",
"members":{
"LastDecreaseDateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the provisioned throughput was last decreased.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"LastIncreaseDateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the provisioned throughput was last increased.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"NumberOfDecreasesToday":{
"shape":"Integer",
"documentation":"<p>The number of times during the current UTC calendar day that the provisioned throughput was decreased.</p>"
},
"ReadCapacityUnits":{
"shape":"Integer",
"documentation":"<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>"
},
"WriteCapacityUnits":{
"shape":"Integer",
"documentation":"<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>"
}
},
"documentation":"<p>Information about the provisioned throughput for the table or for a global secondary index.</p>"
},
"AwsDynamoDbTableProvisionedThroughputOverride":{
"type":"structure",
"members":{
"ReadCapacityUnits":{
"shape":"Integer",
"documentation":"<p>The read capacity units for the replica.</p>"
}
},
"documentation":"<p>Replica-specific configuration for the provisioned throughput.</p>"
},
"AwsDynamoDbTableReplica":{
"type":"structure",
"members":{
"GlobalSecondaryIndexes":{
"shape":"AwsDynamoDbTableReplicaGlobalSecondaryIndexList",
"documentation":"<p>List of global secondary indexes for the replica.</p>"
},
"KmsMasterKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the AWS KMS customer master key (CMK) that will be used for AWS KMS encryption for the replica.</p>"
},
"ProvisionedThroughputOverride":{
"shape":"AwsDynamoDbTableProvisionedThroughputOverride",
"documentation":"<p>Replica-specific configuration for the provisioned throughput.</p>"
},
"RegionName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the Region where the replica is located.</p>"
},
"ReplicaStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The current status of the replica.</p>"
},
"ReplicaStatusDescription":{
"shape":"NonEmptyString",
"documentation":"<p>Detailed information about the replica status.</p>"
}
},
"documentation":"<p>Information about a replica of a DynamoDB table.</p>"
},
"AwsDynamoDbTableReplicaGlobalSecondaryIndex":{
"type":"structure",
"members":{
"IndexName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the index.</p>"
},
"ProvisionedThroughputOverride":{
"shape":"AwsDynamoDbTableProvisionedThroughputOverride",
"documentation":"<p>Replica-specific configuration for the provisioned throughput for the index.</p>"
}
},
"documentation":"<p>Information about a global secondary index for a DynamoDB table replica.</p>"
},
"AwsDynamoDbTableReplicaGlobalSecondaryIndexList":{
"type":"list",
"member":{"shape":"AwsDynamoDbTableReplicaGlobalSecondaryIndex"}
},
"AwsDynamoDbTableReplicaList":{
"type":"list",
"member":{"shape":"AwsDynamoDbTableReplica"}
},
"AwsDynamoDbTableRestoreSummary":{
"type":"structure",
"members":{
"SourceBackupArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the source backup from which the table was restored.</p>"
},
"SourceTableArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the source table for the backup.</p>"
},
"RestoreDateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates the point in time that the table was restored to.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"RestoreInProgress":{
"shape":"Boolean",
"documentation":"<p>Whether a restore is currently in progress.</p>"
}
},
"documentation":"<p>Information about the restore for the table.</p>"
},
"AwsDynamoDbTableSseDescription":{
"type":"structure",
"members":{
"InaccessibleEncryptionDateTime":{
"shape":"NonEmptyString",
"documentation":"<p>If the key is inaccessible, the date and time when DynamoDB detected that the key was inaccessible.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the server-side encryption.</p>"
},
"SseType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of server-side encryption.</p>"
},
"KmsMasterKeyArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the AWS KMS customer master key (CMK) that is used for the AWS KMS encryption.</p>"
}
},
"documentation":"<p>Information about the server-side encryption for the table.</p>"
},
"AwsDynamoDbTableStreamSpecification":{
"type":"structure",
"members":{
"StreamEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether DynamoDB Streams is enabled on the table.</p>"
},
"StreamViewType":{
"shape":"NonEmptyString",
"documentation":"<p>Determines the information that is written to the table.</p>"
}
},
"documentation":"<p>The current DynamoDB Streams configuration for the table.</p>"
},
"AwsEc2EipDetails":{
"type":"structure",
"members":{
"InstanceId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the EC2 instance.</p>"
},
"PublicIp":{
"shape":"NonEmptyString",
"documentation":"<p>A public IP address that is associated with the EC2 instance.</p>"
},
"AllocationId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier that AWS assigns to represent the allocation of the Elastic IP address for use with Amazon VPC.</p>"
},
"AssociationId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier that represents the association of the Elastic IP address with an EC2 instance.</p>"
},
"Domain":{
"shape":"NonEmptyString",
"documentation":"<p>The domain in which to allocate the address.</p> <p>If the address is for use with EC2 instances in a VPC, then <code>Domain</code> is <code>vpc</code>. Otherwise, <code>Domain</code> is <code>standard</code>. </p>"
},
"PublicIpv4Pool":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP address from the address pool.</p>"
},
"NetworkBorderGroup":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the location from which the Elastic IP address is advertised.</p>"
},
"NetworkInterfaceId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the network interface.</p>"
},
"NetworkInterfaceOwnerId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account ID of the owner of the network interface.</p>"
},
"PrivateIpAddress":{
"shape":"NonEmptyString",
"documentation":"<p>The private IP address that is associated with the Elastic IP address.</p>"
}
},
"documentation":"<p>Information about an Elastic IP address.</p>"
},
"AwsEc2InstanceDetails":{
"type":"structure",
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The instance type of the instance. </p>"
},
"ImageId":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Machine Image (AMI) ID of the instance.</p>"
},
"IpV4Addresses":{
"shape":"StringList",
"documentation":"<p>The IPv4 addresses associated with the instance.</p>"
},
"IpV6Addresses":{
"shape":"StringList",
"documentation":"<p>The IPv6 addresses associated with the instance.</p>"
},
"KeyName":{
"shape":"NonEmptyString",
"documentation":"<p>The key name associated with the instance.</p>"
},
"IamInstanceProfileArn":{
"shape":"NonEmptyString",
"documentation":"<p>The IAM profile ARN of the instance.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the VPC that the instance was launched in.</p>"
},
"SubnetId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the subnet that the instance was launched in.</p>"
},
"LaunchedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the instance was launched.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>The details of an Amazon EC2 instance.</p>"
},
"AwsEc2NetworkInterfaceAttachment":{
"type":"structure",
"members":{
"AttachTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the attachment initiated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"AttachmentId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the network interface attachment</p>"
},
"DeleteOnTermination":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the network interface is deleted when the instance is terminated.</p>"
},
"DeviceIndex":{
"shape":"Integer",
"documentation":"<p>The device index of the network interface attachment on the instance.</p>"
},
"InstanceId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the instance.</p>"
},
"InstanceOwnerId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account ID of the owner of the instance.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The attachment state.</p> <p>Valid values: <code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code> </p>"
}
},
"documentation":"<p>Information about the network interface attachment.</p>"
},
"AwsEc2NetworkInterfaceDetails":{
"type":"structure",
"members":{
"Attachment":{
"shape":"AwsEc2NetworkInterfaceAttachment",
"documentation":"<p>The network interface attachment.</p>"
},
"NetworkInterfaceId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the network interface.</p>"
},
"SecurityGroups":{
"shape":"AwsEc2NetworkInterfaceSecurityGroupList",
"documentation":"<p>Security groups for the network interface.</p>"
},
"SourceDestCheck":{
"shape":"Boolean",
"documentation":"<p>Indicates whether traffic to or from the instance is validated.</p>"
},
"IpV6Addresses":{
"shape":"AwsEc2NetworkInterfaceIpV6AddressList",
"documentation":"<p>The IPv6 addresses associated with the network interface.</p>"
},
"PrivateIpAddresses":{
"shape":"AwsEc2NetworkInterfacePrivateIpAddressList",
"documentation":"<p>The private IPv4 addresses associated with the network interface.</p>"
},
"PublicDnsName":{
"shape":"NonEmptyString",
"documentation":"<p>The public DNS name of the network interface.</p>"
},
"PublicIp":{
"shape":"NonEmptyString",
"documentation":"<p>The address of the Elastic IP address bound to the network interface.</p>"
}
},
"documentation":"<p>Details about the network interface</p>"
},
"AwsEc2NetworkInterfaceIpV6AddressDetail":{
"type":"structure",
"members":{
"IpV6Address":{
"shape":"NonEmptyString",
"documentation":"<p>The IPV6 address.</p>"
}
},
"documentation":"<p>Provides information about an IPV6 address that is associated with the network interface.</p>"
},
"AwsEc2NetworkInterfaceIpV6AddressList":{
"type":"list",
"member":{"shape":"AwsEc2NetworkInterfaceIpV6AddressDetail"}
},
"AwsEc2NetworkInterfacePrivateIpAddressDetail":{
"type":"structure",
"members":{
"PrivateIpAddress":{
"shape":"NonEmptyString",
"documentation":"<p>The IP address.</p>"
},
"PrivateDnsName":{
"shape":"NonEmptyString",
"documentation":"<p>The private DNS name for the IP address.</p>"
}
},
"documentation":"<p>Provides information about a private IPv4 address that is with the network interface.</p>"
},
"AwsEc2NetworkInterfacePrivateIpAddressList":{
"type":"list",
"member":{"shape":"AwsEc2NetworkInterfacePrivateIpAddressDetail"}
},
"AwsEc2NetworkInterfaceSecurityGroup":{
"type":"structure",
"members":{
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the security group.</p>"
},
"GroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the security group.</p>"
}
},
"documentation":"<p>A security group associated with the network interface.</p>"
},
"AwsEc2NetworkInterfaceSecurityGroupList":{
"type":"list",
"member":{"shape":"AwsEc2NetworkInterfaceSecurityGroup"}
},
"AwsEc2SecurityGroupDetails":{
"type":"structure",
"members":{
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the security group.</p>"
},
"GroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the security group.</p>"
},
"OwnerId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account ID of the owner of the security group.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>[VPC only] The ID of the VPC for the security group.</p>"
},
"IpPermissions":{
"shape":"AwsEc2SecurityGroupIpPermissionList",
"documentation":"<p>The inbound rules associated with the security group.</p>"
},
"IpPermissionsEgress":{
"shape":"AwsEc2SecurityGroupIpPermissionList",
"documentation":"<p>[VPC only] The outbound rules associated with the security group.</p>"
}
},
"documentation":"<p>Details about an EC2 security group.</p>"
},
"AwsEc2SecurityGroupIpPermission":{
"type":"structure",
"members":{
"IpProtocol":{
"shape":"NonEmptyString",
"documentation":"<p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>icmpv6</code>) or number.</p> <p>[VPC only] Use <code>-1</code> to specify all protocols.</p> <p>When authorizing security group rules, specifying -1 or a protocol number other than <code>tcp</code>, <code>udp</code>, <code>icmp</code>, or <code>icmpv6</code> allows traffic on all ports, regardless of any port range you specify.</p> <p>For <code>tcp</code>, <code>udp</code>, and <code>icmp</code>, you must specify a port range.</p> <p>For <code>icmpv6</code>, the port range is optional. If you omit the port range, traffic for all types and codes is allowed. </p>"
},
"FromPort":{
"shape":"Integer",
"documentation":"<p>The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.</p> <p>A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. </p>"
},
"ToPort":{
"shape":"Integer",
"documentation":"<p>The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.</p> <p>A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.</p>"
},
"UserIdGroupPairs":{
"shape":"AwsEc2SecurityGroupUserIdGroupPairList",
"documentation":"<p>The security group and AWS account ID pairs.</p>"
},
"IpRanges":{
"shape":"AwsEc2SecurityGroupIpRangeList",
"documentation":"<p>The IPv4 ranges.</p>"
},
"Ipv6Ranges":{
"shape":"AwsEc2SecurityGroupIpv6RangeList",
"documentation":"<p>The IPv6 ranges.</p>"
},
"PrefixListIds":{
"shape":"AwsEc2SecurityGroupPrefixListIdList",
"documentation":"<p>[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group.</p>"
}
},
"documentation":"<p>An IP permission for an EC2 security group.</p>"
},
"AwsEc2SecurityGroupIpPermissionList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupIpPermission"}
},
"AwsEc2SecurityGroupIpRange":{
"type":"structure",
"members":{
"CidrIp":{
"shape":"NonEmptyString",
"documentation":"<p>The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv4 address, use the /32 prefix length.</p>"
}
},
"documentation":"<p>A range of IPv4 addresses.</p>"
},
"AwsEc2SecurityGroupIpRangeList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupIpRange"}
},
"AwsEc2SecurityGroupIpv6Range":{
"type":"structure",
"members":{
"CidrIpv6":{
"shape":"NonEmptyString",
"documentation":"<p>The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv6 address, use the /128 prefix length.</p>"
}
},
"documentation":"<p>A range of IPv6 addresses.</p>"
},
"AwsEc2SecurityGroupIpv6RangeList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupIpv6Range"}
},
"AwsEc2SecurityGroupPrefixListId":{
"type":"structure",
"members":{
"PrefixListId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the prefix.</p>"
}
},
"documentation":"<p>A prefix list ID.</p>"
},
"AwsEc2SecurityGroupPrefixListIdList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupPrefixListId"}
},
"AwsEc2SecurityGroupUserIdGroupPair":{
"type":"structure",
"members":{
"GroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the security group.</p>"
},
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the security group.</p>"
},
"PeeringStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of a VPC peering connection, if applicable.</p>"
},
"UserId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of an AWS account.</p> <p>For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.</p> <p>[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS. </p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC for the referenced security group, if applicable.</p>"
},
"VpcPeeringConnectionId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC peering connection, if applicable.</p>"
}
},
"documentation":"<p>A relationship between a security group and a user.</p>"
},
"AwsEc2SecurityGroupUserIdGroupPairList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupUserIdGroupPair"}
},
"AwsEc2VolumeAttachment":{
"type":"structure",
"members":{
"AttachTime":{
"shape":"NonEmptyString",
"documentation":"<p>The datetime when the attachment initiated.</p>"
},
"DeleteOnTermination":{
"shape":"Boolean",
"documentation":"<p>Whether the EBS volume is deleted when the EC2 instance is terminated.</p>"
},
"InstanceId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the EC2 instance.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The attachment state of the volume.</p>"
}
},
"documentation":"<p>An attachment to an AWS EC2 volume.</p>"
},
"AwsEc2VolumeAttachmentList":{
"type":"list",
"member":{"shape":"AwsEc2VolumeAttachment"}
},
"AwsEc2VolumeDetails":{
"type":"structure",
"members":{
"CreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the volume was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Encrypted":{
"shape":"Boolean",
"documentation":"<p>Whether the volume is encrypted.</p>"
},
"Size":{
"shape":"Integer",
"documentation":"<p>The size of the volume, in GiBs.</p>"
},
"SnapshotId":{
"shape":"NonEmptyString",
"documentation":"<p>The snapshot from which the volume was created.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The volume state.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.</p>"
},
"Attachments":{
"shape":"AwsEc2VolumeAttachmentList",
"documentation":"<p>The volume attachments.</p>"
}
},
"documentation":"<p>Details about an EC2 volume.</p>"
},
"AwsEc2VpcDetails":{
"type":"structure",
"members":{
"CidrBlockAssociationSet":{
"shape":"CidrBlockAssociationList",
"documentation":"<p>Information about the IPv4 CIDR blocks associated with the VPC.</p>"
},
"Ipv6CidrBlockAssociationSet":{
"shape":"Ipv6CidrBlockAssociationList",
"documentation":"<p>Information about the IPv6 CIDR blocks associated with the VPC.</p>"
},
"DhcpOptionsId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.</p>"
},
"State":{
"shape":"NonEmptyString",
"documentation":"<p>The current state of the VPC.</p>"
}
},
"documentation":"<p>Details about an EC2 VPC.</p>"
},
"AwsElasticsearchDomainDetails":{
"type":"structure",
"members":{
"AccessPolicies":{
"shape":"NonEmptyString",
"documentation":"<p>IAM policy document specifying the access policies for the new Amazon ES domain.</p>"
},
"DomainEndpointOptions":{
"shape":"AwsElasticsearchDomainDomainEndpointOptions",
"documentation":"<p>Additional options for the domain endpoint.</p>"
},
"DomainId":{
"shape":"NonEmptyString",
"documentation":"<p>Unique identifier for an Amazon ES domain.</p>"
},
"DomainName":{
"shape":"NonEmptyString",
"documentation":"<p>Name of an Amazon ES domain.</p> <p>Domain names are unique across all domains owned by the same account within an AWS Region.</p> <p>Domain names must start with a lowercase letter and must be between 3 and 28 characters.</p> <p>Valid characters are a-z (lowercase only), 0-9, and – (hyphen). </p>"
},
"Endpoint":{
"shape":"NonEmptyString",
"documentation":"<p>Domain-specific endpoint used to submit index, search, and data upload requests to an Amazon ES domain.</p> <p>The endpoint is a service URL. </p>"
},
"Endpoints":{
"shape":"FieldMap",
"documentation":"<p>The key-value pair that exists if the Amazon ES domain uses VPC endpoints.</p>"
},
"ElasticsearchVersion":{
"shape":"NonEmptyString",
"documentation":"<p>Elasticsearch version.</p>"
},
"EncryptionAtRestOptions":{
"shape":"AwsElasticsearchDomainEncryptionAtRestOptions",
"documentation":"<p>Details about the configuration for encryption at rest.</p>"
},
"NodeToNodeEncryptionOptions":{
"shape":"AwsElasticsearchDomainNodeToNodeEncryptionOptions",
"documentation":"<p>Details about the configuration for node-to-node encryption.</p>"
},
"VPCOptions":{
"shape":"AwsElasticsearchDomainVPCOptions",
"documentation":"<p>Information that Amazon ES derives based on <code>VPCOptions</code> for the domain.</p>"
}
},
"documentation":"<p>Information about an Elasticsearch domain.</p>"
},
"AwsElasticsearchDomainDomainEndpointOptions":{
"type":"structure",
"members":{
"EnforceHTTPS":{
"shape":"Boolean",
"documentation":"<p>Whether to require that all traffic to the domain arrive over HTTPS.</p>"
},
"TLSSecurityPolicy":{
"shape":"NonEmptyString",
"documentation":"<p>The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch domain.</p> <p>Valid values:</p> <ul> <li> <p> <code>Policy-Min-TLS-1-0-2019-07</code>, which supports TLSv1.0 and higher</p> </li> <li> <p> <code>Policy-Min-TLS-1-2-2019-07</code>, which only supports TLSv1.2</p> </li> </ul>"
}
},
"documentation":"<p>Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.</p>"
},
"AwsElasticsearchDomainEncryptionAtRestOptions":{
"type":"structure",
"members":{
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Whether encryption at rest is enabled.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.</p>"
}
},
"documentation":"<p>Details about the configuration for encryption at rest.</p>"
},
"AwsElasticsearchDomainNodeToNodeEncryptionOptions":{
"type":"structure",
"members":{
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Whether node-to-node encryption is enabled.</p>"
}
},
"documentation":"<p>Details about the configuration for node-to-node encryption.</p>"
},
"AwsElasticsearchDomainVPCOptions":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"NonEmptyStringList",
"documentation":"<p>The list of Availability Zones associated with the VPC subnets.</p>"
},
"SecurityGroupIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>The list of security group IDs associated with the VPC endpoints for the domain.</p>"
},
"SubnetIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of subnet IDs associated with the VPC endpoints for the domain.</p>"
},
"VPCId":{
"shape":"NonEmptyString",
"documentation":"<p>ID for the VPC.</p>"
}
},
"documentation":"<p>Information that Amazon ES derives based on <code>VPCOptions</code> for the domain.</p>"
},
"AwsElbAppCookieStickinessPolicies":{
"type":"list",
"member":{"shape":"AwsElbAppCookieStickinessPolicy"}
},
"AwsElbAppCookieStickinessPolicy":{
"type":"structure",
"members":{
"CookieName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the application cookie used for stickiness.</p>"
},
"PolicyName":{
"shape":"NonEmptyString",
"documentation":"<p>The mnemonic name for the policy being created. The name must be unique within the set of policies for the load balancer.</p>"
}
},
"documentation":"<p>Contains information about a stickiness policy that was created using <code>CreateAppCookieStickinessPolicy</code>.</p>"
},
"AwsElbLbCookieStickinessPolicies":{
"type":"list",
"member":{"shape":"AwsElbLbCookieStickinessPolicy"}
},
"AwsElbLbCookieStickinessPolicy":{
"type":"structure",
"members":{
"CookieExpirationPeriod":{
"shape":"Long",
"documentation":"<p>The amount of time, in seconds, after which the cookie is considered stale. If an expiration period is not specified, the stickiness session lasts for the duration of the browser session.</p>"
},
"PolicyName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the policy. The name must be unique within the set of policies for the load balancer.</p>"
}
},
"documentation":"<p>Contains information about a stickiness policy that was created using <code>CreateLBCookieStickinessPolicy</code>.</p>"
},
"AwsElbLoadBalancerAccessLog":{
"type":"structure",
"members":{
"EmitInterval":{
"shape":"Integer",
"documentation":"<p>The interval in minutes for publishing the access logs.</p> <p>You can publish access logs either every 5 minutes or every 60 minutes.</p>"
},
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether access logs are enabled for the load balancer.</p>"
},
"S3BucketName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the S3 bucket where the access logs are stored.</p>"
},
"S3BucketPrefix":{
"shape":"NonEmptyString",
"documentation":"<p>The logical hierarchy that was created for the S3 bucket.</p> <p>If a prefix is not provided, the log is placed at the root level of the bucket.</p>"
}
},
"documentation":"<p>Contains information about the access log configuration for the load balancer.</p>"
},
"AwsElbLoadBalancerAttributes":{
"type":"structure",
"members":{
"AccessLog":{
"shape":"AwsElbLoadBalancerAccessLog",
"documentation":"<p>Information about the access log configuration for the load balancer.</p> <p>If the access log is enabled, the load balancer captures detailed information about all requests. It delivers the information to a specified S3 bucket.</p>"
},
"ConnectionDraining":{
"shape":"AwsElbLoadBalancerConnectionDraining",
"documentation":"<p>Information about the connection draining configuration for the load balancer.</p> <p>If connection draining is enabled, the load balancer allows existing requests to complete before it shifts traffic away from a deregistered or unhealthy instance.</p>"
},
"ConnectionSettings":{
"shape":"AwsElbLoadBalancerConnectionSettings",
"documentation":"<p>Connection settings for the load balancer.</p> <p>If an idle timeout is configured, the load balancer allows connections to remain idle for the specified duration. When a connection is idle, no data is sent over the connection.</p>"
},
"CrossZoneLoadBalancing":{
"shape":"AwsElbLoadBalancerCrossZoneLoadBalancing",
"documentation":"<p>Cross-zone load balancing settings for the load balancer.</p> <p>If cross-zone load balancing is enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.</p>"
}
},
"documentation":"<p>Contains attributes for the load balancer.</p>"
},
"AwsElbLoadBalancerBackendServerDescription":{
"type":"structure",
"members":{
"InstancePort":{
"shape":"Integer",
"documentation":"<p>The port on which the EC2 instance is listening.</p>"
},
"PolicyNames":{
"shape":"StringList",
"documentation":"<p>The names of the policies that are enabled for the EC2 instance.</p>"
}
},
"documentation":"<p>Provides information about the configuration of an EC2 instance for the load balancer.</p>"
},
"AwsElbLoadBalancerBackendServerDescriptions":{
"type":"list",
"member":{"shape":"AwsElbLoadBalancerBackendServerDescription"}
},
"AwsElbLoadBalancerConnectionDraining":{
"type":"structure",
"members":{
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether connection draining is enabled for the load balancer.</p>"
},
"Timeout":{
"shape":"Integer",
"documentation":"<p>The maximum time, in seconds, to keep the existing connections open before deregistering the instances.</p>"
}
},
"documentation":"<p>Contains information about the connection draining configuration for the load balancer.</p>"
},
"AwsElbLoadBalancerConnectionSettings":{
"type":"structure",
"members":{
"IdleTimeout":{
"shape":"Integer",
"documentation":"<p>The time, in seconds, that the connection can be idle (no data is sent over the connection) before it is closed by the load balancer.</p>"
}
},
"documentation":"<p>Contains connection settings for the load balancer.</p>"
},
"AwsElbLoadBalancerCrossZoneLoadBalancing":{
"type":"structure",
"members":{
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether cross-zone load balancing is enabled for the load balancer.</p>"
}
},
"documentation":"<p>Contains cross-zone load balancing settings for the load balancer.</p>"
},
"AwsElbLoadBalancerDetails":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"StringList",
"documentation":"<p>The list of Availability Zones for the load balancer.</p>"
},
"BackendServerDescriptions":{
"shape":"AwsElbLoadBalancerBackendServerDescriptions",
"documentation":"<p>Information about the configuration of the EC2 instances.</p>"
},
"CanonicalHostedZoneName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the Amazon Route 53 hosted zone for the load balancer.</p>"
},
"CanonicalHostedZoneNameID":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the Amazon Route 53 hosted zone for the load balancer.</p>"
},
"CreatedTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the load balancer was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"DnsName":{
"shape":"NonEmptyString",
"documentation":"<p>The DNS name of the load balancer.</p>"
},
"HealthCheck":{
"shape":"AwsElbLoadBalancerHealthCheck",
"documentation":"<p>Information about the health checks that are conducted on the load balancer.</p>"
},
"Instances":{
"shape":"AwsElbLoadBalancerInstances",
"documentation":"<p>List of EC2 instances for the load balancer.</p>"
},
"ListenerDescriptions":{
"shape":"AwsElbLoadBalancerListenerDescriptions",
"documentation":"<p>The policies that are enabled for the load balancer listeners.</p>"
},
"LoadBalancerAttributes":{
"shape":"AwsElbLoadBalancerAttributes",
"documentation":"<p>The attributes for a load balancer.</p>"
},
"LoadBalancerName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the load balancer.</p>"
},
"Policies":{
"shape":"AwsElbLoadBalancerPolicies",
"documentation":"<p>The policies for a load balancer.</p>"
},
"Scheme":{
"shape":"NonEmptyString",
"documentation":"<p>The type of load balancer. Only provided if the load balancer is in a VPC.</p> <p>If <code>Scheme</code> is <code>internet-facing</code>, the load balancer has a public DNS name that resolves to a public IP address.</p> <p>If <code>Scheme</code> is <code>internal</code>, the load balancer has a public DNS name that resolves to a private IP address.</p>"
},
"SecurityGroups":{
"shape":"StringList",
"documentation":"<p>The security groups for the load balancer. Only provided if the load balancer is in a VPC.</p>"
},
"SourceSecurityGroup":{
"shape":"AwsElbLoadBalancerSourceSecurityGroup",
"documentation":"<p>Information about the security group for the load balancer. This is the security group that is used for inbound rules.</p>"
},
"Subnets":{
"shape":"StringList",
"documentation":"<p>The list of subnet identifiers for the load balancer.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the VPC for the load balancer.</p>"
}
},
"documentation":"<p>Contains details about a Classic Load Balancer.</p>"
},
"AwsElbLoadBalancerHealthCheck":{
"type":"structure",
"members":{
"HealthyThreshold":{
"shape":"Integer",
"documentation":"<p>The number of consecutive health check successes required before the instance is moved to the Healthy state.</p>"
},
"Interval":{
"shape":"Integer",
"documentation":"<p>The approximate interval, in seconds, between health checks of an individual instance.</p>"
},
"Target":{
"shape":"NonEmptyString",
"documentation":"<p>The instance that is being checked. The target specifies the protocol and port. The available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports is 1 through 65535.</p> <p>For the HTTP and HTTPS protocols, the target also specifies the ping path.</p> <p>For the TCP protocol, the target is specified as <code>TCP: <i>&lt;port&gt;</i> </code>.</p> <p>For the SSL protocol, the target is specified as <code>SSL.<i>&lt;port&gt;</i> </code>.</p> <p>For the HTTP and HTTPS protocols, the target is specified as <code> <i>&lt;protocol&gt;</i>:<i>&lt;port&gt;</i>/<i>&lt;path to ping&gt;</i> </code>.</p>"
},
"Timeout":{
"shape":"Integer",
"documentation":"<p>The amount of time, in seconds, during which no response means a failed health check.</p>"
},
"UnhealthyThreshold":{
"shape":"Integer",
"documentation":"<p>The number of consecutive health check failures that must occur before the instance is moved to the Unhealthy state.</p>"
}
},
"documentation":"<p>Contains information about the health checks that are conducted on the load balancer.</p>"
},
"AwsElbLoadBalancerInstance":{
"type":"structure",
"members":{
"InstanceId":{
"shape":"NonEmptyString",
"documentation":"<p>The instance identifier.</p>"
}
},
"documentation":"<p>Provides information about an EC2 instance for a load balancer.</p>"
},
"AwsElbLoadBalancerInstances":{
"type":"list",
"member":{"shape":"AwsElbLoadBalancerInstance"}
},
"AwsElbLoadBalancerListener":{
"type":"structure",
"members":{
"InstancePort":{
"shape":"Integer",
"documentation":"<p>The port on which the instance is listening.</p>"
},
"InstanceProtocol":{
"shape":"NonEmptyString",
"documentation":"<p>The protocol to use to route traffic to instances.</p> <p>Valid values: <code>HTTP</code> | <code>HTTPS</code> | <code>TCP</code> | <code>SSL</code> </p>"
},
"LoadBalancerPort":{
"shape":"Integer",
"documentation":"<p>The port on which the load balancer is listening.</p> <p>On EC2-VPC, you can specify any port from the range 1-65535.</p> <p>On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.</p>"
},
"Protocol":{
"shape":"NonEmptyString",
"documentation":"<p>The load balancer transport protocol to use for routing.</p> <p>Valid values: <code>HTTP</code> | <code>HTTPS</code> | <code>TCP</code> | <code>SSL</code> </p>"
},
"SslCertificateId":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the server certificate.</p>"
}
},
"documentation":"<p>Information about a load balancer listener.</p>"
},
"AwsElbLoadBalancerListenerDescription":{
"type":"structure",
"members":{
"Listener":{
"shape":"AwsElbLoadBalancerListener",
"documentation":"<p>Information about the listener.</p>"
},
"PolicyNames":{
"shape":"StringList",
"documentation":"<p>The policies enabled for the listener.</p>"
}
},
"documentation":"<p>Lists the policies that are enabled for a load balancer listener.</p>"
},
"AwsElbLoadBalancerListenerDescriptions":{
"type":"list",
"member":{"shape":"AwsElbLoadBalancerListenerDescription"}
},
"AwsElbLoadBalancerPolicies":{
"type":"structure",
"members":{
"AppCookieStickinessPolicies":{
"shape":"AwsElbAppCookieStickinessPolicies",
"documentation":"<p>The stickiness policies that are created using <code>CreateAppCookieStickinessPolicy</code>.</p>"
},
"LbCookieStickinessPolicies":{
"shape":"AwsElbLbCookieStickinessPolicies",
"documentation":"<p>The stickiness policies that are created using <code>CreateLBCookieStickinessPolicy</code>.</p>"
},
"OtherPolicies":{
"shape":"StringList",
"documentation":"<p>The policies other than the stickiness policies.</p>"
}
},
"documentation":"<p>Contains information about the policies for a load balancer.</p>"
},
"AwsElbLoadBalancerSourceSecurityGroup":{
"type":"structure",
"members":{
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the security group.</p>"
},
"OwnerAlias":{
"shape":"NonEmptyString",
"documentation":"<p>The owner of the security group.</p>"
}
},
"documentation":"<p>Contains information about the security group for the load balancer.</p>"
},
"AwsElbv2LoadBalancerDetails":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>The Availability Zones for the load balancer.</p>"
},
"CanonicalHostedZoneId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the Amazon Route 53 hosted zone associated with the load balancer.</p>"
},
"CreatedTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the load balancer was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"DNSName":{
"shape":"NonEmptyString",
"documentation":"<p>The public DNS name of the load balancer.</p>"
},
"IpAddressType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses).</p>"
},
"Scheme":{
"shape":"NonEmptyString",
"documentation":"<p>The nodes of an Internet-facing load balancer have public IP addresses.</p>"
},
"SecurityGroups":{
"shape":"SecurityGroups",
"documentation":"<p>The IDs of the security groups for the load balancer.</p>"
},
"State":{
"shape":"LoadBalancerState",
"documentation":"<p>The state of the load balancer.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of load balancer.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC for the load balancer.</p>"
}
},
"documentation":"<p>Information about a load balancer.</p>"
},
"AwsIamAccessKeyDetails":{
"type":"structure",
"members":{
"UserName":{
"shape":"NonEmptyString",
"documentation":"<p>The user associated with the IAM access key related to a finding.</p> <p>The <code>UserName</code> parameter has been replaced with the <code>PrincipalName</code> parameter because access keys can also be assigned to principals that are not IAM users.</p>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use PrincipalName instead."
},
"Status":{
"shape":"AwsIamAccessKeyStatus",
"documentation":"<p>The status of the IAM access key related to a finding.</p>"
},
"CreatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the IAM access key was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"PrincipalId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the principal associated with an access key.</p>"
},
"PrincipalType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of principal associated with an access key.</p>"
},
"PrincipalName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the principal.</p>"
},
"AccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account ID of the account for the key.</p>"
},
"AccessKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the access key.</p>"
},
"SessionContext":{
"shape":"AwsIamAccessKeySessionContext",
"documentation":"<p>Information about the session that the key was used for.</p>"
}
},
"documentation":"<p>IAM access key details related to a finding.</p>"
},
"AwsIamAccessKeySessionContext":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AwsIamAccessKeySessionContextAttributes",
"documentation":"<p>Attributes of the session that the key was used for.</p>"
},
"SessionIssuer":{
"shape":"AwsIamAccessKeySessionContextSessionIssuer",
"documentation":"<p>Information about the entity that created the session.</p>"
}
},
"documentation":"<p>Provides information about the session that the key was used for.</p>"
},
"AwsIamAccessKeySessionContextAttributes":{
"type":"structure",
"members":{
"MfaAuthenticated":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the session used multi-factor authentication (MFA).</p>"
},
"CreationDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the session was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>Attributes of the session that the key was used for.</p>"
},
"AwsIamAccessKeySessionContextSessionIssuer":{
"type":"structure",
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of principal (user, role, or group) that created the session.</p>"
},
"PrincipalId":{
"shape":"NonEmptyString",
"documentation":"<p>The principal ID of the principal (user, role, or group) that created the session.</p>"
},
"Arn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the session.</p>"
},
"AccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the AWS account that created the session.</p>"
},
"UserName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the principal that created the session.</p>"
}
},
"documentation":"<p>Information about the entity that created the session.</p>"
},
"AwsIamAccessKeyStatus":{
"type":"string",
"enum":[
"Active",
"Inactive"
]
},
"AwsIamAttachedManagedPolicy":{
"type":"structure",
"members":{
"PolicyName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the policy.</p>"
},
"PolicyArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the policy.</p>"
}
},
"documentation":"<p>A managed policy that is attached to an IAM principal.</p>"
},
"AwsIamAttachedManagedPolicyList":{
"type":"list",
"member":{"shape":"AwsIamAttachedManagedPolicy"}
},
"AwsIamGroupDetails":{
"type":"structure",
"members":{
"AttachedManagedPolicies":{
"shape":"AwsIamAttachedManagedPolicyList",
"documentation":"<p>A list of the managed policies that are attached to the IAM group.</p>"
},
"CreateDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the IAM group was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"GroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the IAM group.</p>"
},
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the IAM group.</p>"
},
"GroupPolicyList":{
"shape":"AwsIamGroupPolicyList",
"documentation":"<p>The list of inline policies that are embedded in the group.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the group.</p>"
}
},
"documentation":"<p>Contains details about an IAM group.</p>"
},
"AwsIamGroupPolicy":{
"type":"structure",
"members":{
"PolicyName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the policy.</p>"
}
},
"documentation":"<p>A managed policy that is attached to the IAM group.</p>"
},
"AwsIamGroupPolicyList":{
"type":"list",
"member":{"shape":"AwsIamGroupPolicy"}
},
"AwsIamInstanceProfile":{
"type":"structure",
"members":{
"Arn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the instance profile.</p>"
},
"CreateDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the instance profile was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"InstanceProfileId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the instance profile.</p>"
},
"InstanceProfileName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the instance profile.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the instance profile.</p>"
},
"Roles":{
"shape":"AwsIamInstanceProfileRoles",
"documentation":"<p>The roles associated with the instance profile.</p>"
}
},
"documentation":"<p>Information about an instance profile.</p>"
},
"AwsIamInstanceProfileList":{
"type":"list",
"member":{"shape":"AwsIamInstanceProfile"}
},
"AwsIamInstanceProfileRole":{
"type":"structure",
"members":{
"Arn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the role.</p>"
},
"AssumeRolePolicyDocument":{
"shape":"AwsIamRoleAssumeRolePolicyDocument",
"documentation":"<p>The policy that grants an entity permission to assume the role.</p>"
},
"CreateDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the role was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the role.</p>"
},
"RoleId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the role.</p>"
},
"RoleName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the role.</p>"
}
},
"documentation":"<p>Information about a role associated with an instance profile.</p>"
},
"AwsIamInstanceProfileRoles":{
"type":"list",
"member":{"shape":"AwsIamInstanceProfileRole"}
},
"AwsIamPermissionsBoundary":{
"type":"structure",
"members":{
"PermissionsBoundaryArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the policy used to set the permissions boundary.</p>"
},
"PermissionsBoundaryType":{
"shape":"NonEmptyString",
"documentation":"<p>The usage type for the permissions boundary.</p>"
}
},
"documentation":"<p>Information about the policy used to set the permissions boundary for an IAM principal.</p>"
},
"AwsIamPolicyDetails":{
"type":"structure",
"members":{
"AttachmentCount":{
"shape":"Integer",
"documentation":"<p>The number of users, groups, and roles that the policy is attached to.</p>"
},
"CreateDate":{
"shape":"NonEmptyString",
"documentation":"<p>When the policy was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"DefaultVersionId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the default version of the policy.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the policy.</p>"
},
"IsAttachable":{
"shape":"Boolean",
"documentation":"<p>Whether the policy can be attached to a user, group, or role.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the policy.</p>"
},
"PermissionsBoundaryUsageCount":{
"shape":"Integer",
"documentation":"<p>The number of users and roles that use the policy to set the permissions boundary.</p>"
},
"PolicyId":{
"shape":"NonEmptyString",
"documentation":"<p>The unique identifier of the policy.</p>"
},
"PolicyName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the policy.</p>"
},
"PolicyVersionList":{
"shape":"AwsIamPolicyVersionList",
"documentation":"<p>List of versions of the policy.</p>"
},
"UpdateDate":{
"shape":"NonEmptyString",
"documentation":"<p>When the policy was most recently updated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>Represents an IAM permissions policy.</p>"
},
"AwsIamPolicyVersion":{
"type":"structure",
"members":{
"VersionId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the policy version.</p>"
},
"IsDefaultVersion":{
"shape":"Boolean",
"documentation":"<p>Whether the version is the default version.</p>"
},
"CreateDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the version was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>A version of an IAM policy.</p>"
},
"AwsIamPolicyVersionList":{
"type":"list",
"member":{"shape":"AwsIamPolicyVersion"}
},
"AwsIamRoleAssumeRolePolicyDocument":{
"type":"string",
"max":131072,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+"
},
"AwsIamRoleDetails":{
"type":"structure",
"members":{
"AssumeRolePolicyDocument":{
"shape":"AwsIamRoleAssumeRolePolicyDocument",
"documentation":"<p>The trust policy that grants permission to assume the role.</p>"
},
"AttachedManagedPolicies":{
"shape":"AwsIamAttachedManagedPolicyList",
"documentation":"<p>The list of the managed policies that are attached to the role.</p>"
},
"CreateDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the role was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"InstanceProfileList":{
"shape":"AwsIamInstanceProfileList",
"documentation":"<p>The list of instance profiles that contain this role.</p>"
},
"PermissionsBoundary":{"shape":"AwsIamPermissionsBoundary"},
"RoleId":{
"shape":"NonEmptyString",
"documentation":"<p>The stable and unique string identifying the role.</p>"
},
"RoleName":{
"shape":"NonEmptyString",
"documentation":"<p>The friendly name that identifies the role.</p>"
},
"RolePolicyList":{
"shape":"AwsIamRolePolicyList",
"documentation":"<p>The list of inline policies that are embedded in the role.</p>"
},
"MaxSessionDuration":{
"shape":"Integer",
"documentation":"<p>The maximum session duration (in seconds) that you want to set for the specified role.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the role.</p>"
}
},
"documentation":"<p>Contains information about an IAM role, including all of the role's policies.</p>"
},
"AwsIamRolePolicy":{
"type":"structure",
"members":{
"PolicyName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the policy.</p>"
}
},
"documentation":"<p>An inline policy that is embedded in the role.</p>"
},
"AwsIamRolePolicyList":{
"type":"list",
"member":{"shape":"AwsIamRolePolicy"}
},
"AwsIamUserDetails":{
"type":"structure",
"members":{
"AttachedManagedPolicies":{
"shape":"AwsIamAttachedManagedPolicyList",
"documentation":"<p>A list of the managed policies that are attached to the user.</p>"
},
"CreateDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the user was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"GroupList":{
"shape":"StringList",
"documentation":"<p>A list of IAM groups that the user belongs to.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the user.</p>"
},
"PermissionsBoundary":{
"shape":"AwsIamPermissionsBoundary",
"documentation":"<p>The permissions boundary for the user.</p>"
},
"UserId":{
"shape":"NonEmptyString",
"documentation":"<p>The unique identifier for the user.</p>"
},
"UserName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the user.</p>"
},
"UserPolicyList":{
"shape":"AwsIamUserPolicyList",
"documentation":"<p>The list of inline policies that are embedded in the user.</p>"
}
},
"documentation":"<p>Information about an IAM user.</p>"
},
"AwsIamUserPolicy":{
"type":"structure",
"members":{
"PolicyName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the policy.</p>"
}
},
"documentation":"<p>Information about an inline policy that is embedded in the user.</p>"
},
"AwsIamUserPolicyList":{
"type":"list",
"member":{"shape":"AwsIamUserPolicy"}
},
"AwsKmsKeyDetails":{
"type":"structure",
"members":{
"AWSAccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The twelve-digit account ID of the AWS account that owns the CMK.</p>"
},
"CreationDate":{
"shape":"Double",
"documentation":"<p>Indicates when the CMK was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"KeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The globally unique identifier for the CMK.</p>"
},
"KeyManager":{
"shape":"NonEmptyString",
"documentation":"<p>The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.</p>"
},
"KeyState":{
"shape":"NonEmptyString",
"documentation":"<p>The state of the CMK.</p>"
},
"Origin":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the CMK's key material.</p> <p>When this value is <code>AWS_KMS</code>, AWS KMS created the key material.</p> <p>When this value is <code>EXTERNAL</code>, the key material was imported from your existing key management infrastructure or the CMK lacks key material.</p> <p>When this value is <code>AWS_CLOUDHSM</code>, the key material was created in the AWS CloudHSM cluster associated with a custom key store.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the key.</p>"
}
},
"documentation":"<p>Contains metadata about a customer master key (CMK).</p>"
},
"AwsLambdaFunctionCode":{
"type":"structure",
"members":{
"S3Bucket":{
"shape":"NonEmptyString",
"documentation":"<p>An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.</p>"
},
"S3Key":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon S3 key of the deployment package.</p>"
},
"S3ObjectVersion":{
"shape":"NonEmptyString",
"documentation":"<p>For versioned objects, the version of the deployment package object to use.</p>"
},
"ZipFile":{
"shape":"NonEmptyString",
"documentation":"<p>The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.</p>"
}
},
"documentation":"<p>The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.</p>"
},
"AwsLambdaFunctionDeadLetterConfig":{
"type":"structure",
"members":{
"TargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.</p>"
}
},
"documentation":"<p>The dead-letter queue for failed asynchronous invocations.</p>"
},
"AwsLambdaFunctionDetails":{
"type":"structure",
"members":{
"Code":{
"shape":"AwsLambdaFunctionCode",
"documentation":"<p>An <code>AwsLambdaFunctionCode</code> object.</p>"
},
"CodeSha256":{
"shape":"NonEmptyString",
"documentation":"<p>The SHA256 hash of the function's deployment package.</p>"
},
"DeadLetterConfig":{
"shape":"AwsLambdaFunctionDeadLetterConfig",
"documentation":"<p>The function's dead letter queue.</p>"
},
"Environment":{
"shape":"AwsLambdaFunctionEnvironment",
"documentation":"<p>The function's environment variables.</p>"
},
"FunctionName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the function.</p>"
},
"Handler":{
"shape":"NonEmptyString",
"documentation":"<p>The function that Lambda calls to begin executing your function.</p>"
},
"KmsKeyArn":{
"shape":"NonEmptyString",
"documentation":"<p>The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.</p>"
},
"LastModified":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the function was last updated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Layers":{
"shape":"AwsLambdaFunctionLayerList",
"documentation":"<p>The function's layers.</p>"
},
"MasterArn":{
"shape":"NonEmptyString",
"documentation":"<p>For Lambda@Edge functions, the ARN of the master function.</p>"
},
"MemorySize":{
"shape":"Integer",
"documentation":"<p>The memory that's allocated to the function.</p>"
},
"RevisionId":{
"shape":"NonEmptyString",
"documentation":"<p>The latest updated revision of the function or alias.</p>"
},
"Role":{
"shape":"NonEmptyString",
"documentation":"<p>The function's execution role.</p>"
},
"Runtime":{
"shape":"NonEmptyString",
"documentation":"<p>The runtime environment for the Lambda function.</p>"
},
"Timeout":{
"shape":"Integer",
"documentation":"<p>The amount of time that Lambda allows a function to run before stopping it.</p>"
},
"TracingConfig":{
"shape":"AwsLambdaFunctionTracingConfig",
"documentation":"<p>The function's AWS X-Ray tracing configuration.</p>"
},
"VpcConfig":{
"shape":"AwsLambdaFunctionVpcConfig",
"documentation":"<p>The function's networking configuration.</p>"
},
"Version":{
"shape":"NonEmptyString",
"documentation":"<p>The version of the Lambda function.</p>"
}
},
"documentation":"<p>Details about a function's configuration.</p>"
},
"AwsLambdaFunctionEnvironment":{
"type":"structure",
"members":{
"Variables":{
"shape":"FieldMap",
"documentation":"<p>Environment variable key-value pairs.</p>"
},
"Error":{
"shape":"AwsLambdaFunctionEnvironmentError",
"documentation":"<p>An <code>AwsLambdaFunctionEnvironmentError</code> object.</p>"
}
},
"documentation":"<p>A function's environment variable settings.</p>"
},
"AwsLambdaFunctionEnvironmentError":{
"type":"structure",
"members":{
"ErrorCode":{
"shape":"NonEmptyString",
"documentation":"<p>The error code.</p>"
},
"Message":{
"shape":"NonEmptyString",
"documentation":"<p>The error message.</p>"
}
},
"documentation":"<p>Error messages for environment variables that couldn't be applied.</p>"
},
"AwsLambdaFunctionLayer":{
"type":"structure",
"members":{
"Arn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the function layer.</p>"
},
"CodeSize":{
"shape":"Integer",
"documentation":"<p>The size of the layer archive in bytes.</p>"
}
},
"documentation":"<p>An AWS Lambda layer.</p>"
},
"AwsLambdaFunctionLayerList":{
"type":"list",
"member":{"shape":"AwsLambdaFunctionLayer"}
},
"AwsLambdaFunctionTracingConfig":{
"type":"structure",
"members":{
"Mode":{
"shape":"NonEmptyString",
"documentation":"<p>The tracing mode.</p>"
}
},
"documentation":"<p>The function's AWS X-Ray tracing configuration.</p>"
},
"AwsLambdaFunctionVpcConfig":{
"type":"structure",
"members":{
"SecurityGroupIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of VPC security groups IDs.</p>"
},
"SubnetIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of VPC subnet IDs.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC.</p>"
}
},
"documentation":"<p>The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.</p>"
},
"AwsLambdaLayerVersionDetails":{
"type":"structure",
"members":{
"Version":{
"shape":"AwsLambdaLayerVersionNumber",
"documentation":"<p>The version number.</p>"
},
"CompatibleRuntimes":{
"shape":"NonEmptyStringList",
"documentation":"<p>The layer's compatible runtimes. Maximum number of five items.</p> <p>Valid values: <code>nodejs10.x</code> | <code>nodejs12.x</code> | <code>java8</code> | <code>java11</code> | <code>python2.7</code> | <code>python3.6</code> | <code>python3.7</code> | <code>python3.8</code> | <code>dotnetcore1.0</code> | <code>dotnetcore2.1</code> | <code>go1.x</code> | <code>ruby2.5</code> | <code>provided</code> </p>"
},
"CreatedDate":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the version was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>Details about a Lambda layer version.</p>"
},
"AwsLambdaLayerVersionNumber":{"type":"long"},
"AwsRdsDbClusterAssociatedRole":{
"type":"structure",
"members":{
"RoleArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the IAM role.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the association between the IAM role and the DB cluster.</p>"
}
},
"documentation":"<p>An IAM role that is associated with the Amazon RDS DB cluster.</p>"
},
"AwsRdsDbClusterAssociatedRoles":{
"type":"list",
"member":{"shape":"AwsRdsDbClusterAssociatedRole"}
},
"AwsRdsDbClusterDetails":{
"type":"structure",
"members":{
"AllocatedStorage":{
"shape":"Integer",
"documentation":"<p>For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).</p>"
},
"AvailabilityZones":{
"shape":"StringList",
"documentation":"<p>A list of Availability Zones (AZs) where instances in the DB cluster can be created.</p>"
},
"BackupRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The number of days for which automated backups are retained.</p>"
},
"DatabaseName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the database.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The current status of this DB cluster.</p>"
},
"Endpoint":{
"shape":"NonEmptyString",
"documentation":"<p>The connection endpoint for the primary instance of the DB cluster.</p>"
},
"ReaderEndpoint":{
"shape":"NonEmptyString",
"documentation":"<p>The reader endpoint for the DB cluster.</p>"
},
"CustomEndpoints":{
"shape":"StringList",
"documentation":"<p>A list of custom endpoints for the DB cluster.</p>"
},
"MultiAz":{
"shape":"Boolean",
"documentation":"<p>Whether the DB cluster has instances in multiple Availability Zones.</p>"
},
"Engine":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the database engine to use for this DB cluster.</p>"
},
"EngineVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The version number of the database engine to use.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>The port number on which the DB instances in the DB cluster accept connections.</p>"
},
"MasterUsername":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the master user for the DB cluster.</p>"
},
"PreferredBackupWindow":{
"shape":"NonEmptyString",
"documentation":"<p>The range of time each day when automated backups are created, if automated backups are enabled.</p> <p>Uses the format <code>HH:MM-HH:MM</code>. For example, <code>04:52-05:22</code>.</p>"
},
"PreferredMaintenanceWindow":{
"shape":"NonEmptyString",
"documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Uses the format <code>&lt;day&gt;:HH:MM-&lt;day&gt;:HH:MM</code>.</p> <p>For the day values, use <code>mon</code>|<code>tue</code>|<code>wed</code>|<code>thu</code>|<code>fri</code>|<code>sat</code>|<code>sun</code>.</p> <p>For example, <code>sun:09:32-sun:10:02</code>.</p>"
},
"ReadReplicaIdentifiers":{
"shape":"StringList",
"documentation":"<p>The identifiers of the read replicas that are associated with this DB cluster.</p>"
},
"VpcSecurityGroups":{
"shape":"AwsRdsDbInstanceVpcSecurityGroups",
"documentation":"<p>A list of VPC security groups that the DB cluster belongs to.</p>"
},
"HostedZoneId":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.</p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Whether the DB cluster is encrypted.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the AWS KMS master key that is used to encrypt the database instances in the DB cluster.</p>"
},
"DbClusterResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the DB cluster. The identifier must be unique within each AWS Region and is immutable.</p>"
},
"AssociatedRoles":{
"shape":"AwsRdsDbClusterAssociatedRoles",
"documentation":"<p>A list of the IAM roles that are associated with the DB cluster.</p>"
},
"ClusterCreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"EnabledCloudWatchLogsExports":{
"shape":"StringList",
"documentation":"<p>A list of log types that this DB cluster is configured to export to CloudWatch Logs.</p>"
},
"EngineMode":{
"shape":"NonEmptyString",
"documentation":"<p>The database engine mode of the DB cluster.</p>"
},
"DeletionProtection":{
"shape":"Boolean",
"documentation":"<p>Whether the DB cluster has deletion protection enabled.</p>"
},
"HttpEndpointEnabled":{
"shape":"Boolean",
"documentation":"<p>Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.</p>"
},
"ActivityStreamStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the database activity stream.</p>"
},
"CopyTagsToSnapshot":{
"shape":"Boolean",
"documentation":"<p>Whether tags are copied from the DB cluster to snapshots of the DB cluster.</p>"
},
"CrossAccountClone":{
"shape":"Boolean",
"documentation":"<p>Whether the DB cluster is a clone of a DB cluster owned by a different AWS account.</p>"
},
"DomainMemberships":{
"shape":"AwsRdsDbDomainMemberships",
"documentation":"<p>The Active Directory domain membership records that are associated with the DB cluster.</p>"
},
"DbClusterParameterGroup":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the DB cluster parameter group for the DB cluster.</p>"
},
"DbSubnetGroup":{
"shape":"NonEmptyString",
"documentation":"<p>The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.</p>"
},
"DbClusterOptionGroupMemberships":{
"shape":"AwsRdsDbClusterOptionGroupMemberships",
"documentation":"<p>The list of option group memberships for this DB cluster.</p>"
},
"DbClusterIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.</p>"
},
"DbClusterMembers":{
"shape":"AwsRdsDbClusterMembers",
"documentation":"<p>The list of instances that make up the DB cluster.</p>"
},
"IamDatabaseAuthenticationEnabled":{
"shape":"Boolean",
"documentation":"<p>Whether the mapping of IAM accounts to database accounts is enabled.</p>"
}
},
"documentation":"<p>Information about an Amazon RDS DB cluster.</p>"
},
"AwsRdsDbClusterMember":{
"type":"structure",
"members":{
"IsClusterWriter":{
"shape":"Boolean",
"documentation":"<p>Whether the cluster member is the primary instance for the DB cluster.</p>"
},
"PromotionTier":{
"shape":"Integer",
"documentation":"<p>Specifies the order in which an Aurora replica is promoted to the primary instance when the existing primary instance fails.</p>"
},
"DbInstanceIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The instance identifier for this member of the DB cluster.</p>"
},
"DbClusterParameterGroupStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the DB cluster parameter group for this member of the DB cluster.</p>"
}
},
"documentation":"<p>Information about an instance in the DB cluster.</p>"
},
"AwsRdsDbClusterMembers":{
"type":"list",
"member":{"shape":"AwsRdsDbClusterMember"}
},
"AwsRdsDbClusterOptionGroupMembership":{
"type":"structure",
"members":{
"DbClusterOptionGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the DB cluster option group.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the DB cluster option group.</p>"
}
},
"documentation":"<p>Information about an option group membership for a DB cluster.</p>"
},
"AwsRdsDbClusterOptionGroupMemberships":{
"type":"list",
"member":{"shape":"AwsRdsDbClusterOptionGroupMembership"}
},
"AwsRdsDbClusterSnapshotDetails":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"StringList",
"documentation":"<p>A list of Availability Zones where instances in the DB cluster can be created.</p>"
},
"SnapshotCreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the snapshot was taken.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Engine":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the database engine that you want to use for this DB instance.</p>"
},
"AllocatedStorage":{
"shape":"Integer",
"documentation":"<p>Specifies the allocated storage size in gibibytes (GiB).</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of this DB cluster snapshot.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>The port number on which the DB instances in the DB cluster accept connections.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The VPC ID that is associated with the DB cluster snapshot.</p>"
},
"ClusterCreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"MasterUsername":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the master user for the DB cluster.</p>"
},
"EngineVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The version of the database engine to use.</p>"
},
"LicenseModel":{
"shape":"NonEmptyString",
"documentation":"<p>The license model information for this DB cluster snapshot.</p>"
},
"SnapshotType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of DB cluster snapshot.</p>"
},
"PercentProgress":{
"shape":"Integer",
"documentation":"<p>Specifies the percentage of the estimated data that has been transferred.</p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Whether the DB cluster is encrypted.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the AWS KMS master key that is used to encrypt the database instances in the DB cluster.</p>"
},
"DbClusterIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The DB cluster identifier.</p>"
},
"DbClusterSnapshotIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the DB cluster snapshot.</p>"
},
"IamDatabaseAuthenticationEnabled":{
"shape":"Boolean",
"documentation":"<p>Whether mapping of IAM accounts to database accounts is enabled.</p>"
}
},
"documentation":"<p>Information about an Amazon RDS DB cluster snapshot.</p>"
},
"AwsRdsDbDomainMembership":{
"type":"structure",
"members":{
"Domain":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the Active Directory domain.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the Active Directory Domain membership for the DB instance.</p>"
},
"Fqdn":{
"shape":"NonEmptyString",
"documentation":"<p>The fully qualified domain name of the Active Directory domain.</p>"
},
"IamRoleName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the IAM role to use when making API calls to the Directory Service.</p>"
}
},
"documentation":"<p>Information about an Active Directory domain membership record associated with the DB instance.</p>"
},
"AwsRdsDbDomainMemberships":{
"type":"list",
"member":{"shape":"AwsRdsDbDomainMembership"}
},
"AwsRdsDbInstanceAssociatedRole":{
"type":"structure",
"members":{
"RoleArn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.</p>"
},
"FeatureName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the feature associated with the IAM)role.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>Describes the state of the association between the IAM role and the DB instance. The <code>Status</code> property returns one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf.</p> </li> <li> <p> <code>PENDING</code> - The IAM role ARN is being associated with the DB instance.</p> </li> <li> <p> <code>INVALID</code> - The IAM role ARN is associated with the DB instance. But the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf. </p> </li> </ul>"
}
},
"documentation":"<p>An AWS Identity and Access Management (IAM) role associated with the DB instance.</p>"
},
"AwsRdsDbInstanceAssociatedRoles":{
"type":"list",
"member":{"shape":"AwsRdsDbInstanceAssociatedRole"}
},
"AwsRdsDbInstanceDetails":{
"type":"structure",
"members":{
"AssociatedRoles":{
"shape":"AwsRdsDbInstanceAssociatedRoles",
"documentation":"<p>The AWS Identity and Access Management (IAM) roles associated with the DB instance.</p>"
},
"CACertificateIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the CA certificate for this DB instance.</p>"
},
"DBClusterIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.</p>"
},
"DBInstanceIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.</p>"
},
"DBInstanceClass":{
"shape":"NonEmptyString",
"documentation":"<p>Contains the name of the compute and memory capacity class of the DB instance.</p>"
},
"DbInstancePort":{
"shape":"Integer",
"documentation":"<p>Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.</p>"
},
"DbiResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. </p>"
},
"DBName":{
"shape":"NonEmptyString",
"documentation":"<p>The meaning of this parameter differs according to the database engine you use.</p> <p> <b>MySQL, MariaDB, SQL Server, PostgreSQL</b> </p> <p>Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.</p> <p> <b>Oracle</b> </p> <p>Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance. </p>"
},
"DeletionProtection":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the DB instance has deletion protection enabled.</p> <p>When deletion protection is enabled, the database cannot be deleted.</p>"
},
"Endpoint":{
"shape":"AwsRdsDbInstanceEndpoint",
"documentation":"<p>Specifies the connection endpoint.</p>"
},
"Engine":{
"shape":"NonEmptyString",
"documentation":"<p>Provides the name of the database engine to use for this DB instance.</p>"
},
"EngineVersion":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates the database engine version.</p>"
},
"IAMDatabaseAuthenticationEnabled":{
"shape":"Boolean",
"documentation":"<p>True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.</p> <p>IAM database authentication can be enabled for the following database engines.</p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> <li> <p>Aurora 5.6 or higher</p> </li> </ul>"
},
"InstanceCreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the DB instance was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>If <code>StorageEncrypted</code> is true, the AWS KMS key identifier for the encrypted DB instance.</p>"
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":"<p>Specifies the accessibility options for the DB instance.</p> <p>A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.</p> <p>A value of false specifies an internal instance with a DNS name that resolves to a private IP address. </p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB instance is encrypted.</p>"
},
"TdeCredentialArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN from the key store with which the instance is associated for TDE encryption.</p>"
},
"VpcSecurityGroups":{
"shape":"AwsRdsDbInstanceVpcSecurityGroups",
"documentation":"<p>A list of VPC security groups that the DB instance belongs to.</p>"
},
"MultiAz":{
"shape":"Boolean",
"documentation":"<p>Whether the DB instance is a multiple Availability Zone deployment.</p>"
},
"EnhancedMonitoringResourceArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.</p>"
},
"DbInstanceStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The current status of the DB instance.</p>"
},
"MasterUsername":{
"shape":"NonEmptyString",
"documentation":"<p>The master user name of the DB instance.</p>"
},
"AllocatedStorage":{
"shape":"Integer",
"documentation":"<p>The amount of storage (in gigabytes) to initially allocate for the DB instance.</p>"
},
"PreferredBackupWindow":{
"shape":"NonEmptyString",
"documentation":"<p>The range of time each day when automated backups are created, if automated backups are enabled.</p> <p>Uses the format <code>HH:MM-HH:MM</code>. For example, <code>04:52-05:22</code>.</p>"
},
"BackupRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The number of days for which to retain automated backups.</p>"
},
"DbSecurityGroups":{
"shape":"StringList",
"documentation":"<p>A list of the DB security groups to assign to the DB instance.</p>"
},
"DbParameterGroups":{
"shape":"AwsRdsDbParameterGroups",
"documentation":"<p>A list of the DB parameter groups to assign to the DB instance.</p>"
},
"AvailabilityZone":{
"shape":"NonEmptyString",
"documentation":"<p>The Availability Zone where the DB instance will be created.</p>"
},
"DbSubnetGroup":{
"shape":"AwsRdsDbSubnetGroup",
"documentation":"<p>Information about the subnet group that is associated with the DB instance.</p>"
},
"PreferredMaintenanceWindow":{
"shape":"NonEmptyString",
"documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Uses the format <code>&lt;day&gt;:HH:MM-&lt;day&gt;:HH:MM</code>.</p> <p>For the day values, use <code>mon</code>|<code>tue</code>|<code>wed</code>|<code>thu</code>|<code>fri</code>|<code>sat</code>|<code>sun</code>.</p> <p>For example, <code>sun:09:32-sun:10:02</code>.</p>"
},
"PendingModifiedValues":{
"shape":"AwsRdsDbPendingModifiedValues",
"documentation":"<p>Changes to the DB instance that are currently pending.</p>"
},
"LatestRestorableTime":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies the latest time to which a database can be restored with point-in-time restore.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"Boolean",
"documentation":"<p>Indicates whether minor version patches are applied automatically.</p>"
},
"ReadReplicaSourceDBInstanceIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>If this DB instance is a read replica, contains the identifier of the source DB instance.</p>"
},
"ReadReplicaDBInstanceIdentifiers":{
"shape":"StringList",
"documentation":"<p>List of identifiers of the read replicas associated with this DB instance.</p>"
},
"ReadReplicaDBClusterIdentifiers":{
"shape":"StringList",
"documentation":"<p>List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.</p>"
},
"LicenseModel":{
"shape":"NonEmptyString",
"documentation":"<p>License model information for this DB instance.</p>"
},
"Iops":{
"shape":"Integer",
"documentation":"<p>Specifies the provisioned IOPS (I/O operations per second) for this DB instance.</p>"
},
"OptionGroupMemberships":{
"shape":"AwsRdsDbOptionGroupMemberships",
"documentation":"<p>The list of option group memberships for this DB instance.</p>"
},
"CharacterSetName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the character set that this DB instance is associated with.</p>"
},
"SecondaryAvailabilityZone":{
"shape":"NonEmptyString",
"documentation":"<p>For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.</p>"
},
"StatusInfos":{
"shape":"AwsRdsDbStatusInfos",
"documentation":"<p>The status of a read replica. If the instance isn't a read replica, this is empty.</p>"
},
"StorageType":{
"shape":"NonEmptyString",
"documentation":"<p>The storage type for the DB instance.</p>"
},
"DomainMemberships":{
"shape":"AwsRdsDbDomainMemberships",
"documentation":"<p>The Active Directory domain membership records associated with the DB instance.</p>"
},
"CopyTagsToSnapshot":{
"shape":"Boolean",
"documentation":"<p>Whether to copy resource tags to snapshots of the DB instance.</p>"
},
"MonitoringInterval":{
"shape":"Integer",
"documentation":"<p>The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.</p>"
},
"MonitoringRoleArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.</p>"
},
"PromotionTier":{
"shape":"Integer",
"documentation":"<p>The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.</p>"
},
"Timezone":{
"shape":"NonEmptyString",
"documentation":"<p>The time zone of the DB instance.</p>"
},
"PerformanceInsightsEnabled":{
"shape":"Boolean",
"documentation":"<p>Indicates whether Performance Insights is enabled for the DB instance.</p>"
},
"PerformanceInsightsKmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the AWS KMS key used to encrypt the Performance Insights data.</p>"
},
"PerformanceInsightsRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The number of days to retain Performance Insights data.</p>"
},
"EnabledCloudWatchLogsExports":{
"shape":"StringList",
"documentation":"<p>A list of log types that this DB instance is configured to export to CloudWatch Logs.</p>"
},
"ProcessorFeatures":{
"shape":"AwsRdsDbProcessorFeatures",
"documentation":"<p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>"
},
"ListenerEndpoint":{"shape":"AwsRdsDbInstanceEndpoint"},
"MaxAllocatedStorage":{
"shape":"Integer",
"documentation":"<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>"
}
},
"documentation":"<p>Contains the details of an Amazon RDS DB instance.</p>"
},
"AwsRdsDbInstanceEndpoint":{
"type":"structure",
"members":{
"Address":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies the DNS address of the DB instance.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>Specifies the port that the database engine is listening on.</p>"
},
"HostedZoneId":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>"
}
},
"documentation":"<p>Specifies the connection endpoint.</p>"
},
"AwsRdsDbInstanceVpcSecurityGroup":{
"type":"structure",
"members":{
"VpcSecurityGroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the VPC security group.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the VPC security group.</p>"
}
},
"documentation":"<p>A VPC security groups that the DB instance belongs to.</p>"
},
"AwsRdsDbInstanceVpcSecurityGroups":{
"type":"list",
"member":{"shape":"AwsRdsDbInstanceVpcSecurityGroup"}
},
"AwsRdsDbOptionGroupMembership":{
"type":"structure",
"members":{
"OptionGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the option group.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the option group membership.</p>"
}
},
"documentation":"<p>An option group membership.</p>"
},
"AwsRdsDbOptionGroupMemberships":{
"type":"list",
"member":{"shape":"AwsRdsDbOptionGroupMembership"}
},
"AwsRdsDbParameterGroup":{
"type":"structure",
"members":{
"DbParameterGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the parameter group.</p>"
},
"ParameterApplyStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of parameter updates.</p>"
}
},
"documentation":"<p>Provides information about a parameter group for a DB instance.</p>"
},
"AwsRdsDbParameterGroups":{
"type":"list",
"member":{"shape":"AwsRdsDbParameterGroup"}
},
"AwsRdsDbPendingModifiedValues":{
"type":"structure",
"members":{
"DbInstanceClass":{
"shape":"NonEmptyString",
"documentation":"<p>The new DB instance class for the DB instance.</p>"
},
"AllocatedStorage":{
"shape":"Integer",
"documentation":"<p>The new value of the allocated storage for the DB instance.</p>"
},
"MasterUserPassword":{
"shape":"NonEmptyString",
"documentation":"<p>The new master user password for the DB instance.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>The new port for the DB instance.</p>"
},
"BackupRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The new backup retention period for the DB instance.</p>"
},
"MultiAZ":{
"shape":"Boolean",
"documentation":"<p>Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.</p>"
},
"EngineVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The new engine version for the DB instance.</p>"
},
"LicenseModel":{
"shape":"NonEmptyString",
"documentation":"<p>The new license model value for the DB instance.</p>"
},
"Iops":{
"shape":"Integer",
"documentation":"<p>The new provisioned IOPS value for the DB instance.</p>"
},
"DbInstanceIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The new DB instance identifier for the DB instance.</p>"
},
"StorageType":{
"shape":"NonEmptyString",
"documentation":"<p>The new storage type for the DB instance.</p>"
},
"CaCertificateIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The new CA certificate identifier for the DB instance.</p>"
},
"DbSubnetGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the new subnet group for the DB instance.</p>"
},
"PendingCloudWatchLogsExports":{
"shape":"AwsRdsPendingCloudWatchLogsExports",
"documentation":"<p>A list of log types that are being enabled or disabled.</p>"
},
"ProcessorFeatures":{
"shape":"AwsRdsDbProcessorFeatures",
"documentation":"<p>Processor features that are being updated.</p>"
}
},
"documentation":"<p>Changes to a DB instance that are currently pending.</p>"
},
"AwsRdsDbProcessorFeature":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the processor feature.</p>"
},
"Value":{
"shape":"NonEmptyString",
"documentation":"<p>The value of the processor feature.</p>"
}
},
"documentation":"<p>A processor feature.</p>"
},
"AwsRdsDbProcessorFeatures":{
"type":"list",
"member":{"shape":"AwsRdsDbProcessorFeature"}
},
"AwsRdsDbSnapshotDetails":{
"type":"structure",
"members":{
"DbSnapshotIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The name or ARN of the DB snapshot that is used to restore the DB instance.</p>"
},
"DbInstanceIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>A name for the DB instance.</p>"
},
"SnapshotCreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>When the snapshot was taken in Coordinated Universal Time (UTC).</p>"
},
"Engine":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the database engine to use for this DB instance.</p>"
},
"AllocatedStorage":{
"shape":"Integer",
"documentation":"<p>The amount of storage (in gigabytes) to be initially allocated for the database instance.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of this DB snapshot.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>The port that the database engine was listening on at the time of the snapshot.</p>"
},
"AvailabilityZone":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The VPC ID associated with the DB snapshot.</p>"
},
"InstanceCreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.</p>"
},
"MasterUsername":{
"shape":"NonEmptyString",
"documentation":"<p>The master user name for the DB snapshot.</p>"
},
"EngineVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The version of the database engine.</p>"
},
"LicenseModel":{
"shape":"NonEmptyString",
"documentation":"<p>License model information for the restored DB instance.</p>"
},
"SnapshotType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of the DB snapshot.</p>"
},
"Iops":{
"shape":"Integer",
"documentation":"<p>The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.</p>"
},
"OptionGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The option group name for the DB snapshot.</p>"
},
"PercentProgress":{
"shape":"Integer",
"documentation":"<p>The percentage of the estimated data that has been transferred.</p>"
},
"SourceRegion":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS Region that the DB snapshot was created in or copied from.</p>"
},
"SourceDbSnapshotIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The DB snapshot ARN that the DB snapshot was copied from.</p>"
},
"StorageType":{
"shape":"NonEmptyString",
"documentation":"<p>The storage type associated with the DB snapshot.</p>"
},
"TdeCredentialArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN from the key store with which to associate the instance for TDE encryption.</p>"
},
"Encrypted":{
"shape":"Boolean",
"documentation":"<p>Whether the DB snapshot is encrypted.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>If <code>Encrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted DB snapshot.</p>"
},
"Timezone":{
"shape":"NonEmptyString",
"documentation":"<p>The time zone of the DB snapshot.</p>"
},
"IamDatabaseAuthenticationEnabled":{
"shape":"Boolean",
"documentation":"<p>Whether mapping of IAM accounts to database accounts is enabled.</p>"
},
"ProcessorFeatures":{
"shape":"AwsRdsDbProcessorFeatures",
"documentation":"<p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.</p>"
},
"DbiResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier for the source DB instance.</p>"
}
},
"documentation":"<p>Provides details about an Amazon RDS DB cluster snapshot.</p>"
},
"AwsRdsDbStatusInfo":{
"type":"structure",
"members":{
"StatusType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of status. For a read replica, the status type is read replication.</p>"
},
"Normal":{
"shape":"Boolean",
"documentation":"<p>Whether the read replica instance is operating normally.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the read replica instance.</p>"
},
"Message":{
"shape":"NonEmptyString",
"documentation":"<p>If the read replica is currently in an error state, provides the error details.</p>"
}
},
"documentation":"<p>Information about the status of a read replica.</p>"
},
"AwsRdsDbStatusInfos":{
"type":"list",
"member":{"shape":"AwsRdsDbStatusInfo"}
},
"AwsRdsDbSubnetGroup":{
"type":"structure",
"members":{
"DbSubnetGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the subnet group.</p>"
},
"DbSubnetGroupDescription":{
"shape":"NonEmptyString",
"documentation":"<p>The description of the subnet group.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The VPC ID of the subnet group.</p>"
},
"SubnetGroupStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the subnet group.</p>"
},
"Subnets":{
"shape":"AwsRdsDbSubnetGroupSubnets",
"documentation":"<p>A list of subnets in the subnet group.</p>"
},
"DbSubnetGroupArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the subnet group.</p>"
}
},
"documentation":"<p>Information about the subnet group for the database instance.</p>"
},
"AwsRdsDbSubnetGroupSubnet":{
"type":"structure",
"members":{
"SubnetIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of a subnet in the subnet group.</p>"
},
"SubnetAvailabilityZone":{
"shape":"AwsRdsDbSubnetGroupSubnetAvailabilityZone",
"documentation":"<p>Information about the Availability Zone for a subnet in the subnet group.</p>"
},
"SubnetStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of a subnet in the subnet group.</p>"
}
},
"documentation":"<p>Information about a subnet in a subnet group.</p>"
},
"AwsRdsDbSubnetGroupSubnetAvailabilityZone":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the Availability Zone for a subnet in the subnet group.</p>"
}
},
"documentation":"<p>An Availability Zone for a subnet in a subnet group.</p>"
},
"AwsRdsDbSubnetGroupSubnets":{
"type":"list",
"member":{"shape":"AwsRdsDbSubnetGroupSubnet"}
},
"AwsRdsPendingCloudWatchLogsExports":{
"type":"structure",
"members":{
"LogTypesToEnable":{
"shape":"StringList",
"documentation":"<p>A list of log types that are being enabled.</p>"
},
"LogTypesToDisable":{
"shape":"StringList",
"documentation":"<p>A list of log types that are being disabled.</p>"
}
},
"documentation":"<p>Identifies the log types to enable and disable.</p>"
},
"AwsRedshiftClusterClusterNode":{
"type":"structure",
"members":{
"NodeRole":{
"shape":"NonEmptyString",
"documentation":"<p>The role of the node. A node might be a leader node or a compute node.</p>"
},
"PrivateIpAddress":{
"shape":"NonEmptyString",
"documentation":"<p>The private IP address of the node.</p>"
},
"PublicIpAddress":{
"shape":"NonEmptyString",
"documentation":"<p>The public IP address of the node.</p>"
}
},
"documentation":"<p>A node in an Amazon Redshift cluster.</p>"
},
"AwsRedshiftClusterClusterNodes":{
"type":"list",
"member":{"shape":"AwsRedshiftClusterClusterNode"}
},
"AwsRedshiftClusterClusterParameterGroup":{
"type":"structure",
"members":{
"ClusterParameterStatusList":{
"shape":"AwsRedshiftClusterClusterParameterStatusList",
"documentation":"<p>The list of parameter statuses.</p>"
},
"ParameterApplyStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of updates to the parameters.</p>"
},
"ParameterGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the parameter group.</p>"
}
},
"documentation":"<p>A cluster parameter group that is associated with an Amazon Redshift cluster.</p>"
},
"AwsRedshiftClusterClusterParameterGroups":{
"type":"list",
"member":{"shape":"AwsRedshiftClusterClusterParameterGroup"}
},
"AwsRedshiftClusterClusterParameterStatus":{
"type":"structure",
"members":{
"ParameterName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the parameter.</p>"
},
"ParameterApplyStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the parameter. Indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when it was applied.</p> <p>Valid values: <code>in-sync</code> | <code>pending-reboot</code> | <code>applying</code> | <code>invalid-parameter</code> | <code>apply-deferred</code> | <code>apply-error</code> | <code>unknown-error</code> </p>"
},
"ParameterApplyErrorDescription":{
"shape":"NonEmptyString",
"documentation":"<p>The error that prevented the parameter from being applied to the database.</p>"
}
},
"documentation":"<p>The status of a parameter in a cluster parameter group for an Amazon Redshift cluster.</p>"
},
"AwsRedshiftClusterClusterParameterStatusList":{
"type":"list",
"member":{"shape":"AwsRedshiftClusterClusterParameterStatus"}
},
"AwsRedshiftClusterClusterSecurityGroup":{
"type":"structure",
"members":{
"ClusterSecurityGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the cluster security group.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the cluster security group.</p>"
}
},
"documentation":"<p>A security group that is associated with the cluster.</p>"
},
"AwsRedshiftClusterClusterSecurityGroups":{
"type":"list",
"member":{"shape":"AwsRedshiftClusterClusterSecurityGroup"}
},
"AwsRedshiftClusterClusterSnapshotCopyStatus":{
"type":"structure",
"members":{
"DestinationRegion":{
"shape":"NonEmptyString",
"documentation":"<p>The destination Region that snapshots are automatically copied to when cross-Region snapshot copy is enabled.</p>"
},
"ManualSnapshotRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The number of days that manual snapshots are retained in the destination region after they are copied from a source region.</p> <p>If the value is -1, then the manual snapshot is retained indefinitely.</p> <p>Valid values: Either -1 or an integer between 1 and 3,653</p>"
},
"RetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The number of days to retain automated snapshots in the destination Region after they are copied from a source Region.</p>"
},
"SnapshotCopyGrantName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the snapshot copy grant.</p>"
}
},
"documentation":"<p>Information about a cross-Region snapshot copy.</p>"
},
"AwsRedshiftClusterDeferredMaintenanceWindow":{
"type":"structure",
"members":{
"DeferMaintenanceEndTime":{
"shape":"NonEmptyString",
"documentation":"<p>The end of the time window for which maintenance was deferred.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"DeferMaintenanceIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the maintenance window.</p>"
},
"DeferMaintenanceStartTime":{
"shape":"NonEmptyString",
"documentation":"<p>The start of the time window for which maintenance was deferred.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>A time windows during which maintenance was deferred for an Amazon Redshift cluster.</p>"
},
"AwsRedshiftClusterDeferredMaintenanceWindows":{
"type":"list",
"member":{"shape":"AwsRedshiftClusterDeferredMaintenanceWindow"}
},
"AwsRedshiftClusterDetails":{
"type":"structure",
"members":{
"AllowVersionUpgrade":{
"shape":"Boolean",
"documentation":"<p>Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.</p>"
},
"AutomatedSnapshotRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The number of days that automatic cluster snapshots are retained.</p>"
},
"AvailabilityZone":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the Availability Zone in which the cluster is located.</p>"
},
"ClusterAvailabilityStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The availability status of the cluster for queries. Possible values are the following:</p> <ul> <li> <p> <code>Available</code> - The cluster is available for queries.</p> </li> <li> <p> <code>Unavailable</code> - The cluster is not available for queries.</p> </li> <li> <p> <code>Maintenance</code> - The cluster is intermittently available for queries due to maintenance activities.</p> </li> <li> <p> <code>Modifying</code> -The cluster is intermittently available for queries due to changes that modify the cluster.</p> </li> <li> <p> <code>Failed</code> - The cluster failed and is not available for queries.</p> </li> </ul>"
},
"ClusterCreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the cluster was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"ClusterIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The unique identifier of the cluster.</p>"
},
"ClusterNodes":{
"shape":"AwsRedshiftClusterClusterNodes",
"documentation":"<p>The nodes in the cluster.</p>"
},
"ClusterParameterGroups":{
"shape":"AwsRedshiftClusterClusterParameterGroups",
"documentation":"<p>The list of cluster parameter groups that are associated with this cluster.</p>"
},
"ClusterPublicKey":{
"shape":"NonEmptyString",
"documentation":"<p>The public key for the cluster.</p>"
},
"ClusterRevisionNumber":{
"shape":"NonEmptyString",
"documentation":"<p>The specific revision number of the database in the cluster.</p>"
},
"ClusterSecurityGroups":{
"shape":"AwsRedshiftClusterClusterSecurityGroups",
"documentation":"<p>A list of cluster security groups that are associated with the cluster.</p>"
},
"ClusterSnapshotCopyStatus":{
"shape":"AwsRedshiftClusterClusterSnapshotCopyStatus",
"documentation":"<p>Information about the destination Region and retention period for the cross-Region snapshot copy.</p>"
},
"ClusterStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The current status of the cluster.</p> <p>Valid values: <code>available</code> | <code>available, prep-for-resize</code> | <code>available, resize-cleanup</code> |<code> cancelling-resize</code> | <code>creating</code> | <code>deleting</code> | <code>final-snapshot</code> | <code>hardware-failure</code> | <code>incompatible-hsm</code> |<code> incompatible-network</code> | <code>incompatible-parameters</code> | <code>incompatible-restore</code> | <code>modifying</code> | <code>paused</code> | <code>rebooting</code> | <code>renaming</code> | <code>resizing</code> | <code>rotating-keys</code> | <code>storage-full</code> | <code>updating-hsm</code> </p>"
},
"ClusterSubnetGroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.</p>"
},
"ClusterVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The version ID of the Amazon Redshift engine that runs on the cluster.</p>"
},
"DBName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the initial database that was created when the cluster was created.</p> <p>The same name is returned for the life of the cluster.</p> <p>If an initial database is not specified, a database named <code>devdev</code> is created by default.</p>"
},
"DeferredMaintenanceWindows":{
"shape":"AwsRedshiftClusterDeferredMaintenanceWindows",
"documentation":"<p>List of time windows during which maintenance was deferred.</p>"
},
"ElasticIpStatus":{
"shape":"AwsRedshiftClusterElasticIpStatus",
"documentation":"<p>Information about the status of the Elastic IP (EIP) address.</p>"
},
"ElasticResizeNumberOfNodeOptions":{
"shape":"NonEmptyString",
"documentation":"<p>The number of nodes that you can use the elastic resize method to resize the cluster to.</p>"
},
"Encrypted":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the data in the cluster is encrypted at rest.</p>"
},
"Endpoint":{
"shape":"AwsRedshiftClusterEndpoint",
"documentation":"<p>The connection endpoint.</p>"
},
"EnhancedVpcRouting":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to create the cluster with enhanced VPC routing enabled.</p>"
},
"ExpectedNextSnapshotScheduleTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"ExpectedNextSnapshotScheduleTimeStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the next expected snapshot.</p> <p>Valid values: <code>OnTrack</code> | <code>Pending</code> </p>"
},
"HsmStatus":{
"shape":"AwsRedshiftClusterHsmStatus",
"documentation":"<p>Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.</p>"
},
"IamRoles":{
"shape":"AwsRedshiftClusterIamRoles",
"documentation":"<p>A list of IAM roles that the cluster can use to access other AWS services.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the AWS KMS encryption key that is used to encrypt data in the cluster.</p>"
},
"MaintenanceTrackName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the maintenance track for the cluster.</p>"
},
"ManualSnapshotRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The default number of days to retain a manual snapshot.</p> <p>If the value is -1, the snapshot is retained indefinitely.</p> <p>This setting doesn't change the retention period of existing snapshots.</p> <p>Valid values: Either -1 or an integer between 1 and 3,653</p>"
},
"MasterUsername":{
"shape":"NonEmptyString",
"documentation":"<p>The master user name for the cluster. This name is used to connect to the database that is specified in as the value of <code>DBName</code>.</p>"
},
"NextMaintenanceWindowStartTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates the start of the next maintenance window.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"NodeType":{
"shape":"NonEmptyString",
"documentation":"<p>The node type for the nodes in the cluster.</p>"
},
"NumberOfNodes":{
"shape":"Integer",
"documentation":"<p>The number of compute nodes in the cluster.</p>"
},
"PendingActions":{
"shape":"StringList",
"documentation":"<p>A list of cluster operations that are waiting to start.</p>"
},
"PendingModifiedValues":{
"shape":"AwsRedshiftClusterPendingModifiedValues",
"documentation":"<p>A list of changes to the cluster that are currently pending.</p>"
},
"PreferredMaintenanceWindow":{
"shape":"NonEmptyString",
"documentation":"<p>The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.</p> <p>Format: <code> <i>&lt;day&gt;</i>:HH:MM-<i>&lt;day&gt;</i>:HH:MM</code> </p> <p>For the day values, use <code>mon</code> | <code>tue</code> | <code>wed</code> | <code>thu</code> | <code>fri</code> | <code>sat</code> | <code>sun</code> </p> <p>For example, <code>sun:09:32-sun:10:02</code> </p>"
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":"<p>Whether the cluster can be accessed from a public network.</p>"
},
"ResizeInfo":{
"shape":"AwsRedshiftClusterResizeInfo",
"documentation":"<p>Information about the resize operation for the cluster.</p>"
},
"RestoreStatus":{
"shape":"AwsRedshiftClusterRestoreStatus",
"documentation":"<p>Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.</p>"
},
"SnapshotScheduleIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>A unique identifier for the cluster snapshot schedule.</p>"
},
"SnapshotScheduleState":{
"shape":"NonEmptyString",
"documentation":"<p>The current state of the cluster snapshot schedule.</p> <p>Valid values: <code>MODIFYING</code> | <code>ACTIVE</code> | <code>FAILED</code> </p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the VPC that the cluster is in, if the cluster is in a VPC.</p>"
},
"VpcSecurityGroups":{
"shape":"AwsRedshiftClusterVpcSecurityGroups",
"documentation":"<p>The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.</p>"
}
},
"documentation":"<p>Details about an Amazon Redshift cluster.</p>"
},
"AwsRedshiftClusterElasticIpStatus":{
"type":"structure",
"members":{
"ElasticIp":{
"shape":"NonEmptyString",
"documentation":"<p>The elastic IP address for the cluster.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the elastic IP address.</p>"
}
},
"documentation":"<p>The status of the elastic IP (EIP) address for an Amazon Redshift cluster.</p>"
},
"AwsRedshiftClusterEndpoint":{
"type":"structure",
"members":{
"Address":{
"shape":"NonEmptyString",
"documentation":"<p>The DNS address of the cluster.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>The port that the database engine listens on.</p>"
}
},
"documentation":"<p>The connection endpoint for an Amazon Redshift cluster.</p>"
},
"AwsRedshiftClusterHsmStatus":{
"type":"structure",
"members":{
"HsmClientCertificateIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the HSM client certificate that the Amazon Redshift cluster uses to retrieve the data encryption keys that are stored in an HSM.</p>"
},
"HsmConfigurationIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the HSM configuration that contains the information that the Amazon Redshift cluster can use to retrieve and store keys in an HSM.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.</p> <p>Type: String</p> <p>Valid values: <code>active</code> | <code>applying</code> </p>"
}
},
"documentation":"<p>Information about whether an Amazon Redshift cluster finished applying any hardware changes to security module (HSM) settings that were specified in a modify cluster command.</p>"
},
"AwsRedshiftClusterIamRole":{
"type":"structure",
"members":{
"ApplyStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the IAM role's association with the cluster.</p> <p>Valid values: <code>in-sync</code> | <code>adding</code> | <code>removing</code> </p>"
},
"IamRoleArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the IAM role.</p>"
}
},
"documentation":"<p>An IAM role that the cluster can use to access other AWS services.</p>"
},
"AwsRedshiftClusterIamRoles":{
"type":"list",
"member":{"shape":"AwsRedshiftClusterIamRole"}
},
"AwsRedshiftClusterPendingModifiedValues":{
"type":"structure",
"members":{
"AutomatedSnapshotRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>The pending or in-progress change to the automated snapshot retention period.</p>"
},
"ClusterIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The pending or in-progress change to the identifier for the cluster.</p>"
},
"ClusterType":{
"shape":"NonEmptyString",
"documentation":"<p>The pending or in-progress change to the cluster type.</p>"
},
"ClusterVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The pending or in-progress change to the service version.</p>"
},
"EncryptionType":{
"shape":"NonEmptyString",
"documentation":"<p>The encryption type for a cluster.</p>"
},
"EnhancedVpcRouting":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to create the cluster with enhanced VPC routing enabled.</p>"
},
"MaintenanceTrackName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the maintenance track that the cluster changes to during the next maintenance window.</p>"
},
"MasterUserPassword":{
"shape":"NonEmptyString",
"documentation":"<p>The pending or in-progress change to the master user password for the cluster.</p>"
},
"NodeType":{
"shape":"NonEmptyString",
"documentation":"<p>The pending or in-progress change to the cluster's node type.</p>"
},
"NumberOfNodes":{
"shape":"Integer",
"documentation":"<p>The pending or in-progress change to the number of nodes in the cluster.</p>"
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":"<p>The pending or in-progress change to whether the cluster can be connected to from the public network.</p>"
}
},
"documentation":"<p>Changes to the Amazon Redshift cluster that are currently pending.</p>"
},
"AwsRedshiftClusterResizeInfo":{
"type":"structure",
"members":{
"AllowCancelResize":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the resize operation can be canceled.</p>"
},
"ResizeType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of resize operation.</p> <p>Valid values: <code>ClassicResize</code> </p>"
}
},
"documentation":"<p>Information about the resize operation for the cluster.</p>"
},
"AwsRedshiftClusterRestoreStatus":{
"type":"structure",
"members":{
"CurrentRestoreRateInMegaBytesPerSecond":{
"shape":"Double",
"documentation":"<p>The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.</p> <p>This field is only updated when you restore to DC2 and DS2 node types.</p>"
},
"ElapsedTimeInSeconds":{
"shape":"Long",
"documentation":"<p>The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.</p> <p>This field is only updated when you restore to DC2 and DS2 node types.</p>"
},
"EstimatedTimeToCompletionInSeconds":{
"shape":"Long",
"documentation":"<p>The estimate of the time remaining before the restore is complete. Returns 0 for a completed restore.</p> <p>This field is only updated when you restore to DC2 and DS2 node types.</p>"
},
"ProgressInMegaBytes":{
"shape":"Long",
"documentation":"<p>The number of megabytes that were transferred from snapshot storage.</p> <p>This field is only updated when you restore to DC2 and DS2 node types.</p>"
},
"SnapshotSizeInMegaBytes":{
"shape":"Long",
"documentation":"<p>The size of the set of snapshot data that was used to restore the cluster.</p> <p>This field is only updated when you restore to DC2 and DS2 node types.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the restore action.</p> <p>Valid values: <code>starting</code> | <code>restoring</code> | <code>completed</code> | <code>failed</code> </p>"
}
},
"documentation":"<p>Information about the status of a cluster restore action. It only applies if the cluster was created by restoring a snapshot.</p>"
},
"AwsRedshiftClusterVpcSecurityGroup":{
"type":"structure",
"members":{
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the VPC security group.</p>"
},
"VpcSecurityGroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the VPC security group.</p>"
}
},
"documentation":"<p>A VPC security group that the cluster belongs to, if the cluster is in a VPC.</p>"
},
"AwsRedshiftClusterVpcSecurityGroups":{
"type":"list",
"member":{"shape":"AwsRedshiftClusterVpcSecurityGroup"}
},
"AwsS3AccountPublicAccessBlockDetails":{
"type":"structure",
"members":{
"BlockPublicAcls":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).</p>"
},
"BlockPublicPolicy":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.</p>"
},
"IgnorePublicAcls":{
"shape":"Boolean",
"documentation":"<p>Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.</p>"
},
"RestrictPublicBuckets":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only AWS service principals and authorized users within the S3 bucket owner's account.</p>"
}
},
"documentation":"<p>provides information about the Amazon S3 Public Access Block configuration for accounts.</p>"
},
"AwsS3BucketDetails":{
"type":"structure",
"members":{
"OwnerId":{
"shape":"NonEmptyString",
"documentation":"<p>The canonical user ID of the owner of the S3 bucket.</p>"
},
"OwnerName":{
"shape":"NonEmptyString",
"documentation":"<p>The display name of the owner of the S3 bucket.</p>"
},
"CreatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the S3 bucket was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"ServerSideEncryptionConfiguration":{
"shape":"AwsS3BucketServerSideEncryptionConfiguration",
"documentation":"<p>The encryption rules that are applied to the S3 bucket.</p>"
},
"PublicAccessBlockConfiguration":{
"shape":"AwsS3AccountPublicAccessBlockDetails",
"documentation":"<p>Provides information about the Amazon S3 Public Access Block configuration for the S3 bucket.</p>"
}
},
"documentation":"<p>The details of an Amazon S3 bucket.</p>"
},
"AwsS3BucketServerSideEncryptionByDefault":{
"type":"structure",
"members":{
"SSEAlgorithm":{
"shape":"NonEmptyString",
"documentation":"<p>Server-side encryption algorithm to use for the default encryption.</p>"
},
"KMSMasterKeyID":{
"shape":"NonEmptyString",
"documentation":"<p>AWS KMS customer master key (CMK) ID to use for the default encryption.</p>"
}
},
"documentation":"<p>Specifies the default server-side encryption to apply to new objects in the bucket.</p>"
},
"AwsS3BucketServerSideEncryptionConfiguration":{
"type":"structure",
"members":{
"Rules":{
"shape":"AwsS3BucketServerSideEncryptionRules",
"documentation":"<p>The encryption rules that are applied to the S3 bucket.</p>"
}
},
"documentation":"<p>The encryption configuration for the S3 bucket.</p>"
},
"AwsS3BucketServerSideEncryptionRule":{
"type":"structure",
"members":{
"ApplyServerSideEncryptionByDefault":{
"shape":"AwsS3BucketServerSideEncryptionByDefault",
"documentation":"<p>Specifies the default server-side encryption to apply to new objects in the bucket. If a <code>PUT</code> object request doesn't specify any server-side encryption, this default encryption is applied.</p>"
}
},
"documentation":"<p>An encryption rule to apply to the S3 bucket.</p>"
},
"AwsS3BucketServerSideEncryptionRules":{
"type":"list",
"member":{"shape":"AwsS3BucketServerSideEncryptionRule"}
},
"AwsS3ObjectDetails":{
"type":"structure",
"members":{
"LastModified":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the object was last modified.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"ETag":{
"shape":"NonEmptyString",
"documentation":"<p>The opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>"
},
"VersionId":{
"shape":"NonEmptyString",
"documentation":"<p>The version of the object.</p>"
},
"ContentType":{
"shape":"NonEmptyString",
"documentation":"<p>A standard MIME type describing the format of the object data.</p>"
},
"ServerSideEncryption":{
"shape":"NonEmptyString",
"documentation":"<p>If the object is stored using server-side encryption, the value of the server-side encryption algorithm used when storing this object in Amazon S3.</p>"
},
"SSEKMSKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.</p>"
}
},
"documentation":"<p>Details about an Amazon S3 object.</p>"
},
"AwsSecretsManagerSecretDetails":{
"type":"structure",
"members":{
"RotationRules":{
"shape":"AwsSecretsManagerSecretRotationRules",
"documentation":"<p>Defines the rotation schedule for the secret.</p>"
},
"RotationOccurredWithinFrequency":{
"shape":"Boolean",
"documentation":"<p>Whether the rotation occurred within the specified rotation frequency.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN, Key ID, or alias of the AWS KMS customer master key (CMK) used to encrypt the <code>SecretString</code> or <code>SecretBinary</code> values for versions of this secret.</p>"
},
"RotationEnabled":{
"shape":"Boolean",
"documentation":"<p>Whether rotation is enabled.</p>"
},
"RotationLambdaArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the Lambda function that rotates the secret.</p>"
},
"Deleted":{
"shape":"Boolean",
"documentation":"<p>Whether the secret is deleted.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the secret.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>The user-provided description of the secret.</p>"
}
},
"documentation":"<p>Details about an AWS Secrets Manager secret.</p>"
},
"AwsSecretsManagerSecretRotationRules":{
"type":"structure",
"members":{
"AutomaticallyAfterDays":{
"shape":"Integer",
"documentation":"<p>The number of days after the previous rotation to rotate the secret.</p>"
}
},
"documentation":"<p>Defines the rotation schedule for the secret.</p>"
},
"AwsSecurityFinding":{
"type":"structure",
"required":[
"SchemaVersion",
"Id",
"ProductArn",
"GeneratorId",
"AwsAccountId",
"CreatedAt",
"UpdatedAt",
"Title",
"Description",
"Resources"
],
"members":{
"SchemaVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The schema version that a finding is formatted for.</p>"
},
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The security findings provider-specific identifier for a finding.</p>"
},
"ProductArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.</p>"
},
"GeneratorId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, etc. </p>"
},
"AwsAccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account ID that a finding is generated in.</p>"
},
"Types":{
"shape":"TypeList",
"documentation":"<p>One or more finding types in the format of <code>namespace/category/classifier</code> that classify a finding.</p> <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications</p>"
},
"FirstObservedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the security-findings provider first observed the potential security issue that a finding captured.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"LastObservedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the security-findings provider most recently observed the potential security issue that a finding captured.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"CreatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the security-findings provider created the potential security issue that a finding captured.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"UpdatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the security-findings provider last updated the finding record.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Severity":{
"shape":"Severity",
"documentation":"<p>A finding's severity.</p>"
},
"Confidence":{
"shape":"Integer",
"documentation":"<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"Criticality":{
"shape":"Integer",
"documentation":"<p>The level of importance assigned to the resources associated with the finding.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"
},
"Title":{
"shape":"NonEmptyString",
"documentation":"<p>A finding's title.</p> <note> <p>In this release, <code>Title</code> is a required property.</p> </note>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>A finding's description.</p> <note> <p>In this release, <code>Description</code> is a required property.</p> </note>"
},
"Remediation":{
"shape":"Remediation",
"documentation":"<p>A data type that describes the remediation options for a finding.</p>"
},
"SourceUrl":{
"shape":"NonEmptyString",
"documentation":"<p>A URL that links to a page about the current finding in the security-findings provider's solution.</p>"
},
"ProductFields":{
"shape":"FieldMap",
"documentation":"<p>A data type where security-findings providers can include additional solution-specific details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p>"
},
"UserDefinedFields":{
"shape":"FieldMap",
"documentation":"<p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding. </p>"
},
"Malware":{
"shape":"MalwareList",
"documentation":"<p>A list of malware related to a finding.</p>"
},
"Network":{
"shape":"Network",
"documentation":"<p>The details of network-related information about a finding.</p>"
},
"NetworkPath":{
"shape":"NetworkPathList",
"documentation":"<p>Provides information about a network path that is relevant to a finding. Each entry under <code>NetworkPath</code> represents a component of that path.</p>"
},
"Process":{
"shape":"ProcessDetails",
"documentation":"<p>The details of process-related information about a finding.</p>"
},
"ThreatIntelIndicators":{
"shape":"ThreatIntelIndicatorList",
"documentation":"<p>Threat intelligence details related to a finding.</p>"
},
"Resources":{
"shape":"ResourceList",
"documentation":"<p>A set of resource data types that describe the resources that the finding refers to.</p>"
},
"Compliance":{
"shape":"Compliance",
"documentation":"<p>This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS AWS Foundations. Contains security standard-related finding details.</p>"
},
"VerificationState":{
"shape":"VerificationState",
"documentation":"<p>Indicates the veracity of a finding. </p>"
},
"WorkflowState":{
"shape":"WorkflowState",
"documentation":"<p>The workflow state of a finding. </p>"
},
"Workflow":{
"shape":"Workflow",
"documentation":"<p>Provides information about the status of the investigation into a finding.</p>"
},
"RecordState":{
"shape":"RecordState",
"documentation":"<p>The record state of a finding.</p>"
},
"RelatedFindings":{
"shape":"RelatedFindingList",
"documentation":"<p>A list of related findings.</p>"
},
"Note":{
"shape":"Note",
"documentation":"<p>A user-defined note added to a finding.</p>"
},
"Vulnerabilities":{
"shape":"VulnerabilityList",
"documentation":"<p>Provides a list of vulnerabilities associated with the findings.</p>"
},
"PatchSummary":{
"shape":"PatchSummary",
"documentation":"<p>Provides an overview of the patch compliance status for an instance against a selected compliance standard.</p>"
},
"Action":{
"shape":"Action",
"documentation":"<p>Provides details about an action that affects or that was taken on a resource.</p>"
},
"FindingProviderFields":{
"shape":"FindingProviderFields",
"documentation":"<p>In a <code>BatchImportFindings</code> request, finding providers use <code>FindingProviderFields</code> to provide and update their own values for confidence, criticality, related findings, severity, and types.</p>"
}
},
"documentation":"<p>Provides consistent format for the contents of the Security Hub-aggregated findings. <code>AwsSecurityFinding</code> format enables you to share findings between AWS security services and third-party solutions, and security standards checks.</p> <note> <p>A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and standards checks.</p> </note>"
},
"AwsSecurityFindingFilters":{
"type":"structure",
"members":{
"ProductArn":{
"shape":"StringFilterList",
"documentation":"<p>The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.</p>"
},
"AwsAccountId":{
"shape":"StringFilterList",
"documentation":"<p>The AWS account ID that a finding is generated in.</p>"
},
"Id":{
"shape":"StringFilterList",
"documentation":"<p>The security findings provider-specific identifier for a finding.</p>"
},
"GeneratorId":{
"shape":"StringFilterList",
"documentation":"<p>The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, etc.</p>"
},
"Type":{
"shape":"StringFilterList",
"documentation":"<p>A finding type in the format of <code>namespace/category/classifier</code> that classifies a finding.</p>"
},
"FirstObservedAt":{
"shape":"DateFilterList",
"documentation":"<p>An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.</p>"
},
"LastObservedAt":{
"shape":"DateFilterList",
"documentation":"<p>An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.</p>"
},
"CreatedAt":{
"shape":"DateFilterList",
"documentation":"<p>An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.</p>"
},
"UpdatedAt":{
"shape":"DateFilterList",
"documentation":"<p>An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record. </p>"
},
"SeverityProduct":{
"shape":"NumberFilterList",
"documentation":"<p>The native severity as defined by the security-findings provider's solution that generated the finding.</p>",
"deprecated":true,
"deprecatedMessage":"This filter is deprecated, use FindingProviiltersSeverityOriginal instead."
},
"SeverityNormalized":{
"shape":"NumberFilterList",
"documentation":"<p>The normalized severity of a finding.</p>",
"deprecated":true,
"deprecatedMessage":"This filter is deprecated, use SeverityLabel or FindingProviderFieldsSeverityLabel instead."
},
"SeverityLabel":{
"shape":"StringFilterList",
"documentation":"<p>The label of a finding's severity.</p>"
},
"Confidence":{
"shape":"NumberFilterList",
"documentation":"<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"Criticality":{
"shape":"NumberFilterList",
"documentation":"<p>The level of importance assigned to the resources associated with the finding.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"
},
"Title":{
"shape":"StringFilterList",
"documentation":"<p>A finding's title.</p>"
},
"Description":{
"shape":"StringFilterList",
"documentation":"<p>A finding's description.</p>"
},
"RecommendationText":{
"shape":"StringFilterList",
"documentation":"<p>The recommendation of what to do about the issue described in a finding.</p>"
},
"SourceUrl":{
"shape":"StringFilterList",
"documentation":"<p>A URL that links to a page about the current finding in the security-findings provider's solution.</p>"
},
"ProductFields":{
"shape":"MapFilterList",
"documentation":"<p>A data type where security-findings providers can include additional solution-specific details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p>"
},
"ProductName":{
"shape":"StringFilterList",
"documentation":"<p>The name of the solution (product) that generates findings.</p>"
},
"CompanyName":{
"shape":"StringFilterList",
"documentation":"<p>The name of the findings provider (company) that owns the solution (product) that generates findings.</p>"
},
"UserDefinedFields":{
"shape":"MapFilterList",
"documentation":"<p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding. </p>"
},
"MalwareName":{
"shape":"StringFilterList",
"documentation":"<p>The name of the malware that was observed.</p>"
},
"MalwareType":{
"shape":"StringFilterList",
"documentation":"<p>The type of the malware that was observed.</p>"
},
"MalwarePath":{
"shape":"StringFilterList",
"documentation":"<p>The filesystem path of the malware that was observed.</p>"
},
"MalwareState":{
"shape":"StringFilterList",
"documentation":"<p>The state of the malware that was observed.</p>"
},
"NetworkDirection":{
"shape":"StringFilterList",
"documentation":"<p>Indicates the direction of network traffic associated with a finding.</p>"
},
"NetworkProtocol":{
"shape":"StringFilterList",
"documentation":"<p>The protocol of network-related information about a finding.</p>"
},
"NetworkSourceIpV4":{
"shape":"IpFilterList",
"documentation":"<p>The source IPv4 address of network-related information about a finding.</p>"
},
"NetworkSourceIpV6":{
"shape":"IpFilterList",
"documentation":"<p>The source IPv6 address of network-related information about a finding.</p>"
},
"NetworkSourcePort":{
"shape":"NumberFilterList",
"documentation":"<p>The source port of network-related information about a finding.</p>"
},
"NetworkSourceDomain":{
"shape":"StringFilterList",
"documentation":"<p>The source domain of network-related information about a finding.</p>"
},
"NetworkSourceMac":{
"shape":"StringFilterList",
"documentation":"<p>The source media access control (MAC) address of network-related information about a finding.</p>"
},
"NetworkDestinationIpV4":{
"shape":"IpFilterList",
"documentation":"<p>The destination IPv4 address of network-related information about a finding.</p>"
},
"NetworkDestinationIpV6":{
"shape":"IpFilterList",
"documentation":"<p>The destination IPv6 address of network-related information about a finding.</p>"
},
"NetworkDestinationPort":{
"shape":"NumberFilterList",
"documentation":"<p>The destination port of network-related information about a finding.</p>"
},
"NetworkDestinationDomain":{
"shape":"StringFilterList",
"documentation":"<p>The destination domain of network-related information about a finding.</p>"
},
"ProcessName":{
"shape":"StringFilterList",
"documentation":"<p>The name of the process.</p>"
},
"ProcessPath":{
"shape":"StringFilterList",
"documentation":"<p>The path to the process executable.</p>"
},
"ProcessPid":{
"shape":"NumberFilterList",
"documentation":"<p>The process ID.</p>"
},
"ProcessParentPid":{
"shape":"NumberFilterList",
"documentation":"<p>The parent process ID.</p>"
},
"ProcessLaunchedAt":{
"shape":"DateFilterList",
"documentation":"<p>The date/time that the process was launched.</p>"
},
"ProcessTerminatedAt":{
"shape":"DateFilterList",
"documentation":"<p>The date/time that the process was terminated.</p>"
},
"ThreatIntelIndicatorType":{
"shape":"StringFilterList",
"documentation":"<p>The type of a threat intelligence indicator.</p>"
},
"ThreatIntelIndicatorValue":{
"shape":"StringFilterList",
"documentation":"<p>The value of a threat intelligence indicator.</p>"
},
"ThreatIntelIndicatorCategory":{
"shape":"StringFilterList",
"documentation":"<p>The category of a threat intelligence indicator.</p>"
},
"ThreatIntelIndicatorLastObservedAt":{
"shape":"DateFilterList",
"documentation":"<p>The date/time of the last observation of a threat intelligence indicator.</p>"
},
"ThreatIntelIndicatorSource":{
"shape":"StringFilterList",
"documentation":"<p>The source of the threat intelligence.</p>"
},
"ThreatIntelIndicatorSourceUrl":{
"shape":"StringFilterList",
"documentation":"<p>The URL for more details from the source of the threat intelligence.</p>"
},
"ResourceType":{
"shape":"StringFilterList",
"documentation":"<p>Specifies the type of the resource that details are provided for.</p>"
},
"ResourceId":{
"shape":"StringFilterList",
"documentation":"<p>The canonical identifier for the given resource type.</p>"
},
"ResourcePartition":{
"shape":"StringFilterList",
"documentation":"<p>The canonical AWS partition name that the Region is assigned to.</p>"
},
"ResourceRegion":{
"shape":"StringFilterList",
"documentation":"<p>The canonical AWS external Region name where this resource is located.</p>"
},
"ResourceTags":{
"shape":"MapFilterList",
"documentation":"<p>A list of AWS tags associated with a resource at the time the finding was processed.</p>"
},
"ResourceAwsEc2InstanceType":{
"shape":"StringFilterList",
"documentation":"<p>The instance type of the instance.</p>"
},
"ResourceAwsEc2InstanceImageId":{
"shape":"StringFilterList",
"documentation":"<p>The Amazon Machine Image (AMI) ID of the instance.</p>"
},
"ResourceAwsEc2InstanceIpV4Addresses":{
"shape":"IpFilterList",
"documentation":"<p>The IPv4 addresses associated with the instance.</p>"
},
"ResourceAwsEc2InstanceIpV6Addresses":{
"shape":"IpFilterList",
"documentation":"<p>The IPv6 addresses associated with the instance.</p>"
},
"ResourceAwsEc2InstanceKeyName":{
"shape":"StringFilterList",
"documentation":"<p>The key name associated with the instance.</p>"
},
"ResourceAwsEc2InstanceIamInstanceProfileArn":{
"shape":"StringFilterList",
"documentation":"<p>The IAM profile ARN of the instance.</p>"
},
"ResourceAwsEc2InstanceVpcId":{
"shape":"StringFilterList",
"documentation":"<p>The identifier of the VPC that the instance was launched in.</p>"
},
"ResourceAwsEc2InstanceSubnetId":{
"shape":"StringFilterList",
"documentation":"<p>The identifier of the subnet that the instance was launched in.</p>"
},
"ResourceAwsEc2InstanceLaunchedAt":{
"shape":"DateFilterList",
"documentation":"<p>The date and time the instance was launched.</p>"
},
"ResourceAwsS3BucketOwnerId":{
"shape":"StringFilterList",
"documentation":"<p>The canonical user ID of the owner of the S3 bucket.</p>"
},
"ResourceAwsS3BucketOwnerName":{
"shape":"StringFilterList",
"documentation":"<p>The display name of the owner of the S3 bucket.</p>"
},
"ResourceAwsIamAccessKeyUserName":{
"shape":"StringFilterList",
"documentation":"<p>The user associated with the IAM access key related to a finding.</p>"
},
"ResourceAwsIamAccessKeyStatus":{
"shape":"StringFilterList",
"documentation":"<p>The status of the IAM access key related to a finding.</p>"
},
"ResourceAwsIamAccessKeyCreatedAt":{
"shape":"DateFilterList",
"documentation":"<p>The creation date/time of the IAM access key related to a finding.</p>"
},
"ResourceContainerName":{
"shape":"StringFilterList",
"documentation":"<p>The name of the container related to a finding.</p>"
},
"ResourceContainerImageId":{
"shape":"StringFilterList",
"documentation":"<p>The identifier of the image related to a finding.</p>"
},
"ResourceContainerImageName":{
"shape":"StringFilterList",
"documentation":"<p>The name of the image related to a finding.</p>"
},
"ResourceContainerLaunchedAt":{
"shape":"DateFilterList",
"documentation":"<p>The date/time that the container was started.</p>"
},
"ResourceDetailsOther":{
"shape":"MapFilterList",
"documentation":"<p>The details of a resource that doesn't have a specific subfield for the resource type defined.</p>"
},
"ComplianceStatus":{
"shape":"StringFilterList",
"documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS AWS Foundations. Contains security standard-related finding details.</p>"
},
"VerificationState":{
"shape":"StringFilterList",
"documentation":"<p>The veracity of a finding.</p>"
},
"WorkflowState":{
"shape":"StringFilterList",
"documentation":"<p>The workflow state of a finding.</p> <p>Note that this field is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>"
},
"WorkflowStatus":{
"shape":"StringFilterList",
"documentation":"<p>The status of the investigation into a finding. Allowed values are the following.</p> <ul> <li> <p> <code>NEW</code> - The initial state of a finding, before it is reviewed.</p> <p>Security Hub also resets the workflow status from <code>NOTIFIED</code> or <code>RESOLVED</code> to <code>NEW</code> in the following cases:</p> <ul> <li> <p>The record state changes from <code>ARCHIVED</code> to <code>ACTIVE</code>.</p> </li> <li> <p>The compliance status changes from <code>PASSED</code> to either <code>WARNING</code>, <code>FAILED</code>, or <code>NOT_AVAILABLE</code>.</p> </li> </ul> </li> <li> <p> <code>NOTIFIED</code> - Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.</p> </li> <li> <p> <code>SUPPRESSED</code> - The finding will not be reviewed again and will not be acted upon.</p> </li> <li> <p> <code>RESOLVED</code> - The finding was reviewed and remediated and is now considered resolved. </p> </li> </ul>"
},
"RecordState":{
"shape":"StringFilterList",
"documentation":"<p>The updated record state for the finding.</p>"
},
"RelatedFindingsProductArn":{
"shape":"StringFilterList",
"documentation":"<p>The ARN of the solution that generated a related finding.</p>"
},
"RelatedFindingsId":{
"shape":"StringFilterList",
"documentation":"<p>The solution-generated identifier for a related finding.</p>"
},
"NoteText":{
"shape":"StringFilterList",
"documentation":"<p>The text of a note.</p>"
},
"NoteUpdatedAt":{
"shape":"DateFilterList",
"documentation":"<p>The timestamp of when the note was updated.</p>"
},
"NoteUpdatedBy":{
"shape":"StringFilterList",
"documentation":"<p>The principal that created a note.</p>"
},
"Keyword":{
"shape":"KeywordFilterList",
"documentation":"<p>A keyword for a finding.</p>"
},
"FindingProviderFieldsConfidence":{
"shape":"NumberFilterList",
"documentation":"<p>The finding provider value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"FindingProviderFieldsCriticality":{
"shape":"NumberFilterList",
"documentation":"<p>The finding provider value for the level of importance assigned to the resources associated with the findings.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. </p>"
},
"FindingProviderFieldsRelatedFindingsId":{
"shape":"StringFilterList",
"documentation":"<p>The finding identifier of a related finding that is identified by the finding provider.</p>"
},
"FindingProviderFieldsRelatedFindingsProductArn":{
"shape":"StringFilterList",
"documentation":"<p>The ARN of the solution that generated a related finding that is identified by the finding provider.</p>"
},
"FindingProviderFieldsSeverityLabel":{
"shape":"StringFilterList",
"documentation":"<p>The finding provider value for the severity label.</p>"
},
"FindingProviderFieldsSeverityOriginal":{
"shape":"StringFilterList",
"documentation":"<p>The finding provider's original value for the severity.</p>"
},
"FindingProviderFieldsTypes":{
"shape":"StringFilterList",
"documentation":"<p>One or more finding types that the finding provider assigned to the finding. Uses the format of <code>namespace/category/classifier</code> that classify a finding.</p> <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications</p>"
}
},
"documentation":"<p>A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight.</p> <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>"
},
"AwsSecurityFindingIdentifier":{
"type":"structure",
"required":[
"Id",
"ProductArn"
],
"members":{
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the finding that was specified by the finding provider.</p>"
},
"ProductArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.</p>"
}
},
"documentation":"<p>Identifies a finding to update using <code>BatchUpdateFindings</code>.</p>"
},
"AwsSecurityFindingIdentifierList":{
"type":"list",
"member":{"shape":"AwsSecurityFindingIdentifier"}
},
"AwsSecurityFindingList":{
"type":"list",
"member":{"shape":"AwsSecurityFinding"}
},
"AwsSnsTopicDetails":{
"type":"structure",
"members":{
"KmsMasterKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.</p>"
},
"Subscription":{
"shape":"AwsSnsTopicSubscriptionList",
"documentation":"<p>Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.</p>"
},
"TopicName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the topic.</p>"
},
"Owner":{
"shape":"NonEmptyString",
"documentation":"<p>The subscription's owner.</p>"
}
},
"documentation":"<p>A wrapper type for the topic's Amazon Resource Name (ARN).</p>"
},
"AwsSnsTopicSubscription":{
"type":"structure",
"members":{
"Endpoint":{
"shape":"NonEmptyString",
"documentation":"<p>The subscription's endpoint (format depends on the protocol).</p>"
},
"Protocol":{
"shape":"NonEmptyString",
"documentation":"<p>The subscription's protocol.</p>"
}
},
"documentation":"<p>A wrapper type for the attributes of an Amazon SNS subscription.</p>"
},
"AwsSnsTopicSubscriptionList":{
"type":"list",
"member":{"shape":"AwsSnsTopicSubscription"}
},
"AwsSqsQueueDetails":{
"type":"structure",
"members":{
"KmsDataKeyReusePeriodSeconds":{
"shape":"Integer",
"documentation":"<p>The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.</p>"
},
"KmsMasterKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK.</p>"
},
"QueueName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the new queue.</p>"
},
"DeadLetterTargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. </p>"
}
},
"documentation":"<p>Data about a queue.</p>"
},
"AwsSsmComplianceSummary":{
"type":"structure",
"members":{
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The current patch compliance status.</p> <p>The possible status values are:</p> <ul> <li> <p> <code>COMPLIANT</code> </p> </li> <li> <p> <code>NON_COMPLIANT</code> </p> </li> <li> <p> <code>UNSPECIFIED_DATA</code> </p> </li> </ul>"
},
"CompliantCriticalCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are compliant, the number that have a severity of <code>CRITICAL</code>.</p>"
},
"CompliantHighCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are compliant, the number that have a severity of <code>HIGH</code>.</p>"
},
"CompliantMediumCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are compliant, the number that have a severity of <code>MEDIUM</code>.</p>"
},
"ExecutionType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of execution that was used determine compliance.</p>"
},
"NonCompliantCriticalCount":{
"shape":"Integer",
"documentation":"<p>For the patch items that are noncompliant, the number of items that have a severity of <code>CRITICAL</code>.</p>"
},
"CompliantInformationalCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are compliant, the number that have a severity of <code>INFORMATIONAL</code>.</p>"
},
"NonCompliantInformationalCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are noncompliant, the number that have a severity of <code>INFORMATIONAL</code>.</p>"
},
"CompliantUnspecifiedCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are compliant, the number that have a severity of <code>UNSPECIFIED</code>.</p>"
},
"NonCompliantLowCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are noncompliant, the number that have a severity of <code>LOW</code>.</p>"
},
"NonCompliantHighCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are noncompliant, the number that have a severity of <code>HIGH</code>.</p>"
},
"CompliantLowCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are compliant, the number that have a severity of <code>LOW</code>.</p>"
},
"ComplianceType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of resource for which the compliance was determined. For <code>AwsSsmPatchCompliance</code>, <code>ComplianceType</code> is <code>Patch</code>. </p>"
},
"PatchBaselineId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the patch baseline. The patch baseline lists the patches that are approved for installation.</p>"
},
"OverallSeverity":{
"shape":"NonEmptyString",
"documentation":"<p>The highest severity for the patches.</p>"
},
"NonCompliantMediumCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are noncompliant, the number that have a severity of <code>MEDIUM</code>.</p>"
},
"NonCompliantUnspecifiedCount":{
"shape":"Integer",
"documentation":"<p>For the patches that are noncompliant, the number that have a severity of <code>UNSPECIFIED</code>.</p>"
},
"PatchGroup":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the patch group for which compliance was determined. A patch group uses tags to group EC2 instances that should have the same patch compliance.</p>"
}
},
"documentation":"<p>Provides the details about the compliance status for a patch.</p>"
},
"AwsSsmPatch":{
"type":"structure",
"members":{
"ComplianceSummary":{
"shape":"AwsSsmComplianceSummary",
"documentation":"<p>The compliance status details for the patch.</p>"
}
},
"documentation":"<p>Provides details about the compliance for a patch.</p>"
},
"AwsSsmPatchComplianceDetails":{
"type":"structure",
"members":{
"Patch":{
"shape":"AwsSsmPatch",
"documentation":"<p>Information about the status of a patch.</p>"
}
},
"documentation":"<p>Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.</p>"
},
"AwsWafWebAclDetails":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.</p>"
},
"DefaultAction":{
"shape":"NonEmptyString",
"documentation":"<p>The action to perform if none of the rules contained in the WebACL match.</p>"
},
"Rules":{
"shape":"AwsWafWebAclRuleList",
"documentation":"<p>An array that contains the action for each rule in a WebACL, the priority of the rule, and the ID of the rule.</p>"
},
"WebAclId":{
"shape":"NonEmptyString",
"documentation":"<p>A unique identifier for a WebACL.</p>"
}
},
"documentation":"<p>Details about a WAF WebACL.</p>"
},
"AwsWafWebAclRule":{
"type":"structure",
"members":{
"Action":{
"shape":"WafAction",
"documentation":"<p>Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule. </p>"
},
"ExcludedRules":{
"shape":"WafExcludedRuleList",
"documentation":"<p>Rules to exclude from a rule group.</p>"
},
"OverrideAction":{
"shape":"WafOverrideAction",
"documentation":"<p>Use the <code>OverrideAction</code> to test your RuleGroup.</p> <p>Any rule in a RuleGroup can potentially block a request. If you set the <code>OverrideAction</code> to <code>None</code>, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.</p> <p>However, if you first want to test the RuleGroup, set the <code>OverrideAction</code> to <code>Count</code>. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.</p> <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use <code>ActivatedRule</code>|<code>Action</code>. For all other update requests, <code>ActivatedRule</code>|<code>Action</code> is used instead of <code>ActivatedRule</code>|<code>OverrideAction</code>. </p>"
},
"Priority":{
"shape":"Integer",
"documentation":"<p>Specifies the order in which the rules in a WebACL are evaluated. Rules with a lower value for <code>Priority</code> are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a WebACL, the values do not need to be consecutive.</p>"
},
"RuleId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier for a rule.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The rule type.</p> <p>Valid values: <code>REGULAR</code> | <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is <code>REGULAR</code>.</p>"
}
},
"documentation":"<p>Details for a rule in a WAF WebACL.</p>"
},
"AwsWafWebAclRuleList":{
"type":"list",
"member":{"shape":"AwsWafWebAclRule"}
},
"BatchDisableStandardsRequest":{
"type":"structure",
"required":["StandardsSubscriptionArns"],
"members":{
"StandardsSubscriptionArns":{
"shape":"StandardsSubscriptionArns",
"documentation":"<p>The ARNs of the standards subscriptions to disable.</p>"
}
}
},
"BatchDisableStandardsResponse":{
"type":"structure",
"members":{
"StandardsSubscriptions":{
"shape":"StandardsSubscriptions",
"documentation":"<p>The details of the standards subscriptions that were disabled.</p>"
}
}
},
"BatchEnableStandardsRequest":{
"type":"structure",
"required":["StandardsSubscriptionRequests"],
"members":{
"StandardsSubscriptionRequests":{
"shape":"StandardsSubscriptionRequests",
"documentation":"<p>The list of standards checks to enable.</p>"
}
}
},
"BatchEnableStandardsResponse":{
"type":"structure",
"members":{
"StandardsSubscriptions":{
"shape":"StandardsSubscriptions",
"documentation":"<p>The details of the standards subscriptions that were enabled.</p>"
}
}
},
"BatchImportFindingsRequest":{
"type":"structure",
"required":["Findings"],
"members":{
"Findings":{
"shape":"BatchImportFindingsRequestFindingList",
"documentation":"<p>A list of findings to import. To successfully import a finding, it must follow the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html\">AWS Security Finding Format</a>. Maximum of 100 findings per request.</p>"
}
}
},
"BatchImportFindingsRequestFindingList":{
"type":"list",
"member":{"shape":"AwsSecurityFinding"},
"max":100,
"min":1
},
"BatchImportFindingsResponse":{
"type":"structure",
"required":[
"FailedCount",
"SuccessCount"
],
"members":{
"FailedCount":{
"shape":"Integer",
"documentation":"<p>The number of findings that failed to import.</p>"
},
"SuccessCount":{
"shape":"Integer",
"documentation":"<p>The number of findings that were successfully imported.</p>"
},
"FailedFindings":{
"shape":"ImportFindingsErrorList",
"documentation":"<p>The list of findings that failed to import.</p>"
}
}
},
"BatchUpdateFindingsRequest":{
"type":"structure",
"required":["FindingIdentifiers"],
"members":{
"FindingIdentifiers":{
"shape":"AwsSecurityFindingIdentifierList",
"documentation":"<p>The list of findings to update. <code>BatchUpdateFindings</code> can be used to update up to 100 findings at a time.</p> <p>For each finding, the list provides the finding identifier and the ARN of the finding provider.</p>"
},
"Note":{"shape":"NoteUpdate"},
"Severity":{
"shape":"SeverityUpdate",
"documentation":"<p>Used to update the finding severity.</p>"
},
"VerificationState":{
"shape":"VerificationState",
"documentation":"<p>Indicates the veracity of a finding.</p> <p>The available values for <code>VerificationState</code> are as follows.</p> <ul> <li> <p> <code>UNKNOWN</code> – The default disposition of a security finding</p> </li> <li> <p> <code>TRUE_POSITIVE</code> – The security finding is confirmed</p> </li> <li> <p> <code>FALSE_POSITIVE</code> – The security finding was determined to be a false alarm</p> </li> <li> <p> <code>BENIGN_POSITIVE</code> – A special case of <code>TRUE_POSITIVE</code> where the finding doesn't pose any threat, is expected, or both</p> </li> </ul>"
},
"Confidence":{
"shape":"RatioScale",
"documentation":"<p>The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"Criticality":{
"shape":"RatioScale",
"documentation":"<p>The updated value for the level of importance assigned to the resources associated with the findings.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. </p>"
},
"Types":{
"shape":"TypeList",
"documentation":"<p>One or more finding types in the format of namespace/category/classifier that classify a finding.</p> <p>Valid namespace values are as follows.</p> <ul> <li> <p>Software and Configuration Checks</p> </li> <li> <p>TTPs</p> </li> <li> <p>Effects</p> </li> <li> <p>Unusual Behaviors</p> </li> <li> <p>Sensitive Data Identifications </p> </li> </ul>"
},
"UserDefinedFields":{
"shape":"FieldMap",
"documentation":"<p>A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.</p>"
},
"Workflow":{
"shape":"WorkflowUpdate",
"documentation":"<p>Used to update the workflow status of a finding.</p> <p>The workflow status indicates the progress of the investigation into the finding. </p>"
},
"RelatedFindings":{
"shape":"RelatedFindingList",
"documentation":"<p>A list of findings that are related to the updated findings.</p>"
}
}
},
"BatchUpdateFindingsResponse":{
"type":"structure",
"required":[
"ProcessedFindings",
"UnprocessedFindings"
],
"members":{
"ProcessedFindings":{
"shape":"AwsSecurityFindingIdentifierList",
"documentation":"<p>The list of findings that were updated successfully.</p>"
},
"UnprocessedFindings":{
"shape":"BatchUpdateFindingsUnprocessedFindingsList",
"documentation":"<p>The list of findings that were not updated.</p>"
}
}
},
"BatchUpdateFindingsUnprocessedFinding":{
"type":"structure",
"required":[
"FindingIdentifier",
"ErrorCode",
"ErrorMessage"
],
"members":{
"FindingIdentifier":{
"shape":"AwsSecurityFindingIdentifier",
"documentation":"<p>The identifier of the finding that was not updated.</p>"
},
"ErrorCode":{
"shape":"NonEmptyString",
"documentation":"<p>The code associated with the error.</p>"
},
"ErrorMessage":{
"shape":"NonEmptyString",
"documentation":"<p>The message associated with the error.</p>"
}
},
"documentation":"<p>A finding from a <code>BatchUpdateFindings</code> request that Security Hub was unable to update.</p>"
},
"BatchUpdateFindingsUnprocessedFindingsList":{
"type":"list",
"member":{"shape":"BatchUpdateFindingsUnprocessedFinding"}
},
"Boolean":{"type":"boolean"},
"CategoryList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"Cell":{
"type":"structure",
"members":{
"Column":{
"shape":"Long",
"documentation":"<p>The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.</p>"
},
"Row":{
"shape":"Long",
"documentation":"<p>The row number of the row that contains the data.</p>"
},
"ColumnName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the column that contains the data.</p>"
},
"CellReference":{
"shape":"NonEmptyString",
"documentation":"<p>For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.</p>"
}
},
"documentation":"<p>An occurrence of sensitive data detected in a Microsoft Excel workbook, comma-separated value (CSV) file, or tab-separated value (TSV) file.</p>"
},
"Cells":{
"type":"list",
"member":{"shape":"Cell"}
},
"CidrBlockAssociation":{
"type":"structure",
"members":{
"AssociationId":{
"shape":"NonEmptyString",
"documentation":"<p>The association ID for the IPv4 CIDR block.</p>"
},
"CidrBlock":{
"shape":"NonEmptyString",
"documentation":"<p>The IPv4 CIDR block.</p>"
},
"CidrBlockState":{
"shape":"NonEmptyString",
"documentation":"<p>Information about the state of the IPv4 CIDR block.</p>"
}
},
"documentation":"<p>An IPv4 CIDR block association.</p>"
},
"CidrBlockAssociationList":{
"type":"list",
"member":{"shape":"CidrBlockAssociation"}
},
"City":{
"type":"structure",
"members":{
"CityName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the city.</p>"
}
},
"documentation":"<p>Information about a city.</p>"
},
"ClassificationResult":{
"type":"structure",
"members":{
"MimeType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of content that the finding applies to.</p>"
},
"SizeClassified":{
"shape":"Long",
"documentation":"<p>The total size in bytes of the affected data.</p>"
},
"AdditionalOccurrences":{
"shape":"Boolean",
"documentation":"<p>Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.</p>"
},
"Status":{
"shape":"ClassificationStatus",
"documentation":"<p>The current status of the sensitive data detection.</p>"
},
"SensitiveData":{
"shape":"SensitiveDataResultList",
"documentation":"<p>Provides details about sensitive data that was identified based on built-in configuration.</p>"
},
"CustomDataIdentifiers":{
"shape":"CustomDataIdentifiersResult",
"documentation":"<p>Provides details about sensitive data that was identified based on customer-defined configuration.</p>"
}
},
"documentation":"<p>Details about the sensitive data that was detected on the resource.</p>"
},
"ClassificationStatus":{
"type":"structure",
"members":{
"Code":{
"shape":"NonEmptyString",
"documentation":"<p>The code that represents the status of the sensitive data detection.</p>"
},
"Reason":{
"shape":"NonEmptyString",
"documentation":"<p>A longer description of the current status of the sensitive data detection.</p>"
}
},
"documentation":"<p>Provides details about the current status of the sensitive data detection.</p>"
},
"Compliance":{
"type":"structure",
"members":{
"Status":{
"shape":"ComplianceStatus",
"documentation":"<p>The result of a standards check.</p> <p>The valid values for <code>Status</code> are as follows.</p> <ul> <li> <ul> <li> <p> <code>PASSED</code> - Standards check passed for all evaluated resources.</p> </li> <li> <p> <code>WARNING</code> - Some information is missing or this check is not supported for your configuration.</p> </li> <li> <p> <code>FAILED</code> - Standards check failed for at least one evaluated resource.</p> </li> <li> <p> <code>NOT_AVAILABLE</code> - Check could not be performed due to a service outage, API error, or because the result of the AWS Config evaluation was <code>NOT_APPLICABLE</code>. If the AWS Config evaluation result was <code>NOT_APPLICABLE</code>, then after 3 days, Security Hub automatically archives the finding.</p> </li> </ul> </li> </ul>"
},
"RelatedRequirements":{
"shape":"RelatedRequirementsList",
"documentation":"<p>For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.</p>"
},
"StatusReasons":{
"shape":"StatusReasonsList",
"documentation":"<p>For findings generated from controls, a list of reasons behind the value of <code>Status</code>. For the list of status reason codes and their meanings, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff\">Standards-related information in the ASFF</a> in the <i>AWS Security Hub User Guide</i>. </p>"
}
},
"documentation":"<p>Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.</p>"
},
"ComplianceStatus":{
"type":"string",
"enum":[
"PASSED",
"WARNING",
"FAILED",
"NOT_AVAILABLE"
]
},
"ContainerDetails":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the container related to a finding.</p>"
},
"ImageId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the image related to a finding.</p>"
},
"ImageName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the image related to a finding.</p>"
},
"LaunchedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the container started.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>Container details related to a finding.</p>"
},
"ControlStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"Country":{
"type":"structure",
"members":{
"CountryCode":{
"shape":"NonEmptyString",
"documentation":"<p>The 2-letter ISO 3166 country code for the country.</p>"
},
"CountryName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the country.</p>"
}
},
"documentation":"<p>Information about a country.</p>"
},
"CreateActionTargetRequest":{
"type":"structure",
"required":[
"Name",
"Description",
"Id"
],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the custom action target.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>The description for the custom action target.</p>"
},
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The ID for the custom action target.</p>"
}
}
},
"CreateActionTargetResponse":{
"type":"structure",
"required":["ActionTargetArn"],
"members":{
"ActionTargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN for the custom action target.</p>"
}
}
},
"CreateInsightRequest":{
"type":"structure",
"required":[
"Name",
"Filters",
"GroupByAttribute"
],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the custom insight to create.</p>"
},
"Filters":{
"shape":"AwsSecurityFindingFilters",
"documentation":"<p>One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.</p>"
},
"GroupByAttribute":{
"shape":"NonEmptyString",
"documentation":"<p>The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.</p>"
}
}
},
"CreateInsightResponse":{
"type":"structure",
"required":["InsightArn"],
"members":{
"InsightArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the insight created.</p>"
}
}
},
"CreateMembersRequest":{
"type":"structure",
"required":["AccountDetails"],
"members":{
"AccountDetails":{
"shape":"AccountDetailsList",
"documentation":"<p>The list of accounts to associate with the Security Hub master account. For each account, the list includes the account ID and optionally the email address.</p>"
}
}
},
"CreateMembersResponse":{
"type":"structure",
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.</p>"
}
}
},
"CrossAccountMaxResults":{
"type":"integer",
"max":50,
"min":1
},
"CustomDataIdentifiersDetections":{
"type":"structure",
"members":{
"Count":{
"shape":"Long",
"documentation":"<p>The total number of occurrences of sensitive data that were detected.</p>"
},
"Arn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the custom identifier that was used to detect the sensitive data.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>he name of the custom identifier that detected the sensitive data.</p>"
},
"Occurrences":{
"shape":"Occurrences",
"documentation":"<p>Details about the sensitive data that was detected.</p>"
}
},
"documentation":"<p>The list of detected instances of sensitive data.</p>"
},
"CustomDataIdentifiersDetectionsList":{
"type":"list",
"member":{"shape":"CustomDataIdentifiersDetections"}
},
"CustomDataIdentifiersResult":{
"type":"structure",
"members":{
"Detections":{
"shape":"CustomDataIdentifiersDetectionsList",
"documentation":"<p>The list of detected instances of sensitive data.</p>"
},
"TotalCount":{
"shape":"Long",
"documentation":"<p>The total number of occurrences of sensitive data.</p>"
}
},
"documentation":"<p>Contains an instance of sensitive data that was detected by a customer-defined identifier.</p>"
},
"Cvss":{
"type":"structure",
"members":{
"Version":{
"shape":"NonEmptyString",
"documentation":"<p>The version of CVSS for the CVSS score.</p>"
},
"BaseScore":{
"shape":"Double",
"documentation":"<p>The base CVSS score.</p>"
},
"BaseVector":{
"shape":"NonEmptyString",
"documentation":"<p>The base scoring vector for the CVSS score.</p>"
}
},
"documentation":"<p>CVSS scores from the advisory related to the vulnerability.</p>"
},
"CvssList":{
"type":"list",
"member":{"shape":"Cvss"}
},
"DataClassificationDetails":{
"type":"structure",
"members":{
"DetailedResultsLocation":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the folder or file that contains the sensitive data.</p>"
},
"Result":{
"shape":"ClassificationResult",
"documentation":"<p>The details about the sensitive data that was detected on the resource.</p>"
}
},
"documentation":"<p>Provides details about sensitive data that was detected on a resource.</p>"
},
"DateFilter":{
"type":"structure",
"members":{
"Start":{
"shape":"NonEmptyString",
"documentation":"<p>A start date for the date filter.</p>"
},
"End":{
"shape":"NonEmptyString",
"documentation":"<p>An end date for the date filter.</p>"
},
"DateRange":{
"shape":"DateRange",
"documentation":"<p>A date range for the date filter.</p>"
}
},
"documentation":"<p>A date filter for querying findings.</p>"
},
"DateFilterList":{
"type":"list",
"member":{"shape":"DateFilter"}
},
"DateRange":{
"type":"structure",
"members":{
"Value":{
"shape":"Integer",
"documentation":"<p>A date range value for the date filter.</p>"
},
"Unit":{
"shape":"DateRangeUnit",
"documentation":"<p>A date range unit for the date filter.</p>"
}
},
"documentation":"<p>A date range for the date filter.</p>"
},
"DateRangeUnit":{
"type":"string",
"enum":["DAYS"]
},
"DeclineInvitationsRequest":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The list of account IDs for the accounts from which to decline the invitations to Security Hub.</p>"
}
}
},
"DeclineInvitationsResponse":{
"type":"structure",
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.</p>"
}
}
},
"DeleteActionTargetRequest":{
"type":"structure",
"required":["ActionTargetArn"],
"members":{
"ActionTargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the custom action target to delete.</p>",
"location":"uri",
"locationName":"ActionTargetArn"
}
}
},
"DeleteActionTargetResponse":{
"type":"structure",
"required":["ActionTargetArn"],
"members":{
"ActionTargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the custom action target that was deleted.</p>"
}
}
},
"DeleteInsightRequest":{
"type":"structure",
"required":["InsightArn"],
"members":{
"InsightArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the insight to delete.</p>",
"location":"uri",
"locationName":"InsightArn"
}
}
},
"DeleteInsightResponse":{
"type":"structure",
"required":["InsightArn"],
"members":{
"InsightArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the insight that was deleted.</p>"
}
}
},
"DeleteInvitationsRequest":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The list of the account IDs that sent the invitations to delete.</p>"
}
}
},
"DeleteInvitationsResponse":{
"type":"structure",
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>The list of AWS accounts for which the invitations were not deleted. For each account, the list includes the account ID and the email address.</p>"
}
}
},
"DeleteMembersRequest":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The list of account IDs for the member accounts to delete.</p>"
}
}
},
"DeleteMembersResponse":{
"type":"structure",
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>The list of AWS accounts that were not deleted. For each account, the list includes the account ID and the email address.</p>"
}
}
},
"DescribeActionTargetsRequest":{
"type":"structure",
"members":{
"ActionTargetArns":{
"shape":"ArnList",
"documentation":"<p>A list of custom action target ARNs for the custom action targets to retrieve.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>DescribeActionTargets</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>"
}
}
},
"DescribeActionTargetsResponse":{
"type":"structure",
"required":["ActionTargets"],
"members":{
"ActionTargets":{
"shape":"ActionTargetList",
"documentation":"<p>A list of <code>ActionTarget</code> objects. Each object includes the <code>ActionTargetArn</code>, <code>Description</code>, and <code>Name</code> of a custom action target available in Security Hub.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"DescribeHubRequest":{
"type":"structure",
"members":{
"HubArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the Hub resource to retrieve.</p>",
"location":"querystring",
"locationName":"HubArn"
}
}
},
"DescribeHubResponse":{
"type":"structure",
"members":{
"HubArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the Hub resource that was retrieved.</p>"
},
"SubscribedAt":{
"shape":"NonEmptyString",
"documentation":"<p>The date and time when Security Hub was enabled in the account.</p>"
},
"AutoEnableControls":{
"shape":"Boolean",
"documentation":"<p>Whether to automatically enable new controls when they are added to standards that are enabled.</p> <p>If set to <code>true</code>, then new controls for enabled standards are enabled automatically. If set to <code>false</code>, then new controls are not enabled.</p>"
}
}
},
"DescribeOrganizationConfigurationRequest":{
"type":"structure",
"members":{
}
},
"DescribeOrganizationConfigurationResponse":{
"type":"structure",
"members":{
"AutoEnable":{
"shape":"Boolean",
"documentation":"<p>Whether to automatically enable Security Hub for new accounts in the organization.</p> <p>If set to <code>true</code>, then Security Hub is enabled for new accounts. If set to false, then new accounts are not added automatically.</p>"
},
"MemberAccountLimitReached":{
"shape":"Boolean",
"documentation":"<p>Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.</p>"
}
}
},
"DescribeProductsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>DescribeProducts</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"MaxResults"
},
"ProductArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the integration to return.</p>",
"location":"querystring",
"locationName":"ProductArn"
}
}
},
"DescribeProductsResponse":{
"type":"structure",
"required":["Products"],
"members":{
"Products":{
"shape":"ProductsList",
"documentation":"<p>A list of products, including details for each product.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"DescribeStandardsControlsRequest":{
"type":"structure",
"required":["StandardsSubscriptionArn"],
"members":{
"StandardsSubscriptionArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the <code> <a>GetEnabledStandards</a> </code> operation.</p>",
"location":"uri",
"locationName":"StandardsSubscriptionArn"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>DescribeStandardsControls</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of security standard controls to return.</p>",
"location":"querystring",
"locationName":"MaxResults"
}
}
},
"DescribeStandardsControlsResponse":{
"type":"structure",
"members":{
"Controls":{
"shape":"StandardsControls",
"documentation":"<p>A list of security standards controls.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"DescribeStandardsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>DescribeStandards</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of standards to return.</p>",
"location":"querystring",
"locationName":"MaxResults"
}
}
},
"DescribeStandardsResponse":{
"type":"structure",
"members":{
"Standards":{
"shape":"Standards",
"documentation":"<p>A list of available standards.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"DisableImportFindingsForProductRequest":{
"type":"structure",
"required":["ProductSubscriptionArn"],
"members":{
"ProductSubscriptionArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the integrated product to disable the integration for.</p>",
"location":"uri",
"locationName":"ProductSubscriptionArn"
}
}
},
"DisableImportFindingsForProductResponse":{
"type":"structure",
"members":{
}
},
"DisableOrganizationAdminAccountRequest":{
"type":"structure",
"required":["AdminAccountId"],
"members":{
"AdminAccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account identifier of the Security Hub administrator account.</p>"
}
}
},
"DisableOrganizationAdminAccountResponse":{
"type":"structure",
"members":{
}
},
"DisableSecurityHubRequest":{
"type":"structure",
"members":{
}
},
"DisableSecurityHubResponse":{
"type":"structure",
"members":{
}
},
"DisassociateFromMasterAccountRequest":{
"type":"structure",
"members":{
}
},
"DisassociateFromMasterAccountResponse":{
"type":"structure",
"members":{
}
},
"DisassociateMembersRequest":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The account IDs of the member accounts to disassociate from the master account.</p>"
}
}
},
"DisassociateMembersResponse":{
"type":"structure",
"members":{
}
},
"DnsRequestAction":{
"type":"structure",
"members":{
"Domain":{
"shape":"NonEmptyString",
"documentation":"<p>The DNS domain that is associated with the DNS request.</p>"
},
"Protocol":{
"shape":"NonEmptyString",
"documentation":"<p>The protocol that was used for the DNS request.</p>"
},
"Blocked":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the DNS request was blocked.</p>"
}
},
"documentation":"<p>Provided if <code>ActionType</code> is <code>DNS_REQUEST</code>. It provides details about the DNS request that was detected.</p>"
},
"Double":{"type":"double"},
"EnableImportFindingsForProductRequest":{
"type":"structure",
"required":["ProductArn"],
"members":{
"ProductArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the product to enable the integration for.</p>"
}
}
},
"EnableImportFindingsForProductResponse":{
"type":"structure",
"members":{
"ProductSubscriptionArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of your subscription to the product to enable integrations for.</p>"
}
}
},
"EnableOrganizationAdminAccountRequest":{
"type":"structure",
"required":["AdminAccountId"],
"members":{
"AdminAccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account identifier of the account to designate as the Security Hub administrator account.</p>"
}
}
},
"EnableOrganizationAdminAccountResponse":{
"type":"structure",
"members":{
}
},
"EnableSecurityHubRequest":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagMap",
"documentation":"<p>The tags to add to the hub resource when you enable Security Hub.</p>"
},
"EnableDefaultStandards":{
"shape":"Boolean",
"documentation":"<p>Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for <code>EnableDefaultStandards</code>, it is set to <code>true</code>. To not enable the automatically enabled standards, set <code>EnableDefaultStandards</code> to <code>false</code>.</p>"
}
}
},
"EnableSecurityHubResponse":{
"type":"structure",
"members":{
}
},
"FieldMap":{
"type":"map",
"key":{"shape":"NonEmptyString"},
"value":{"shape":"NonEmptyString"}
},
"FindingProviderFields":{
"type":"structure",
"members":{
"Confidence":{
"shape":"RatioScale",
"documentation":"<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"Criticality":{
"shape":"RatioScale",
"documentation":"<p>The level of importance assigned to the resources associated with the finding.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"
},
"RelatedFindings":{
"shape":"RelatedFindingList",
"documentation":"<p>A list of findings that are related to the current finding.</p>"
},
"Severity":{
"shape":"FindingProviderSeverity",
"documentation":"<p>The severity of a finding.</p>"
},
"Types":{
"shape":"TypeList",
"documentation":"<p>One or more finding types in the format of <code>namespace/category/classifier</code> that classify a finding.</p> <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications</p>"
}
},
"documentation":"<p>In a <code>BatchImportFindings</code> request, finding providers use <code>FindingProviderFields</code> to provide and update values for confidence, criticality, related findings, severity, and types.</p>"
},
"FindingProviderSeverity":{
"type":"structure",
"members":{
"Label":{
"shape":"SeverityLabel",
"documentation":"<p>The severity label assigned to the finding by the finding provider.</p>"
},
"Original":{
"shape":"NonEmptyString",
"documentation":"<p>The finding provider's original value for the severity.</p>"
}
},
"documentation":"<p>The severity assigned to the finding by the finding provider.</p>"
},
"GeoLocation":{
"type":"structure",
"members":{
"Lon":{
"shape":"Double",
"documentation":"<p>The longitude of the location.</p>"
},
"Lat":{
"shape":"Double",
"documentation":"<p>The latitude of the location.</p>"
}
},
"documentation":"<p>Provides the latitude and longitude coordinates of a location.</p>"
},
"GetEnabledStandardsRequest":{
"type":"structure",
"members":{
"StandardsSubscriptionArns":{
"shape":"StandardsSubscriptionArns",
"documentation":"<p>The list of the standards subscription ARNs for the standards to retrieve.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>GetEnabledStandards</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>"
}
}
},
"GetEnabledStandardsResponse":{
"type":"structure",
"members":{
"StandardsSubscriptions":{
"shape":"StandardsSubscriptions",
"documentation":"<p>The list of <code>StandardsSubscriptions</code> objects that include information about the enabled standards.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"GetFindingsRequest":{
"type":"structure",
"members":{
"Filters":{
"shape":"AwsSecurityFindingFilters",
"documentation":"<p>The finding attributes used to define a condition to filter the returned findings.</p> <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p> <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>"
},
"SortCriteria":{
"shape":"SortCriteria",
"documentation":"<p>The finding attributes used to sort the list of returned findings.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of findings to return.</p>"
}
}
},
"GetFindingsResponse":{
"type":"structure",
"required":["Findings"],
"members":{
"Findings":{
"shape":"AwsSecurityFindingList",
"documentation":"<p>The findings that matched the filters specified in the request.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"GetInsightResultsRequest":{
"type":"structure",
"required":["InsightArn"],
"members":{
"InsightArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the insight for which to return results.</p>",
"location":"uri",
"locationName":"InsightArn"
}
}
},
"GetInsightResultsResponse":{
"type":"structure",
"required":["InsightResults"],
"members":{
"InsightResults":{
"shape":"InsightResults",
"documentation":"<p>The insight results returned by the operation.</p>"
}
}
},
"GetInsightsRequest":{
"type":"structure",
"members":{
"InsightArns":{
"shape":"ArnList",
"documentation":"<p>The ARNs of the insights to describe. If you do not provide any insight ARNs, then <code>GetInsights</code> returns all of your custom insights. It does not return any managed insights.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>GetInsights</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to return in the response.</p>"
}
}
},
"GetInsightsResponse":{
"type":"structure",
"required":["Insights"],
"members":{
"Insights":{
"shape":"InsightList",
"documentation":"<p>The insights returned by the operation.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"GetInvitationsCountRequest":{
"type":"structure",
"members":{
}
},
"GetInvitationsCountResponse":{
"type":"structure",
"members":{
"InvitationsCount":{
"shape":"Integer",
"documentation":"<p>The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.</p>"
}
}
},
"GetMasterAccountRequest":{
"type":"structure",
"members":{
}
},
"GetMasterAccountResponse":{
"type":"structure",
"members":{
"Master":{
"shape":"Invitation",
"documentation":"<p>A list of details about the Security Hub master account for the current member account. </p>"
}
}
},
"GetMembersRequest":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The list of account IDs for the Security Hub member accounts to return the details for. </p>"
}
}
},
"GetMembersResponse":{
"type":"structure",
"members":{
"Members":{
"shape":"MemberList",
"documentation":"<p>The list of details about the Security Hub member accounts.</p>"
},
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.</p>"
}
}
},
"ImportFindingsError":{
"type":"structure",
"required":[
"Id",
"ErrorCode",
"ErrorMessage"
],
"members":{
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the finding that could not be updated.</p>"
},
"ErrorCode":{
"shape":"NonEmptyString",
"documentation":"<p>The code of the error returned by the <code>BatchImportFindings</code> operation.</p>"
},
"ErrorMessage":{
"shape":"NonEmptyString",
"documentation":"<p>The message of the error returned by the <code>BatchImportFindings</code> operation.</p>"
}
},
"documentation":"<p>The list of the findings that cannot be imported. For each finding, the list provides the error.</p>"
},
"ImportFindingsErrorList":{
"type":"list",
"member":{"shape":"ImportFindingsError"}
},
"Insight":{
"type":"structure",
"required":[
"InsightArn",
"Name",
"Filters",
"GroupByAttribute"
],
"members":{
"InsightArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of a Security Hub insight.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of a Security Hub insight.</p>"
},
"Filters":{
"shape":"AwsSecurityFindingFilters",
"documentation":"<p>One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.</p>"
},
"GroupByAttribute":{
"shape":"NonEmptyString",
"documentation":"<p>The grouping attribute for the insight's findings. Indicates how to group the matching findings, and identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.</p>"
}
},
"documentation":"<p>Contains information about a Security Hub insight.</p>"
},
"InsightList":{
"type":"list",
"member":{"shape":"Insight"}
},
"InsightResultValue":{
"type":"structure",
"required":[
"GroupByAttributeValue",
"Count"
],
"members":{
"GroupByAttributeValue":{
"shape":"NonEmptyString",
"documentation":"<p>The value of the attribute that the findings are grouped by for the insight whose results are returned by the <code>GetInsightResults</code> operation.</p>"
},
"Count":{
"shape":"Integer",
"documentation":"<p>The number of findings returned for each <code>GroupByAttributeValue</code>.</p>"
}
},
"documentation":"<p>The insight result values returned by the <code>GetInsightResults</code> operation.</p>"
},
"InsightResultValueList":{
"type":"list",
"member":{"shape":"InsightResultValue"}
},
"InsightResults":{
"type":"structure",
"required":[
"InsightArn",
"GroupByAttribute",
"ResultValues"
],
"members":{
"InsightArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the insight whose results are returned by the <code>GetInsightResults</code> operation.</p>"
},
"GroupByAttribute":{
"shape":"NonEmptyString",
"documentation":"<p>The attribute that the findings are grouped by for the insight whose results are returned by the <code>GetInsightResults</code> operation.</p>"
},
"ResultValues":{
"shape":"InsightResultValueList",
"documentation":"<p>The list of insight result values returned by the <code>GetInsightResults</code> operation.</p>"
}
},
"documentation":"<p>The insight results returned by the <code>GetInsightResults</code> operation.</p>"
},
"Integer":{"type":"integer"},
"IntegrationType":{
"type":"string",
"enum":[
"SEND_FINDINGS_TO_SECURITY_HUB",
"RECEIVE_FINDINGS_FROM_SECURITY_HUB"
]
},
"IntegrationTypeList":{
"type":"list",
"member":{"shape":"IntegrationType"}
},
"InternalException":{
"type":"structure",
"members":{
"Message":{"shape":"NonEmptyString"},
"Code":{"shape":"NonEmptyString"}
},
"documentation":"<p>Internal server error.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidAccessException":{
"type":"structure",
"members":{
"Message":{"shape":"NonEmptyString"},
"Code":{"shape":"NonEmptyString"}
},
"documentation":"<p>There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.</p>",
"error":{"httpStatusCode":401},
"exception":true
},
"InvalidInputException":{
"type":"structure",
"members":{
"Message":{"shape":"NonEmptyString"},
"Code":{"shape":"NonEmptyString"}
},
"documentation":"<p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"Invitation":{
"type":"structure",
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID of the Security Hub master account that the invitation was sent from.</p>"
},
"InvitationId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the invitation sent to the member account.</p>"
},
"InvitedAt":{
"shape":"Timestamp",
"documentation":"<p>The timestamp of when the invitation was sent.</p>"
},
"MemberStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The current status of the association between the member and master accounts.</p>"
}
},
"documentation":"<p>Details about an invitation.</p>"
},
"InvitationList":{
"type":"list",
"member":{"shape":"Invitation"}
},
"InviteMembersRequest":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The list of account IDs of the AWS accounts to invite to Security Hub as members. </p>"
}
}
},
"InviteMembersResponse":{
"type":"structure",
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.</p>"
}
}
},
"IpFilter":{
"type":"structure",
"members":{
"Cidr":{
"shape":"NonEmptyString",
"documentation":"<p>A finding's CIDR value.</p>"
}
},
"documentation":"<p>The IP filter for querying findings.</p>"
},
"IpFilterList":{
"type":"list",
"member":{"shape":"IpFilter"}
},
"IpOrganizationDetails":{
"type":"structure",
"members":{
"Asn":{
"shape":"Integer",
"documentation":"<p>The Autonomous System Number (ASN) of the internet provider</p>"
},
"AsnOrg":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the organization that registered the ASN.</p>"
},
"Isp":{
"shape":"NonEmptyString",
"documentation":"<p>The ISP information for the internet provider.</p>"
},
"Org":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the internet provider.</p>"
}
},
"documentation":"<p>Provides information about an internet provider.</p>"
},
"Ipv6CidrBlockAssociation":{
"type":"structure",
"members":{
"AssociationId":{
"shape":"NonEmptyString",
"documentation":"<p>The association ID for the IPv6 CIDR block.</p>"
},
"Ipv6CidrBlock":{
"shape":"NonEmptyString",
"documentation":"<p>The IPv6 CIDR block.</p>"
},
"CidrBlockState":{
"shape":"NonEmptyString",
"documentation":"<p>Information about the state of the CIDR block.</p>"
}
},
"documentation":"<p>An IPV6 CIDR block association.</p>"
},
"Ipv6CidrBlockAssociationList":{
"type":"list",
"member":{"shape":"Ipv6CidrBlockAssociation"}
},
"KeywordFilter":{
"type":"structure",
"members":{
"Value":{
"shape":"NonEmptyString",
"documentation":"<p>A value for the keyword.</p>"
}
},
"documentation":"<p>A keyword filter for querying findings.</p>"
},
"KeywordFilterList":{
"type":"list",
"member":{"shape":"KeywordFilter"}
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"NonEmptyString"},
"Code":{"shape":"NonEmptyString"}
},
"documentation":"<p>The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.</p>",
"error":{"httpStatusCode":429},
"exception":true
},
"ListEnabledProductsForImportRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>ListEnabledProductsForImport</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to return in the response.</p>",
"location":"querystring",
"locationName":"MaxResults"
}
}
},
"ListEnabledProductsForImportResponse":{
"type":"structure",
"members":{
"ProductSubscriptions":{
"shape":"ProductSubscriptionArnList",
"documentation":"<p>The list of ARNs for the resources that represent your subscriptions to products. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"ListInvitationsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"CrossAccountMaxResults",
"documentation":"<p>The maximum number of items to return in the response. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>ListInvitations</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
"location":"querystring",
"locationName":"NextToken"
}
}
},
"ListInvitationsResponse":{
"type":"structure",
"members":{
"Invitations":{
"shape":"InvitationList",
"documentation":"<p>The details of the invitations returned by the operation.</p>"
},
"NextToken":{
"shape":"NonEmptyString",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"ListMembersRequest":{
"type":"structure",
"members":{
"OnlyAssociated":{
"shape":"Boolean",
"documentation":"<p>Specifies which member accounts to include in the response based on their relationship status with the master account. The default value is <code>TRUE</code>.</p> <p>If <code>OnlyAssociated</code> is set to <code>TRUE</code>, the response includes member accounts whose relationship status with the master is set to <code>ENABLED</code>.</p> <p>If <code>OnlyAssociated</code> is set to <code>FALSE</code>, the response includes all existing member accounts. </p>",
"location":"querystring",
"locationName":"OnlyAssociated"
},
"MaxResults":{
"shape":"CrossAccountMaxResults",
"documentation":"<p>The maximum number of items to return in the response. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>ListMembers</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
"location":"querystring",
"locationName":"NextToken"
}
}
},
"ListMembersResponse":{
"type":"structure",
"members":{
"Members":{
"shape":"MemberList",
"documentation":"<p>Member details returned by the operation.</p>"
},
"NextToken":{
"shape":"NonEmptyString",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"ListOrganizationAdminAccountsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"AdminsMaxResults",
"documentation":"<p>The maximum number of items to return in the response.</p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that is required for pagination. On your first call to the <code>ListOrganizationAdminAccounts</code> operation, set the value of this parameter to <code>NULL</code>. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response. </p>",
"location":"querystring",
"locationName":"NextToken"
}
}
},
"ListOrganizationAdminAccountsResponse":{
"type":"structure",
"members":{
"AdminAccounts":{
"shape":"AdminAccounts",
"documentation":"<p>The list of Security Hub administrator accounts.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource to retrieve tags for.</p>",
"location":"uri",
"locationName":"ResourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagMap",
"documentation":"<p>The tags associated with a resource.</p>"
}
}
},
"LoadBalancerState":{
"type":"structure",
"members":{
"Code":{
"shape":"NonEmptyString",
"documentation":"<p>The state code. The initial state of the load balancer is provisioning.</p> <p>After the load balancer is fully set up and ready to route traffic, its state is active.</p> <p>If the load balancer could not be set up, its state is failed. </p>"
},
"Reason":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the state.</p>"
}
},
"documentation":"<p>Information about the state of the load balancer.</p>"
},
"Long":{"type":"long"},
"Malware":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the malware that was observed.</p>"
},
"Type":{
"shape":"MalwareType",
"documentation":"<p>The type of the malware that was observed.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The file system path of the malware that was observed.</p>"
},
"State":{
"shape":"MalwareState",
"documentation":"<p>The state of the malware that was observed.</p>"
}
},
"documentation":"<p>A list of malware related to a finding.</p>"
},
"MalwareList":{
"type":"list",
"member":{"shape":"Malware"}
},
"MalwareState":{
"type":"string",
"enum":[
"OBSERVED",
"REMOVAL_FAILED",
"REMOVED"
]
},
"MalwareType":{
"type":"string",
"enum":[
"ADWARE",
"BLENDED_THREAT",
"BOTNET_AGENT",
"COIN_MINER",
"EXPLOIT_KIT",
"KEYLOGGER",
"MACRO",
"POTENTIALLY_UNWANTED",
"SPYWARE",
"RANSOMWARE",
"REMOTE_ACCESS",
"ROOTKIT",
"TROJAN",
"VIRUS",
"WORM"
]
},
"MapFilter":{
"type":"structure",
"members":{
"Key":{
"shape":"NonEmptyString",
"documentation":"<p>The key of the map filter. For example, for <code>ResourceTags</code>, <code>Key</code> identifies the name of the tag. For <code>UserDefinedFields</code>, <code>Key</code> is the name of the field.</p>"
},
"Value":{
"shape":"NonEmptyString",
"documentation":"<p>The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called <code>Department</code> might be <code>Security</code>. If you provide <code>security</code> as the filter value, then there is no match.</p>"
},
"Comparison":{
"shape":"MapFilterComparison",
"documentation":"<p>The condition to apply to the key value when querying for findings with a map filter.</p> <p>To search for values that exactly match the filter value, use <code>EQUALS</code>. For example, for the <code>ResourceTags</code> field, the filter <code>Department EQUALS Security</code> matches findings that have the value <code>Security</code> for the tag <code>Department</code>.</p> <p>To search for values other than the filter value, use <code>NOT_EQUALS</code>. For example, for the <code>ResourceTags</code> field, the filter <code>Department NOT_EQUALS Finance</code> matches findings that do not have the value <code>Finance</code> for the tag <code>Department</code>.</p> <p> <code>EQUALS</code> filters on the same field are joined by <code>OR</code>. A finding matches if it matches any one of those filters.</p> <p> <code>NOT_EQUALS</code> filters on the same field are joined by <code>AND</code>. A finding matches only if it matches all of those filters.</p> <p>You cannot have both an <code>EQUALS</code> filter and a <code>NOT_EQUALS</code> filter on the same field.</p>"
}
},
"documentation":"<p>A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.</p>"
},
"MapFilterComparison":{
"type":"string",
"enum":[
"EQUALS",
"NOT_EQUALS"
]
},
"MapFilterList":{
"type":"list",
"member":{"shape":"MapFilter"}
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"Member":{
"type":"structure",
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The AWS account ID of the member account.</p>"
},
"Email":{
"shape":"NonEmptyString",
"documentation":"<p>The email address of the member account.</p>"
},
"MasterId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account ID of the Security Hub master account associated with this member account.</p>"
},
"MemberStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the relationship between the member account and its master account. </p> <p>The status can have one of the following values:</p> <ul> <li> <p> <code>CREATED</code> - Indicates that the master account added the member account, but has not yet invited the member account.</p> </li> <li> <p> <code>INVITED</code> - Indicates that the master account invited the member account. The member account has not yet responded to the invitation.</p> </li> <li> <p> <code>ENABLED</code> - Indicates that the member account is currently active. For manually invited member accounts, indicates that the member account accepted the invitation.</p> </li> <li> <p> <code>REMOVED</code> - Indicates that the master account disassociated the member account.</p> </li> <li> <p> <code>RESIGNED</code> - Indicates that the member account disassociated themselves from the master account.</p> </li> <li> <p> <code>DELETED</code> - Indicates that the master account deleted the member account.</p> </li> </ul>"
},
"InvitedAt":{
"shape":"Timestamp",
"documentation":"<p>A timestamp for the date and time when the invitation was sent to the member account.</p>"
},
"UpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The timestamp for the date and time when the member account was updated.</p>"
}
},
"documentation":"<p>The details about a member account.</p>"
},
"MemberList":{
"type":"list",
"member":{"shape":"Member"}
},
"Network":{
"type":"structure",
"members":{
"Direction":{
"shape":"NetworkDirection",
"documentation":"<p>The direction of network traffic associated with a finding.</p>"
},
"Protocol":{
"shape":"NonEmptyString",
"documentation":"<p>The protocol of network-related information about a finding.</p>"
},
"OpenPortRange":{
"shape":"PortRange",
"documentation":"<p>The range of open ports that is present on the network.</p>"
},
"SourceIpV4":{
"shape":"NonEmptyString",
"documentation":"<p>The source IPv4 address of network-related information about a finding.</p>"
},
"SourceIpV6":{
"shape":"NonEmptyString",
"documentation":"<p>The source IPv6 address of network-related information about a finding.</p>"
},
"SourcePort":{
"shape":"Integer",
"documentation":"<p>The source port of network-related information about a finding.</p>"
},
"SourceDomain":{
"shape":"NonEmptyString",
"documentation":"<p>The source domain of network-related information about a finding.</p>"
},
"SourceMac":{
"shape":"NonEmptyString",
"documentation":"<p>The source media access control (MAC) address of network-related information about a finding.</p>"
},
"DestinationIpV4":{
"shape":"NonEmptyString",
"documentation":"<p>The destination IPv4 address of network-related information about a finding.</p>"
},
"DestinationIpV6":{
"shape":"NonEmptyString",
"documentation":"<p>The destination IPv6 address of network-related information about a finding.</p>"
},
"DestinationPort":{
"shape":"Integer",
"documentation":"<p>The destination port of network-related information about a finding.</p>"
},
"DestinationDomain":{
"shape":"NonEmptyString",
"documentation":"<p>The destination domain of network-related information about a finding.</p>"
}
},
"documentation":"<p>The details of network-related information about a finding.</p>"
},
"NetworkConnectionAction":{
"type":"structure",
"members":{
"ConnectionDirection":{
"shape":"NonEmptyString",
"documentation":"<p>The direction of the network connection request (<code>IN</code> or <code>OUT</code>).</p>"
},
"RemoteIpDetails":{
"shape":"ActionRemoteIpDetails",
"documentation":"<p>Information about the remote IP address that issued the network connection request.</p>"
},
"RemotePortDetails":{
"shape":"ActionRemotePortDetails",
"documentation":"<p>Information about the port on the remote IP address.</p>"
},
"LocalPortDetails":{
"shape":"ActionLocalPortDetails",
"documentation":"<p>Information about the port on the EC2 instance.</p>"
},
"Protocol":{
"shape":"NonEmptyString",
"documentation":"<p>The protocol used to make the network connection request.</p>"
},
"Blocked":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the network connection attempt was blocked.</p>"
}
},
"documentation":"<p>Provided if <code>ActionType</code> is <code>NETWORK_CONNECTION</code>. It provides details about the attempted network connection that was detected.</p>"
},
"NetworkDirection":{
"type":"string",
"enum":[
"IN",
"OUT"
]
},
"NetworkHeader":{
"type":"structure",
"members":{
"Protocol":{
"shape":"NonEmptyString",
"documentation":"<p>The protocol used for the component.</p>"
},
"Destination":{
"shape":"NetworkPathComponentDetails",
"documentation":"<p>Information about the destination of the component.</p>"
},
"Source":{
"shape":"NetworkPathComponentDetails",
"documentation":"<p>Information about the origin of the component.</p>"
}
},
"documentation":"<p>Details about a network path component that occurs before or after the current component.</p>"
},
"NetworkPathComponent":{
"type":"structure",
"members":{
"ComponentId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of a component in the network path.</p>"
},
"ComponentType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of component.</p>"
},
"Egress":{
"shape":"NetworkHeader",
"documentation":"<p>Information about the component that comes after the current component in the network path.</p>"
},
"Ingress":{
"shape":"NetworkHeader",
"documentation":"<p>Information about the component that comes before the current node in the network path.</p>"
}
},
"documentation":"<p>Information about a network path component.</p>"
},
"NetworkPathComponentDetails":{
"type":"structure",
"members":{
"Address":{
"shape":"StringList",
"documentation":"<p>The IP addresses of the destination.</p>"
},
"PortRanges":{
"shape":"PortRangeList",
"documentation":"<p>A list of port ranges for the destination.</p>"
}
},
"documentation":"<p>Information about the destination of the next component in the network path.</p>"
},
"NetworkPathList":{
"type":"list",
"member":{"shape":"NetworkPathComponent"}
},
"NextToken":{"type":"string"},
"NonEmptyString":{
"type":"string",
"pattern":".*\\S.*"
},
"NonEmptyStringList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"Note":{
"type":"structure",
"required":[
"Text",
"UpdatedBy",
"UpdatedAt"
],
"members":{
"Text":{
"shape":"NonEmptyString",
"documentation":"<p>The text of a note.</p>"
},
"UpdatedBy":{
"shape":"NonEmptyString",
"documentation":"<p>The principal that created a note.</p>"
},
"UpdatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>The timestamp of when the note was updated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>A user-defined note added to a finding.</p>"
},
"NoteUpdate":{
"type":"structure",
"required":[
"Text",
"UpdatedBy"
],
"members":{
"Text":{
"shape":"NonEmptyString",
"documentation":"<p>The updated note text.</p>"
},
"UpdatedBy":{
"shape":"NonEmptyString",
"documentation":"<p>The principal that updated the note.</p>"
}
},
"documentation":"<p>The updated note.</p>"
},
"NumberFilter":{
"type":"structure",
"members":{
"Gte":{
"shape":"Double",
"documentation":"<p>The greater-than-equal condition to be applied to a single field when querying for findings. </p>"
},
"Lte":{
"shape":"Double",
"documentation":"<p>The less-than-equal condition to be applied to a single field when querying for findings. </p>"
},
"Eq":{
"shape":"Double",
"documentation":"<p>The equal-to condition to be applied to a single field when querying for findings.</p>"
}
},
"documentation":"<p>A number filter for querying findings.</p>"
},
"NumberFilterList":{
"type":"list",
"member":{"shape":"NumberFilter"}
},
"Occurrences":{
"type":"structure",
"members":{
"LineRanges":{
"shape":"Ranges",
"documentation":"<p>Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.</p>"
},
"OffsetRanges":{
"shape":"Ranges",
"documentation":"<p>Occurrences of sensitive data detected in a binary text file.</p>"
},
"Pages":{
"shape":"Pages",
"documentation":"<p>Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.</p>"
},
"Records":{
"shape":"Records",
"documentation":"<p>Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.</p>"
},
"Cells":{
"shape":"Cells",
"documentation":"<p>Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.</p>"
}
},
"documentation":"<p>The detected occurrences of sensitive data.</p>"
},
"Page":{
"type":"structure",
"members":{
"PageNumber":{
"shape":"Long",
"documentation":"<p>The page number of the page that contains the sensitive data.</p>"
},
"LineRange":{
"shape":"Range",
"documentation":"<p>An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.</p>"
},
"OffsetRange":{
"shape":"Range",
"documentation":"<p>An occurrence of sensitive data detected in a binary text file.</p>"
}
},
"documentation":"<p>An occurrence of sensitive data in an Adobe Portable Document Format (PDF) file.</p>"
},
"Pages":{
"type":"list",
"member":{"shape":"Page"}
},
"Partition":{
"type":"string",
"enum":[
"aws",
"aws-cn",
"aws-us-gov"
]
},
"PatchSummary":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the compliance standard that was used to determine the patch compliance status.</p>"
},
"InstalledCount":{
"shape":"Integer",
"documentation":"<p>The number of patches from the compliance standard that were installed successfully.</p>"
},
"MissingCount":{
"shape":"Integer",
"documentation":"<p>The number of patches that are part of the compliance standard but are not installed. The count includes patches that failed to install.</p>"
},
"FailedCount":{
"shape":"Integer",
"documentation":"<p>The number of patches from the compliance standard that failed to install.</p>"
},
"InstalledOtherCount":{
"shape":"Integer",
"documentation":"<p>The number of installed patches that are not part of the compliance standard.</p>"
},
"InstalledRejectedCount":{
"shape":"Integer",
"documentation":"<p>The number of patches that are installed but are also on a list of patches that the customer rejected.</p>"
},
"InstalledPendingReboot":{
"shape":"Integer",
"documentation":"<p>The number of patches that were applied, but that require the instance to be rebooted in order to be marked as installed.</p>"
},
"OperationStartTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the operation started.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"OperationEndTime":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the operation completed.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"RebootOption":{
"shape":"NonEmptyString",
"documentation":"<p>The reboot option specified for the instance.</p>"
},
"Operation":{
"shape":"NonEmptyString",
"documentation":"<p>The type of patch operation performed. For Patch Manager, the values are <code>SCAN</code> and <code>INSTALL</code>. </p>"
}
},
"documentation":"<p>Provides an overview of the patch compliance status for an instance against a selected compliance standard.</p>"
},
"PortProbeAction":{
"type":"structure",
"members":{
"PortProbeDetails":{
"shape":"PortProbeDetailList",
"documentation":"<p>Information about the ports affected by the port probe.</p>"
},
"Blocked":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the port probe was blocked.</p>"
}
},
"documentation":"<p>Provided if <code>ActionType</code> is <code>PORT_PROBE</code>. It provides details about the attempted port probe that was detected.</p>"
},
"PortProbeDetail":{
"type":"structure",
"members":{
"LocalPortDetails":{
"shape":"ActionLocalPortDetails",
"documentation":"<p>Provides information about the port that was scanned.</p>"
},
"LocalIpDetails":{
"shape":"ActionLocalIpDetails",
"documentation":"<p>Provides information about the IP address where the scanned port is located.</p>"
},
"RemoteIpDetails":{
"shape":"ActionRemoteIpDetails",
"documentation":"<p>Provides information about the remote IP address that performed the scan.</p>"
}
},
"documentation":"<p>A port scan that was part of the port probe. For each scan, PortProbeDetails provides information about the local IP address and port that were scanned, and the remote IP address that the scan originated from.</p>"
},
"PortProbeDetailList":{
"type":"list",
"member":{"shape":"PortProbeDetail"}
},
"PortRange":{
"type":"structure",
"members":{
"Begin":{
"shape":"Integer",
"documentation":"<p>The first port in the port range.</p>"
},
"End":{
"shape":"Integer",
"documentation":"<p>The last port in the port range.</p>"
}
},
"documentation":"<p>A range of ports.</p>"
},
"PortRangeList":{
"type":"list",
"member":{"shape":"PortRange"}
},
"ProcessDetails":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the process.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the process executable.</p>"
},
"Pid":{
"shape":"Integer",
"documentation":"<p>The process ID.</p>"
},
"ParentPid":{
"shape":"Integer",
"documentation":"<p>The parent process ID.</p>"
},
"LaunchedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the process was launched.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"TerminatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the process was terminated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>The details of process-related information about a finding.</p>"
},
"Product":{
"type":"structure",
"required":["ProductArn"],
"members":{
"ProductArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN assigned to the product.</p>"
},
"ProductName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the product.</p>"
},
"CompanyName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the company that provides the product.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the product.</p>"
},
"Categories":{
"shape":"CategoryList",
"documentation":"<p>The categories assigned to the product.</p>"
},
"IntegrationTypes":{
"shape":"IntegrationTypeList",
"documentation":"<p>The types of integration that the product supports. Available values are the following.</p> <ul> <li> <p> <code>SEND_FINDINGS_TO_SECURITY_HUB</code> - Indicates that the integration sends findings to Security Hub.</p> </li> <li> <p> <code>RECEIVE_FINDINGS_FROM_SECURITY_HUB</code> - Indicates that the integration receives findings from Security Hub.</p> </li> </ul>"
},
"MarketplaceUrl":{
"shape":"NonEmptyString",
"documentation":"<p>The URL for the page that contains more information about the product.</p>"
},
"ActivationUrl":{
"shape":"NonEmptyString",
"documentation":"<p>The URL used to activate the product.</p>"
},
"ProductSubscriptionResourcePolicy":{
"shape":"NonEmptyString",
"documentation":"<p>The resource policy associated with the product.</p>"
}
},
"documentation":"<p>Contains details about a product.</p>"
},
"ProductSubscriptionArnList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"ProductsList":{
"type":"list",
"member":{"shape":"Product"}
},
"Range":{
"type":"structure",
"members":{
"Start":{
"shape":"Long",
"documentation":"<p>The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.</p>"
},
"End":{
"shape":"Long",
"documentation":"<p>The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.</p>"
},
"StartColumn":{
"shape":"Long",
"documentation":"<p>In the line where the sensitive data starts, the column within the line where the sensitive data starts.</p>"
}
},
"documentation":"<p>Identifies where the sensitive data begins and ends.</p>"
},
"Ranges":{
"type":"list",
"member":{"shape":"Range"}
},
"RatioScale":{
"type":"integer",
"max":100,
"min":0
},
"Recommendation":{
"type":"structure",
"members":{
"Text":{
"shape":"NonEmptyString",
"documentation":"<p>Describes the recommended steps to take to remediate an issue identified in a finding.</p>"
},
"Url":{
"shape":"NonEmptyString",
"documentation":"<p>A URL to a page or site that contains information about how to remediate a finding.</p>"
}
},
"documentation":"<p>A recommendation on how to remediate the issue identified in a finding.</p>"
},
"Record":{
"type":"structure",
"members":{
"JsonPath":{
"shape":"NonEmptyString",
"documentation":"<p>The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.</p>"
},
"RecordIndex":{
"shape":"Long",
"documentation":"<p>The record index, starting from 0, for the record that contains the data.</p>"
}
},
"documentation":"<p>An occurrence of sensitive data in an Apache Avro object container or an Apache Parquet file.</p>"
},
"RecordState":{
"type":"string",
"enum":[
"ACTIVE",
"ARCHIVED"
]
},
"Records":{
"type":"list",
"member":{"shape":"Record"}
},
"RelatedFinding":{
"type":"structure",
"required":[
"ProductArn",
"Id"
],
"members":{
"ProductArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the product that generated a related finding.</p>"
},
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The product-generated identifier for a related finding.</p>"
}
},
"documentation":"<p>Details about a related finding.</p>"
},
"RelatedFindingList":{
"type":"list",
"member":{"shape":"RelatedFinding"}
},
"RelatedRequirementsList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"Remediation":{
"type":"structure",
"members":{
"Recommendation":{
"shape":"Recommendation",
"documentation":"<p>A recommendation on the steps to take to remediate the issue identified by a finding.</p>"
}
},
"documentation":"<p>Details about the remediation steps for a finding.</p>"
},
"Resource":{
"type":"structure",
"required":[
"Type",
"Id"
],
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of the resource that details are provided for. If possible, set <code>Type</code> to one of the supported resource types. For example, if the resource is an EC2 instance, then set <code>Type</code> to <code>AwsEc2Instance</code>.</p> <p>If the resource does not match any of the provided types, then set <code>Type</code> to <code>Other</code>. </p>"
},
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The canonical identifier for the given resource type.</p>"
},
"Partition":{
"shape":"Partition",
"documentation":"<p>The canonical AWS partition name that the Region is assigned to.</p>"
},
"Region":{
"shape":"NonEmptyString",
"documentation":"<p>The canonical AWS external Region name where this resource is located.</p>"
},
"ResourceRole":{
"shape":"NonEmptyString",
"documentation":"<p>Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,</p>"
},
"Tags":{
"shape":"FieldMap",
"documentation":"<p>A list of AWS tags associated with a resource at the time the finding was processed.</p>"
},
"DataClassification":{
"shape":"DataClassificationDetails",
"documentation":"<p>Contains information about sensitive data that was detected on the resource.</p>"
},
"Details":{
"shape":"ResourceDetails",
"documentation":"<p>Additional details about the resource related to a finding.</p>"
}
},
"documentation":"<p>A resource related to a finding.</p>"
},
"ResourceArn":{
"type":"string",
"pattern":"^arn:aws:securityhub:.*"
},
"ResourceConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"NonEmptyString"},
"Code":{"shape":"NonEmptyString"}
},
"documentation":"<p>The resource specified in the request conflicts with an existing resource.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceDetails":{
"type":"structure",
"members":{
"AwsAutoScalingAutoScalingGroup":{
"shape":"AwsAutoScalingAutoScalingGroupDetails",
"documentation":"<p>Details for an autoscaling group.</p>"
},
"AwsCodeBuildProject":{
"shape":"AwsCodeBuildProjectDetails",
"documentation":"<p>Details for an AWS CodeBuild project.</p>"
},
"AwsCloudFrontDistribution":{
"shape":"AwsCloudFrontDistributionDetails",
"documentation":"<p>Details about a CloudFront distribution.</p>"
},
"AwsEc2Instance":{
"shape":"AwsEc2InstanceDetails",
"documentation":"<p>Details about an Amazon EC2 instance related to a finding.</p>"
},
"AwsEc2NetworkInterface":{
"shape":"AwsEc2NetworkInterfaceDetails",
"documentation":"<p>Details for an Amazon EC2 network interface.</p>"
},
"AwsEc2SecurityGroup":{
"shape":"AwsEc2SecurityGroupDetails",
"documentation":"<p>Details for an EC2 security group.</p>"
},
"AwsEc2Volume":{
"shape":"AwsEc2VolumeDetails",
"documentation":"<p>Details for an EC2 volume.</p>"
},
"AwsEc2Vpc":{
"shape":"AwsEc2VpcDetails",
"documentation":"<p>Details for an EC2 VPC.</p>"
},
"AwsEc2Eip":{
"shape":"AwsEc2EipDetails",
"documentation":"<p>Details about an Elastic IP address.</p>"
},
"AwsElbv2LoadBalancer":{
"shape":"AwsElbv2LoadBalancerDetails",
"documentation":"<p>Details about a load balancer.</p>"
},
"AwsElasticsearchDomain":{
"shape":"AwsElasticsearchDomainDetails",
"documentation":"<p>Details for an Elasticsearch domain.</p>"
},
"AwsS3Bucket":{
"shape":"AwsS3BucketDetails",
"documentation":"<p>Details about an Amazon S3 bucket related to a finding.</p>"
},
"AwsS3AccountPublicAccessBlock":{
"shape":"AwsS3AccountPublicAccessBlockDetails",
"documentation":"<p>Details about the Amazon S3 Public Access Block configuration for an account.</p>"
},
"AwsS3Object":{
"shape":"AwsS3ObjectDetails",
"documentation":"<p>Details about an Amazon S3 object related to a finding.</p>"
},
"AwsSecretsManagerSecret":{
"shape":"AwsSecretsManagerSecretDetails",
"documentation":"<p>Details about a Secrets Manager secret.</p>"
},
"AwsIamAccessKey":{
"shape":"AwsIamAccessKeyDetails",
"documentation":"<p>Details about an IAM access key related to a finding.</p>"
},
"AwsIamUser":{
"shape":"AwsIamUserDetails",
"documentation":"<p>Details about an IAM user.</p>"
},
"AwsIamPolicy":{
"shape":"AwsIamPolicyDetails",
"documentation":"<p>Details about an IAM permissions policy.</p>"
},
"AwsApiGatewayV2Stage":{
"shape":"AwsApiGatewayV2StageDetails",
"documentation":"<p>Provides information about a version 2 stage for Amazon API Gateway.</p>"
},
"AwsApiGatewayV2Api":{
"shape":"AwsApiGatewayV2ApiDetails",
"documentation":"<p>Provides information about a version 2 API in Amazon API Gateway.</p>"
},
"AwsDynamoDbTable":{
"shape":"AwsDynamoDbTableDetails",
"documentation":"<p>Details about a DynamoDB table.</p>"
},
"AwsApiGatewayStage":{
"shape":"AwsApiGatewayStageDetails",
"documentation":"<p>Provides information about a version 1 Amazon API Gateway stage.</p>"
},
"AwsApiGatewayRestApi":{
"shape":"AwsApiGatewayRestApiDetails",
"documentation":"<p>Provides information about a REST API in version 1 of Amazon API Gateway.</p>"
},
"AwsCloudTrailTrail":{
"shape":"AwsCloudTrailTrailDetails",
"documentation":"<p>Provides details about a CloudTrail trail.</p>"
},
"AwsSsmPatchCompliance":{
"shape":"AwsSsmPatchComplianceDetails",
"documentation":"<p>Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.</p>"
},
"AwsCertificateManagerCertificate":{
"shape":"AwsCertificateManagerCertificateDetails",
"documentation":"<p>Provides details about an AWS Certificate Manager (ACM) certificate.</p>"
},
"AwsRedshiftCluster":{
"shape":"AwsRedshiftClusterDetails",
"documentation":"<p>Contains details about an Amazon Redshift cluster.</p>"
},
"AwsElbLoadBalancer":{
"shape":"AwsElbLoadBalancerDetails",
"documentation":"<p>contains details about a Classic Load Balancer.</p>"
},
"AwsIamGroup":{
"shape":"AwsIamGroupDetails",
"documentation":"<p>Contains details about an IAM group.</p>"
},
"AwsIamRole":{
"shape":"AwsIamRoleDetails",
"documentation":"<p>Details about an IAM role.</p>"
},
"AwsKmsKey":{
"shape":"AwsKmsKeyDetails",
"documentation":"<p>Details about a KMS key.</p>"
},
"AwsLambdaFunction":{
"shape":"AwsLambdaFunctionDetails",
"documentation":"<p>Details about a Lambda function.</p>"
},
"AwsLambdaLayerVersion":{
"shape":"AwsLambdaLayerVersionDetails",
"documentation":"<p>Details for a Lambda layer version.</p>"
},
"AwsRdsDbInstance":{
"shape":"AwsRdsDbInstanceDetails",
"documentation":"<p>Details about an Amazon RDS database instance.</p>"
},
"AwsSnsTopic":{
"shape":"AwsSnsTopicDetails",
"documentation":"<p>Details about an SNS topic.</p>"
},
"AwsSqsQueue":{
"shape":"AwsSqsQueueDetails",
"documentation":"<p>Details about an SQS queue.</p>"
},
"AwsWafWebAcl":{
"shape":"AwsWafWebAclDetails",
"documentation":"<p>Details for a WAF WebACL.</p>"
},
"AwsRdsDbSnapshot":{
"shape":"AwsRdsDbSnapshotDetails",
"documentation":"<p>Details about an Amazon RDS database snapshot.</p>"
},
"AwsRdsDbClusterSnapshot":{
"shape":"AwsRdsDbClusterSnapshotDetails",
"documentation":"<p>Details about an Amazon RDS database cluster snapshot.</p>"
},
"AwsRdsDbCluster":{
"shape":"AwsRdsDbClusterDetails",
"documentation":"<p>Details about an Amazon RDS database cluster.</p>"
},
"Container":{
"shape":"ContainerDetails",
"documentation":"<p>Details about a container resource related to a finding.</p>"
},
"Other":{
"shape":"FieldMap",
"documentation":"<p>Details about a resource that are not available in a type-specific details object. Use the <code>Other</code> object in the following cases.</p> <ul> <li> <p>The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the <code>Other</code> object to populate the fields that are missing from the type-specific object.</p> </li> <li> <p>The resource type does not have a corresponding object. This includes resources for which the type is <code>Other</code>. </p> </li> </ul>"
}
},
"documentation":"<p>Additional details about a resource related to a finding.</p> <p>To provide the details, use the object that corresponds to the resource type. For example, if the resource type is <code>AwsEc2Instance</code>, then you use the <code>AwsEc2Instance</code> object to provide the details.</p> <p>If the type-specific object does not contain all of the fields you want to populate, then you use the <code>Other</code> object to populate those additional fields.</p> <p>You also use the <code>Other</code> object to populate the details when the selected type does not have a corresponding object.</p>"
},
"ResourceList":{
"type":"list",
"member":{"shape":"Resource"}
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"NonEmptyString"},
"Code":{"shape":"NonEmptyString"}
},
"documentation":"<p>The request was rejected because we can't find the specified resource.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"Result":{
"type":"structure",
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>An AWS account ID of the account that was not processed.</p>"
},
"ProcessingResult":{
"shape":"NonEmptyString",
"documentation":"<p>The reason that the account was not processed.</p>"
}
},
"documentation":"<p>Details about the account that was not processed.</p>"
},
"ResultList":{
"type":"list",
"member":{"shape":"Result"}
},
"SecurityGroups":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"SensitiveDataDetections":{
"type":"structure",
"members":{
"Count":{
"shape":"Long",
"documentation":"<p>The total number of occurrences of sensitive data that were detected.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.</p>"
},
"Occurrences":{
"shape":"Occurrences",
"documentation":"<p>Details about the sensitive data that was detected.</p>"
}
},
"documentation":"<p>The list of detected instances of sensitive data.</p>"
},
"SensitiveDataDetectionsList":{
"type":"list",
"member":{"shape":"SensitiveDataDetections"}
},
"SensitiveDataResult":{
"type":"structure",
"members":{
"Category":{
"shape":"NonEmptyString",
"documentation":"<p>The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.</p>"
},
"Detections":{
"shape":"SensitiveDataDetectionsList",
"documentation":"<p>The list of detected instances of sensitive data.</p>"
},
"TotalCount":{
"shape":"Long",
"documentation":"<p>The total number of occurrences of sensitive data.</p>"
}
},
"documentation":"<p>Contains a detected instance of sensitive data that are based on built-in identifiers.</p>"
},
"SensitiveDataResultList":{
"type":"list",
"member":{"shape":"SensitiveDataResult"}
},
"Severity":{
"type":"structure",
"members":{
"Product":{
"shape":"Double",
"documentation":"<p>Deprecated. This attribute is being deprecated. Instead of providing <code>Product</code>, provide <code>Original</code>.</p> <p>The native severity as defined by the AWS service or integrated partner product that generated the finding.</p>"
},
"Label":{
"shape":"SeverityLabel",
"documentation":"<p>The severity value of the finding. The allowed values are the following.</p> <ul> <li> <p> <code>INFORMATIONAL</code> - No issue was found.</p> </li> <li> <p> <code>LOW</code> - The issue does not require action on its own.</p> </li> <li> <p> <code>MEDIUM</code> - The issue must be addressed but not urgently.</p> </li> <li> <p> <code>HIGH</code> - The issue must be addressed as a priority.</p> </li> <li> <p> <code>CRITICAL</code> - The issue must be remediated immediately to avoid it escalating.</p> </li> </ul> <p>If you provide <code>Normalized</code> and do not provide <code>Label</code>, then <code>Label</code> is set automatically as follows. </p> <ul> <li> <p>0 - <code>INFORMATIONAL</code> </p> </li> <li> <p>1–39 - <code>LOW</code> </p> </li> <li> <p>40–69 - <code>MEDIUM</code> </p> </li> <li> <p>70–89 - <code>HIGH</code> </p> </li> <li> <p>90–100 - <code>CRITICAL</code> </p> </li> </ul>"
},
"Normalized":{
"shape":"Integer",
"documentation":"<p>Deprecated. The normalized severity of a finding. This attribute is being deprecated. Instead of providing <code>Normalized</code>, provide <code>Label</code>.</p> <p>If you provide <code>Label</code> and do not provide <code>Normalized</code>, then <code>Normalized</code> is set automatically as follows.</p> <ul> <li> <p> <code>INFORMATIONAL</code> - 0</p> </li> <li> <p> <code>LOW</code> - 1</p> </li> <li> <p> <code>MEDIUM</code> - 40</p> </li> <li> <p> <code>HIGH</code> - 70</p> </li> <li> <p> <code>CRITICAL</code> - 90</p> </li> </ul>"
},
"Original":{
"shape":"NonEmptyString",
"documentation":"<p>The native severity from the finding product that generated the finding.</p>"
}
},
"documentation":"<p>The severity of the finding.</p> <p>The finding provider can provide the initial severity. The finding provider can only update the severity if it has not been updated using <code>BatchUpdateFindings</code>.</p> <p>The finding must have either <code>Label</code> or <code>Normalized</code> populated. If only one of these attributes is populated, then Security Hub automatically populates the other one. If neither attribute is populated, then the finding is invalid. <code>Label</code> is the preferred attribute.</p>"
},
"SeverityLabel":{
"type":"string",
"enum":[
"INFORMATIONAL",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
},
"SeverityRating":{
"type":"string",
"enum":[
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
},
"SeverityUpdate":{
"type":"structure",
"members":{
"Normalized":{
"shape":"RatioScale",
"documentation":"<p>The normalized severity for the finding. This attribute is to be deprecated in favor of <code>Label</code>.</p> <p>If you provide <code>Normalized</code> and do not provide <code>Label</code>, <code>Label</code> is set automatically as follows.</p> <ul> <li> <p>0 - <code>INFORMATIONAL</code> </p> </li> <li> <p>1–39 - <code>LOW</code> </p> </li> <li> <p>40–69 - <code>MEDIUM</code> </p> </li> <li> <p>70–89 - <code>HIGH</code> </p> </li> <li> <p>90–100 - <code>CRITICAL</code> </p> </li> </ul>"
},
"Product":{
"shape":"Double",
"documentation":"<p>The native severity as defined by the AWS service or integrated partner product that generated the finding.</p>"
},
"Label":{
"shape":"SeverityLabel",
"documentation":"<p>The severity value of the finding. The allowed values are the following.</p> <ul> <li> <p> <code>INFORMATIONAL</code> - No issue was found.</p> </li> <li> <p> <code>LOW</code> - The issue does not require action on its own.</p> </li> <li> <p> <code>MEDIUM</code> - The issue must be addressed but not urgently.</p> </li> <li> <p> <code>HIGH</code> - The issue must be addressed as a priority.</p> </li> <li> <p> <code>CRITICAL</code> - The issue must be remediated immediately to avoid it escalating.</p> </li> </ul>"
}
},
"documentation":"<p>Updates to the severity information for a finding.</p>"
},
"SizeBytes":{"type":"long"},
"SoftwarePackage":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the software package.</p>"
},
"Version":{
"shape":"NonEmptyString",
"documentation":"<p>The version of the software package.</p>"
},
"Epoch":{
"shape":"NonEmptyString",
"documentation":"<p>The epoch of the software package.</p>"
},
"Release":{
"shape":"NonEmptyString",
"documentation":"<p>The release of the software package.</p>"
},
"Architecture":{
"shape":"NonEmptyString",
"documentation":"<p>The architecture used for the software package.</p>"
}
},
"documentation":"<p>Information about a software package.</p>"
},
"SoftwarePackageList":{
"type":"list",
"member":{"shape":"SoftwarePackage"}
},
"SortCriteria":{
"type":"list",
"member":{"shape":"SortCriterion"}
},
"SortCriterion":{
"type":"structure",
"members":{
"Field":{
"shape":"NonEmptyString",
"documentation":"<p>The finding attribute used to sort findings.</p>"
},
"SortOrder":{
"shape":"SortOrder",
"documentation":"<p>The order used to sort findings.</p>"
}
},
"documentation":"<p>A collection of finding attributes used to sort findings.</p>"
},
"SortOrder":{
"type":"string",
"enum":[
"asc",
"desc"
]
},
"Standard":{
"type":"structure",
"members":{
"StandardsArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of a standard.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the standard.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the standard.</p>"
},
"EnabledByDefault":{
"shape":"Boolean",
"documentation":"<p>Whether the standard is enabled by default. When Security Hub is enabled from the console, if a standard is enabled by default, the check box for that standard is selected by default.</p> <p>When Security Hub is enabled using the <code>EnableSecurityHub</code> API operation, the standard is enabled by default unless <code>EnableDefaultStandards</code> is set to <code>false</code>.</p>"
}
},
"documentation":"<p>Provides information about a specific standard.</p>"
},
"Standards":{
"type":"list",
"member":{"shape":"Standard"}
},
"StandardsControl":{
"type":"structure",
"members":{
"StandardsControlArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the security standard control.</p>"
},
"ControlStatus":{
"shape":"ControlStatus",
"documentation":"<p>The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.</p>"
},
"DisabledReason":{
"shape":"NonEmptyString",
"documentation":"<p>The reason provided for the most recent change in status for the control.</p>"
},
"ControlStatusUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the status of the security standard control was most recently updated.</p>"
},
"ControlId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the security standard control.</p>"
},
"Title":{
"shape":"NonEmptyString",
"documentation":"<p>The title of the security standard control.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>The longer description of the security standard control. Provides information about what the control is checking for.</p>"
},
"RemediationUrl":{
"shape":"NonEmptyString",
"documentation":"<p>A link to remediation information for the control in the Security Hub user documentation.</p>"
},
"SeverityRating":{
"shape":"SeverityRating",
"documentation":"<p>The severity of findings generated from this security standard control.</p> <p>The finding severity is based on an assessment of how easy it would be to compromise AWS resources if the issue is detected.</p>"
},
"RelatedRequirements":{
"shape":"RelatedRequirementsList",
"documentation":"<p>The list of requirements that are related to this control.</p>"
}
},
"documentation":"<p>Details for an individual security standard control.</p>"
},
"StandardsControls":{
"type":"list",
"member":{"shape":"StandardsControl"}
},
"StandardsInputParameterMap":{
"type":"map",
"key":{"shape":"NonEmptyString"},
"value":{"shape":"NonEmptyString"}
},
"StandardsStatus":{
"type":"string",
"enum":[
"PENDING",
"READY",
"FAILED",
"DELETING",
"INCOMPLETE"
]
},
"StandardsSubscription":{
"type":"structure",
"required":[
"StandardsSubscriptionArn",
"StandardsArn",
"StandardsInput",
"StandardsStatus"
],
"members":{
"StandardsSubscriptionArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of a resource that represents your subscription to a supported standard.</p>"
},
"StandardsArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of a standard.</p>"
},
"StandardsInput":{
"shape":"StandardsInputParameterMap",
"documentation":"<p>A key-value pair of input for the standard.</p>"
},
"StandardsStatus":{
"shape":"StandardsStatus",
"documentation":"<p>The status of the standard subscription.</p> <p>The status values are as follows:</p> <ul> <li> <p> <code>PENDING</code> - Standard is in the process of being enabled.</p> </li> <li> <p> <code>READY</code> - Standard is enabled.</p> </li> <li> <p> <code>INCOMPLETE</code> - Standard could not be enabled completely. Some controls may not be available.</p> </li> <li> <p> <code>DELETING</code> - Standard is in the process of being disabled.</p> </li> <li> <p> <code>FAILED</code> - Standard could not be disabled.</p> </li> </ul>"
}
},
"documentation":"<p>A resource that represents your subscription to a supported standard.</p>"
},
"StandardsSubscriptionArns":{
"type":"list",
"member":{"shape":"NonEmptyString"},
"max":25,
"min":1
},
"StandardsSubscriptionRequest":{
"type":"structure",
"required":["StandardsArn"],
"members":{
"StandardsArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the standard that you want to enable. To view the list of available standards and their ARNs, use the <code> <a>DescribeStandards</a> </code> operation.</p>"
},
"StandardsInput":{
"shape":"StandardsInputParameterMap",
"documentation":"<p>A key-value pair of input for the standard.</p>"
}
},
"documentation":"<p>The standard that you want to enable.</p>"
},
"StandardsSubscriptionRequests":{
"type":"list",
"member":{"shape":"StandardsSubscriptionRequest"},
"max":25,
"min":1
},
"StandardsSubscriptions":{
"type":"list",
"member":{"shape":"StandardsSubscription"}
},
"StatusReason":{
"type":"structure",
"required":["ReasonCode"],
"members":{
"ReasonCode":{
"shape":"NonEmptyString",
"documentation":"<p>A code that represents a reason for the control status. For the list of status reason codes and their meanings, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff\">Standards-related information in the ASFF</a> in the <i>AWS Security Hub User Guide</i>. </p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>The corresponding description for the status reason code.</p>"
}
},
"documentation":"<p>Provides additional context for the value of <code>Compliance.Status</code>.</p>"
},
"StatusReasonsList":{
"type":"list",
"member":{"shape":"StatusReason"}
},
"StringFilter":{
"type":"structure",
"members":{
"Value":{
"shape":"NonEmptyString",
"documentation":"<p>The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is <code>Security Hub</code>. If you provide <code>security hub</code> as the filter text, then there is no match.</p>"
},
"Comparison":{
"shape":"StringFilterComparison",
"documentation":"<p>The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:</p> <ul> <li> <p>To search for values that exactly match the filter value, use <code>EQUALS</code>.</p> <p>For example, the filter <code>ResourceType EQUALS AwsEc2SecurityGroup</code> only matches findings that have a resource type of <code>AwsEc2SecurityGroup</code>.</p> </li> <li> <p>To search for values that start with the filter value, use <code>PREFIX</code>.</p> <p>For example, the filter <code>ResourceType PREFIX AwsIam</code> matches findings that have a resource type that starts with <code>AwsIam</code>. Findings with a resource type of <code>AwsIamPolicy</code>, <code>AwsIamRole</code>, or <code>AwsIamUser</code> would all match.</p> </li> </ul> <p> <code>EQUALS</code> and <code>PREFIX</code> filters on the same field are joined by <code>OR</code>. A finding matches if it matches any one of those filters.</p> <p>To search for values that do not contain the filter criteria value, use one of the following comparison operators:</p> <ul> <li> <p>To search for values that do not exactly match the filter value, use <code>NOT_EQUALS</code>.</p> <p>For example, the filter <code>ResourceType NOT_EQUALS AwsIamPolicy</code> matches findings that have a resource type other than <code>AwsIamPolicy</code>.</p> </li> <li> <p>To search for values that do not start with the filter value, use <code>PREFIX_NOT_EQUALS</code>.</p> <p>For example, the filter <code>ResourceType PREFIX_NOT_EQUALS AwsIam</code> matches findings that have a resource type that does not start with <code>AwsIam</code>. Findings with a resource type of <code>AwsIamPolicy</code>, <code>AwsIamRole</code>, or <code>AwsIamUser</code> would all be excluded from the results.</p> </li> </ul> <p> <code>NOT_EQUALS</code> and <code>PREFIX_NOT_EQUALS</code> filters on the same field are joined by <code>AND</code>. A finding matches only if it matches all of those filters.</p> <p>For filters on the same field, you cannot provide both an <code>EQUALS</code> filter and a <code>NOT_EQUALS</code> or <code>PREFIX_NOT_EQUALS</code> filter. Combining filters in this way always returns an error, even if the provided filter values would return valid results.</p> <p>You can combine <code>PREFIX</code> filters with <code>NOT_EQUALS</code> or <code>PREFIX_NOT_EQUALS</code> filters for the same field. Security Hub first processes the <code>PREFIX</code> filters, then the <code>NOT_EQUALS</code> or <code>PREFIX_NOT_EQUALS</code> filters.</p> <p> For example, for the following filter, Security Hub first identifies findings that have resource types that start with either <code>AwsIAM</code> or <code>AwsEc2</code>. It then excludes findings that have a resource type of <code>AwsIamPolicy</code> and findings that have a resource type of <code>AwsEc2NetworkInterface</code>.</p> <ul> <li> <p> <code>ResourceType PREFIX AwsIam</code> </p> </li> <li> <p> <code>ResourceType PREFIX AwsEc2</code> </p> </li> <li> <p> <code>ResourceType NOT_EQUALS AwsIamPolicy</code> </p> </li> <li> <p> <code>ResourceType NOT_EQUALS AwsEc2NetworkInterface</code> </p> </li> </ul>"
}
},
"documentation":"<p>A string filter for querying findings.</p>"
},
"StringFilterComparison":{
"type":"string",
"enum":[
"EQUALS",
"PREFIX",
"NOT_EQUALS",
"PREFIX_NOT_EQUALS"
]
},
"StringFilterList":{
"type":"list",
"member":{"shape":"StringFilter"}
},
"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":1
},
"TagMap":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":50,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource to apply the tags to.</p>",
"location":"uri",
"locationName":"ResourceArn"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>The tags to add to the resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256
},
"ThreatIntelIndicator":{
"type":"structure",
"members":{
"Type":{
"shape":"ThreatIntelIndicatorType",
"documentation":"<p>The type of threat intelligence indicator.</p>"
},
"Value":{
"shape":"NonEmptyString",
"documentation":"<p>The value of a threat intelligence indicator.</p>"
},
"Category":{
"shape":"ThreatIntelIndicatorCategory",
"documentation":"<p>The category of a threat intelligence indicator.</p>"
},
"LastObservedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the most recent instance of a threat intelligence indicator was observed.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"Source":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the threat intelligence indicator.</p>"
},
"SourceUrl":{
"shape":"NonEmptyString",
"documentation":"<p>The URL to the page or site where you can get more information about the threat intelligence indicator.</p>"
}
},
"documentation":"<p>Details about the threat intelligence related to a finding.</p>"
},
"ThreatIntelIndicatorCategory":{
"type":"string",
"enum":[
"BACKDOOR",
"CARD_STEALER",
"COMMAND_AND_CONTROL",
"DROP_SITE",
"EXPLOIT_SITE",
"KEYLOGGER"
]
},
"ThreatIntelIndicatorList":{
"type":"list",
"member":{"shape":"ThreatIntelIndicator"}
},
"ThreatIntelIndicatorType":{
"type":"string",
"enum":[
"DOMAIN",
"EMAIL_ADDRESS",
"HASH_MD5",
"HASH_SHA1",
"HASH_SHA256",
"HASH_SHA512",
"IPV4_ADDRESS",
"IPV6_ADDRESS",
"MUTEX",
"PROCESS",
"URL"
]
},
"Timestamp":{
"type":"timestamp",
"timestampFormat":"iso8601"
},
"TypeList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource to remove the tags from.</p>",
"location":"uri",
"locationName":"ResourceArn"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys associated with the tags to remove from the resource.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateActionTargetRequest":{
"type":"structure",
"required":["ActionTargetArn"],
"members":{
"ActionTargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the custom action target to update.</p>",
"location":"uri",
"locationName":"ActionTargetArn"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The updated name of the custom action target.</p>"
},
"Description":{
"shape":"NonEmptyString",
"documentation":"<p>The updated description for the custom action target.</p>"
}
}
},
"UpdateActionTargetResponse":{
"type":"structure",
"members":{
}
},
"UpdateFindingsRequest":{
"type":"structure",
"required":["Filters"],
"members":{
"Filters":{
"shape":"AwsSecurityFindingFilters",
"documentation":"<p>A collection of attributes that specify which findings you want to update.</p>"
},
"Note":{
"shape":"NoteUpdate",
"documentation":"<p>The updated note for the finding.</p>"
},
"RecordState":{
"shape":"RecordState",
"documentation":"<p>The updated record state for the finding.</p>"
}
}
},
"UpdateFindingsResponse":{
"type":"structure",
"members":{
}
},
"UpdateInsightRequest":{
"type":"structure",
"required":["InsightArn"],
"members":{
"InsightArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the insight that you want to update.</p>",
"location":"uri",
"locationName":"InsightArn"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The updated name for the insight.</p>"
},
"Filters":{
"shape":"AwsSecurityFindingFilters",
"documentation":"<p>The updated filters that define this insight.</p>"
},
"GroupByAttribute":{
"shape":"NonEmptyString",
"documentation":"<p>The updated <code>GroupBy</code> attribute that defines this insight.</p>"
}
}
},
"UpdateInsightResponse":{
"type":"structure",
"members":{
}
},
"UpdateOrganizationConfigurationRequest":{
"type":"structure",
"required":["AutoEnable"],
"members":{
"AutoEnable":{
"shape":"Boolean",
"documentation":"<p>Whether to automatically enable Security Hub for new accounts in the organization.</p> <p>By default, this is <code>false</code>, and new accounts are not added automatically.</p> <p>To automatically enable Security Hub for new accounts, set this to <code>true</code>.</p>"
}
}
},
"UpdateOrganizationConfigurationResponse":{
"type":"structure",
"members":{
}
},
"UpdateSecurityHubConfigurationRequest":{
"type":"structure",
"members":{
"AutoEnableControls":{
"shape":"Boolean",
"documentation":"<p>Whether to automatically enable new controls when they are added to standards that are enabled.</p> <p>By default, this is set to <code>true</code>, and new controls are enabled automatically. To not automatically enable new controls, set this to <code>false</code>. </p>"
}
}
},
"UpdateSecurityHubConfigurationResponse":{
"type":"structure",
"members":{
}
},
"UpdateStandardsControlRequest":{
"type":"structure",
"required":["StandardsControlArn"],
"members":{
"StandardsControlArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the security standard control to enable or disable.</p>",
"location":"uri",
"locationName":"StandardsControlArn"
},
"ControlStatus":{
"shape":"ControlStatus",
"documentation":"<p>The updated status of the security standard control.</p>"
},
"DisabledReason":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.</p>"
}
}
},
"UpdateStandardsControlResponse":{
"type":"structure",
"members":{
}
},
"VerificationState":{
"type":"string",
"enum":[
"UNKNOWN",
"TRUE_POSITIVE",
"FALSE_POSITIVE",
"BENIGN_POSITIVE"
]
},
"Vulnerability":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the vulnerability.</p>"
},
"VulnerablePackages":{
"shape":"SoftwarePackageList",
"documentation":"<p>List of software packages that have the vulnerability.</p>"
},
"Cvss":{
"shape":"CvssList",
"documentation":"<p>CVSS scores from the advisory related to the vulnerability.</p>"
},
"RelatedVulnerabilities":{
"shape":"StringList",
"documentation":"<p>List of vulnerabilities that are related to this vulnerability.</p>"
},
"Vendor":{
"shape":"VulnerabilityVendor",
"documentation":"<p>Information about the vendor that generates the vulnerability report.</p>"
},
"ReferenceUrls":{
"shape":"StringList",
"documentation":"<p>A list of URLs that provide additional information about the vulnerability.</p>"
}
},
"documentation":"<p>A vulnerability associated with a finding.</p>"
},
"VulnerabilityList":{
"type":"list",
"member":{"shape":"Vulnerability"}
},
"VulnerabilityVendor":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the vendor.</p>"
},
"Url":{
"shape":"NonEmptyString",
"documentation":"<p>The URL of the vulnerability advisory.</p>"
},
"VendorSeverity":{
"shape":"NonEmptyString",
"documentation":"<p>The severity that the vendor assigned to the vulnerability.</p>"
},
"VendorCreatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the vulnerability advisory was created.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
},
"VendorUpdatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates when the vulnerability advisory was last updated.</p> <p>Uses the <code>date-time</code> format specified in <a href=\"https://tools.ietf.org/html/rfc3339#section-5.6\">RFC 3339 section 5.6, Internet Date/Time Format</a>. The value cannot contain spaces. For example, <code>2020-03-22T13:22:13.933Z</code>.</p>"
}
},
"documentation":"<p>A vendor that generates a vulnerability report.</p>"
},
"WafAction":{
"type":"structure",
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies how you want AWS WAF to respond to requests that match the settings in a rule.</p> <p>Valid settings include the following:</p> <ul> <li> <p> <code>ALLOW</code> - AWS WAF allows requests</p> </li> <li> <p> <code>BLOCK</code> - AWS WAF blocks requests</p> </li> <li> <p> <code>COUNT</code> - AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a WebACL.</p> </li> </ul>"
}
},
"documentation":"<p>Details about the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule. </p>"
},
"WafExcludedRule":{
"type":"structure",
"members":{
"RuleId":{
"shape":"NonEmptyString",
"documentation":"<p>The unique identifier for the rule to exclude from the rule group.</p>"
}
},
"documentation":"<p>Details about a rule to exclude from a rule group.</p>"
},
"WafExcludedRuleList":{
"type":"list",
"member":{"shape":"WafExcludedRule"}
},
"WafOverrideAction":{
"type":"structure",
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p> <code>COUNT</code> overrides the action specified by the individual rule within a <code>RuleGroup</code> .</p> <p>If set to <code>NONE</code>, the rule's action takes place.</p>"
}
},
"documentation":"<p>Details about an override action for a rule.</p>"
},
"Workflow":{
"type":"structure",
"members":{
"Status":{
"shape":"WorkflowStatus",
"documentation":"<p>The status of the investigation into the finding. The allowed values are the following.</p> <ul> <li> <p> <code>NEW</code> - The initial state of a finding, before it is reviewed.</p> <p>Security Hub also resets the workflow status from <code>NOTIFIED</code> or <code>RESOLVED</code> to <code>NEW</code> in the following cases:</p> <ul> <li> <p> <code>RecordState</code> changes from <code>ARCHIVED</code> to <code>ACTIVE</code>.</p> </li> <li> <p> <code>ComplianceStatus</code> changes from <code>PASSED</code> to either <code>WARNING</code>, <code>FAILED</code>, or <code>NOT_AVAILABLE</code>.</p> </li> </ul> </li> <li> <p> <code>NOTIFIED</code> - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.</p> </li> <li> <p> <code>SUPPRESSED</code> - The finding will not be reviewed again and will not be acted upon.</p> </li> <li> <p> <code>RESOLVED</code> - The finding was reviewed and remediated and is now considered resolved. </p> </li> </ul>"
}
},
"documentation":"<p>Provides information about the status of the investigation into a finding.</p>"
},
"WorkflowState":{
"type":"string",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use Workflow.Status instead.",
"enum":[
"NEW",
"ASSIGNED",
"IN_PROGRESS",
"DEFERRED",
"RESOLVED"
]
},
"WorkflowStatus":{
"type":"string",
"enum":[
"NEW",
"NOTIFIED",
"RESOLVED",
"SUPPRESSED"
]
},
"WorkflowUpdate":{
"type":"structure",
"members":{
"Status":{
"shape":"WorkflowStatus",
"documentation":"<p>The status of the investigation into the finding. The allowed values are the following.</p> <ul> <li> <p> <code>NEW</code> - The initial state of a finding, before it is reviewed.</p> <p>Security Hub also resets <code>WorkFlowStatus</code> from <code>NOTIFIED</code> or <code>RESOLVED</code> to <code>NEW</code> in the following cases:</p> <ul> <li> <p>The record state changes from <code>ARCHIVED</code> to <code>ACTIVE</code>.</p> </li> <li> <p>The compliance status changes from <code>PASSED</code> to either <code>WARNING</code>, <code>FAILED</code>, or <code>NOT_AVAILABLE</code>.</p> </li> </ul> </li> <li> <p> <code>NOTIFIED</code> - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.</p> </li> <li> <p> <code>RESOLVED</code> - The finding was reviewed and remediated and is now considered resolved.</p> </li> <li> <p> <code>SUPPRESSED</code> - The finding will not be reviewed again and will not be acted upon.</p> </li> </ul>"
}
},
"documentation":"<p>Used to update information about the investigation into the finding.</p>"
}
},
"documentation":"<p>Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the <i> <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html\">AWS Security Hub User Guide</a> </i>.</p> <p>When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to.</p> <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code> <a>CreateMembers</a> </code> to add a member account to Security Hub, the association of the member account with the master account is created only in the <code>us-west-2</code> Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.</p> <p>The following throttling limits apply to using Security Hub API operations.</p> <ul> <li> <p> <code> <a>BatchEnableStandards</a> </code> - <code>RateLimit</code> of 1 request per second, <code>BurstLimit</code> of 1 request per second.</p> </li> <li> <p> <code> <a>GetFindings</a> </code> - <code>RateLimit</code> of 3 requests per second. <code>BurstLimit</code> of 6 requests per second.</p> </li> <li> <p> <code> <a>UpdateFindings</a> </code> - <code>RateLimit</code> of 1 request per second. <code>BurstLimit</code> of 5 requests per second.</p> </li> <li> <p> <code> <a>UpdateStandardsControl</a> </code> - <code>RateLimit</code> of 1 request per second, <code>BurstLimit</code> of 5 requests per second.</p> </li> <li> <p>All other operations - <code>RateLimit</code> of 10 requests per second. <code>BurstLimit</code> of 30 requests per second.</p> </li> </ul>"
}
Reference in a new issue View git blame Copy permalink