Updates the device status as an administrator.
Calling this action requires developer credentials.
", "AdminUpdateUserAttributes": "Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
", "AdminUserGlobalSignOut": "Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
Calling this action requires developer credentials.
", - "AssociateSoftwareToken": "Begins setup of time-based one-time password multi-factor authentication (TOTP MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.
Changes the password for a specified user in a user pool.
", "ConfirmDevice": "Confirms tracking of the device. This API call is the call that begins device tracking.
", "ConfirmForgotPassword": "Allows a user to enter a confirmation code to reset a forgotten password.
", @@ -635,8 +635,8 @@ "AnalyticsConfigurationType$UserDataShared": "If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
Indicates whether the user confirmation must confirm the device response.
", "CreateUserPoolClientRequest$AllowedOAuthFlowsUserPoolClient": "Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
", - "DeviceConfigurationType$ChallengeRequiredOnNewDevice": "When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Users that sign in with devices that have not been confirmed or remembered will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice is true, when your user pool requires MFA.
When true, users can opt in to remembering their device. Your app code must use callback functions to return the user's choice.
", + "DeviceConfigurationType$ChallengeRequiredOnNewDevice": "When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.
When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.
", "PasswordPolicyType$RequireUppercase": "In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
", "PasswordPolicyType$RequireLowercase": "In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
", "PasswordPolicyType$RequireNumbers": "In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
", @@ -905,7 +905,7 @@ "ConfirmationCodeType": { "base": null, "refs": { - "ConfirmForgotPasswordRequest$ConfirmationCode": "The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.
", + "ConfirmForgotPasswordRequest$ConfirmationCode": "The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
", "ConfirmSignUpRequest$ConfirmationCode": "The confirmation code sent by a user's request to confirm registration.
", "VerifyUserAttributeRequest$Code": "The verification code in the request to verify user attributes.
" } @@ -1212,11 +1212,11 @@ } }, "DeviceConfigurationType": { - "base": "The device tracking configuration for a user pool. A user pool with device tracking deactivated returns a null value.
When you provide values for any DeviceConfiguration field, you activate device tracking.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device configuration.
", - "UpdateUserPoolRequest$DeviceConfiguration": "Device configuration.
", - "UserPoolType$DeviceConfiguration": "The device configuration.
" + "CreateUserPoolRequest$DeviceConfiguration": "The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
", + "CreateUserPoolRequest$EmailVerificationMessage": "A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
", "UpdateUserPoolRequest$EmailVerificationMessage": "The contents of the email verification message.
", "UserPoolType$EmailVerificationMessage": "The contents of the email verification message.
", @@ -1362,7 +1362,7 @@ "EmailVerificationSubjectType": { "base": null, "refs": { - "CreateUserPoolRequest$EmailVerificationSubject": "A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
", + "CreateUserPoolRequest$EmailVerificationSubject": "A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
", "UpdateUserPoolRequest$EmailVerificationSubject": "The subject of the email verification message.
", "UserPoolType$EmailVerificationSubject": "The subject of the email verification message.
", @@ -1431,7 +1431,7 @@ "ExplicitAuthFlowsListType": { "base": null, "refs": { - "CreateUserPoolClientRequest$ExplicitAuthFlows": "The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix.
Values with ALLOW_ prefix must be used only along with the ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
If you don't specify a value for ExplicitAuthFlows, your app client activates the ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix.
Values with ALLOW_ prefix must be used only along with the ALLOW_ prefix.
Valid values include:
Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
Enable Lambda trigger based authentication.
Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
Enable SRP-based authentication.
Enable the authflow that refreshes tokens.
If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH.
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values with the ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
The authentication event feedback value.
" } }, + "ForbiddenException": { + "base": "This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
", + "refs": { + } + }, "ForceAliasCreation": { "base": null, "refs": { @@ -1928,13 +1933,14 @@ "MessageType": { "base": null, "refs": { - "AliasExistsException$message": "The message sent to the user when an alias exists.
", + "AliasExistsException$message": "The message that Amazon Cognito sends to the user when the value of an alias attribute is already linked to another user profile.
", "CodeDeliveryFailureException$message": "The message sent when a verification code fails to deliver successfully.
", "CodeMismatchException$message": "The message provided when the code mismatch exception is thrown.
", "ConcurrentModificationException$message": "The message provided when the concurrent exception is thrown.
", "DuplicateProviderException$message": null, "EnableSoftwareTokenMFAException$message": null, "ExpiredCodeException$message": "The message returned when the expired code exception is thrown.
", + "ForbiddenException$message": "The message returned when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
", "GroupExistsException$message": null, "InternalErrorException$message": "The message returned when Amazon Cognito throws an internal error exception.
", "InvalidEmailRoleAccessPolicyException$message": "The message returned when you have an unverified email address or the identity policy isn't set on an email address that Amazon Cognito can access.
", @@ -2067,7 +2073,7 @@ "AdminSetUserPasswordRequest$Password": "The password for the user.
", "ChangePasswordRequest$PreviousPassword": "The old password.
", "ChangePasswordRequest$ProposedPassword": "The new password.
", - "ConfirmForgotPasswordRequest$Password": "The password sent by a user's request to retrieve a forgotten password.
", + "ConfirmForgotPasswordRequest$Password": "The new password that your user wants to set.
", "SignUpRequest$Password": "The password of the user you want to register.
" } }, @@ -2409,7 +2415,7 @@ "SecretCodeType": { "base": null, "refs": { - "AssociateSoftwareTokenResponse$SecretCode": "A unique generated shared secret code that is used in the time-based one-time password (TOTP) algorithm to generate a one-time code.
" + "AssociateSoftwareTokenResponse$SecretCode": "A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.
" } }, "SecretHashType": { @@ -2515,7 +2521,7 @@ "SmsMfaConfigType": { "base": "The SMS text message multi-factor authentication (MFA) configuration type.
", "refs": { - "GetUserPoolMfaConfigResponse$SmsMfaConfiguration": "The SMS text message multi-factor (MFA) configuration.
", + "GetUserPoolMfaConfigResponse$SmsMfaConfiguration": "The SMS text message multi-factor authentication (MFA) configuration.
", "SetUserPoolMfaConfigRequest$SmsMfaConfiguration": "The SMS text message MFA configuration.
", "SetUserPoolMfaConfigResponse$SmsMfaConfiguration": "The SMS text message MFA configuration.
" } @@ -2548,7 +2554,7 @@ "SoftwareTokenMfaConfigType": { "base": "The type used for enabling software token MFA at the user pool level.
", "refs": { - "GetUserPoolMfaConfigResponse$SoftwareTokenMfaConfiguration": "The software token multi-factor (MFA) configuration.
", + "GetUserPoolMfaConfigResponse$SoftwareTokenMfaConfiguration": "The software token multi-factor authentication (MFA) configuration.
", "SetUserPoolMfaConfigRequest$SoftwareTokenMfaConfiguration": "The software token MFA configuration.
", "SetUserPoolMfaConfigResponse$SoftwareTokenMfaConfiguration": "The software token MFA configuration.
" } @@ -2557,7 +2563,7 @@ "base": "The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
", "refs": { "AdminSetUserMFAPreferenceRequest$SoftwareTokenMfaSettings": "The time-based one-time password software token MFA settings.
", - "SetUserMFAPreferenceRequest$SoftwareTokenMfaSettings": "The time-based one-time password software token MFA settings.
" + "SetUserMFAPreferenceRequest$SoftwareTokenMfaSettings": "The time-based one-time password (TOTP) software token MFA settings.
" } }, "StartUserImportJobRequest": { @@ -2658,9 +2664,9 @@ "SupportedIdentityProvidersListType": { "base": null, "refs": { - "CreateUserPoolClientRequest$SupportedIdentityProviders": "A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.
A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.
A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
Specifies MFA configuration details.
", - "GetUserPoolMfaConfigResponse$MfaConfiguration": "The multi-factor (MFA) configuration. Valid values include:
OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
The multi-factor authentication (MFA) configuration. Valid values include:
OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
The MFA configuration. Valid values include:
OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
Possible values include:
OFF - MFA tokens aren't required and can't be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA \"ON\" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.
If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API. WAF also lets you control access to your content. Based on criteria that you specify, such as the IP addresses that requests originate from or the values of query strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AppSync GraphQL API responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.
This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and an overview of how to use WAF, see the WAF Developer Guide.
You can make calls using the endpoints listed in WAF endpoints and quotas.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
You can define a web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or web ACL calls.
The limits WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.
If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool. WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, the AppSync GraphQL API, or the Amazon Cognito user pool responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.
This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and an overview of how to use WAF, see the WAF Developer Guide.
You can make calls using the endpoints listed in WAF endpoints and quotas.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
You can define a web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or web ACL calls.
The limits WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
", + "AssociateWebACL": "Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
", "CheckCapacity": "Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
", "CreateIPSet": "Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.
", "CreateRegexPatternSet": "Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
", "CreateRuleGroup": "Creates a RuleGroup per the specifications provided.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
", - "CreateWebACL": "Creates a WebACL per the specifications provided.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
", + "CreateWebACL": "Creates a WebACL per the specifications provided.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.
", "DeleteFirewallManagerRuleGroups": "Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
Deletes the specified IPSet.
", "DeleteLoggingConfiguration": "Deletes the LoggingConfiguration from the specified web ACL.
", @@ -16,7 +16,7 @@ "DeleteRuleGroup": "Deletes the specified RuleGroup.
", "DeleteWebACL": "Deletes the specified WebACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
Before deleting any web ACL, first disassociate it from all resources.
To retrieve a list of the resources that are associated with a web ACL, use the following calls:
For regional resources, call ListResourcesForWebACL.
For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId.
To disassociate a resource from a web ACL, use the following calls:
For regional resources, call DisassociateWebACL.
For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.
Provides high-level information for a managed rule group, including descriptions of the rules.
", - "DisassociateWebACL": "Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.
Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.
Generates a presigned download URL for the specified release of the mobile SDK.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
", "GetIPSet": "Retrieves the specified IPSet.
", "GetLoggingConfiguration": "Returns the LoggingConfiguration for the specified web ACL.
", @@ -49,7 +49,7 @@ "UpdateManagedRuleSetVersionExpiryDate": "Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Updates the specified RegexPatternSet.
This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
", "UpdateRuleGroup": "Updates the specified RuleGroup.
This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
", - "UpdateWebACL": "Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
" + "UpdateWebACL": "Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.
" }, "shapes": { "Action": { @@ -1232,7 +1232,7 @@ } }, "ManagedRuleGroupConfig": { - "base": "Additional information that's used by a managed rule group. Most managed rule groups don't require this.
Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
Additional information that's used by a managed rule group. Most managed rule groups don't require this.
Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField. The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath, PasswordField, PayloadType and UsernameField.
For example specifications, see the examples section of CreateWebACL.
", "refs": { "ManagedRuleGroupConfigs$member": null } @@ -1602,17 +1602,17 @@ "base": null, "refs": { "AssociateWebACLRequest$WebACLArn": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
", - "AssociateWebACLRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
The ARN must be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId
The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
The ARN must be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id
The Amazon Resource Name (ARN) of the web ACL.
", "DeleteLoggingConfigurationRequest$ResourceArn": "The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
", "DeletePermissionPolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.
You must be the owner of the rule group to perform this operation.
", "DescribeManagedRuleGroupResponse$SnsTopicArn": "The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
", - "DisassociateWebACLRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
The ARN must be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId
The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
The ARN must be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id
The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
", "GetPermissionPolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.
", "GetRuleGroupRequest$ARN": "The Amazon Resource Name (ARN) of the entity.
", "GetSampledRequestsRequest$WebAclArn": "The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.
The ARN (Amazon Resource Name) of the resource.
", + "GetWebACLForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
The ARN must be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId
For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id
The Amazon Resource Name (ARN) of the entity.
", "IPSetReferenceStatement$ARN": "The Amazon Resource Name (ARN) of the IPSet that this statement references.
", "IPSetSummary$ARN": "The Amazon Resource Name (ARN) of the entity.
", @@ -1648,7 +1648,7 @@ "ResourceType": { "base": null, "refs": { - "ListResourcesForWebACLRequest$ResourceType": "Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
" + "ListResourcesForWebACLRequest$ResourceType": "Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
" } }, "ResponseCode": { @@ -1767,37 +1767,37 @@ "Scope": { "base": null, "refs": { - "CheckCapacityRequest$Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.
", + "base": "The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.
For example specifications, see the examples section of CreateWebACL.
", "refs": { "ManagedRuleGroupStatement$ScopeDownStatement": "An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
", "NotStatement$Statement": "The statement to negate. You can use any statement that can be nested.
", @@ -2122,7 +2122,7 @@ } }, "WAFAssociatedItemException": { - "base": "WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
For DeleteWebACL, you will only get this exception if the web ACL is still associated with a regional resource. Deleting a web ACL that is still associated with an Amazon CloudFront distribution won't get this exception.
WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
", "refs": { } }, @@ -2212,7 +2212,7 @@ } }, "WebACL": { - "base": "A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
", + "base": "A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.
", "refs": { "GetWebACLForResourceResponse$WebACL": "The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.
", "GetWebACLResponse$WebACL": "The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.
" diff --git a/service/cognitoidentityprovider/api.go b/service/cognitoidentityprovider/api.go index af2a6501f85..0a0fb6c13cd 100644 --- a/service/cognitoidentityprovider/api.go +++ b/service/cognitoidentityprovider/api.go @@ -3292,8 +3292,8 @@ func (c *CognitoIdentityProvider) AssociateSoftwareTokenRequest(input *Associate // AssociateSoftwareToken API operation for Amazon Cognito Identity Provider. // -// Begins setup of time-based one-time password multi-factor authentication -// (TOTP MFA) for a user, with a unique private key that Amazon Cognito generates +// Begins setup of time-based one-time password (TOTP) multi-factor authentication +// (MFA) for a user, with a unique private key that Amazon Cognito generates // and returns in the API response. You can authorize an AssociateSoftwareToken // request with either the user's access token, or a session string from a challenge // response that you received from Amazon Cognito. @@ -3339,6 +3339,10 @@ func (c *CognitoIdentityProvider) AssociateSoftwareTokenRequest(input *Associate // This exception is thrown when the software token time-based one-time password // (TOTP) multi-factor authentication (MFA) isn't activated for the user pool. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AssociateSoftwareToken func (c *CognitoIdentityProvider) AssociateSoftwareToken(input *AssociateSoftwareTokenInput) (*AssociateSoftwareTokenOutput, error) { req, out := c.AssociateSoftwareTokenRequest(input) @@ -3451,6 +3455,10 @@ func (c *CognitoIdentityProvider) ChangePasswordRequest(input *ChangePasswordInp // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ChangePassword func (c *CognitoIdentityProvider) ChangePassword(input *ChangePasswordInput) (*ChangePasswordOutput, error) { req, out := c.ChangePasswordRequest(input) @@ -3569,6 +3577,10 @@ func (c *CognitoIdentityProvider) ConfirmDeviceRequest(input *ConfirmDeviceInput // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmDevice func (c *CognitoIdentityProvider) ConfirmDevice(input *ConfirmDeviceInput) (*ConfirmDeviceOutput, error) { req, out := c.ConfirmDeviceRequest(input) @@ -3701,6 +3713,10 @@ func (c *CognitoIdentityProvider) ConfirmForgotPasswordRequest(input *ConfirmFor // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmForgotPassword func (c *CognitoIdentityProvider) ConfirmForgotPassword(input *ConfirmForgotPasswordInput) (*ConfirmForgotPasswordOutput, error) { req, out := c.ConfirmForgotPasswordRequest(input) @@ -3834,6 +3850,10 @@ func (c *CognitoIdentityProvider) ConfirmSignUpRequest(input *ConfirmSignUpInput // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmSignUp func (c *CognitoIdentityProvider) ConfirmSignUp(input *ConfirmSignUpInput) (*ConfirmSignUpOutput, error) { req, out := c.ConfirmSignUpRequest(input) @@ -4965,6 +4985,10 @@ func (c *CognitoIdentityProvider) DeleteUserRequest(input *DeleteUserInput) (req // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUser func (c *CognitoIdentityProvider) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error) { req, out := c.DeleteUserRequest(input) @@ -5070,6 +5094,10 @@ func (c *CognitoIdentityProvider) DeleteUserAttributesRequest(input *DeleteUserA // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserAttributes func (c *CognitoIdentityProvider) DeleteUserAttributes(input *DeleteUserAttributesInput) (*DeleteUserAttributesOutput, error) { req, out := c.DeleteUserAttributesRequest(input) @@ -6124,6 +6152,10 @@ func (c *CognitoIdentityProvider) ForgetDeviceRequest(input *ForgetDeviceInput) // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgetDevice func (c *CognitoIdentityProvider) ForgetDevice(input *ForgetDeviceInput) (*ForgetDeviceOutput, error) { req, out := c.ForgetDeviceRequest(input) @@ -6281,6 +6313,10 @@ func (c *CognitoIdentityProvider) ForgotPasswordRequest(input *ForgotPasswordInp // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgotPassword func (c *CognitoIdentityProvider) ForgotPassword(input *ForgotPasswordInput) (*ForgotPasswordOutput, error) { req, out := c.ForgotPasswordRequest(input) @@ -6482,6 +6518,10 @@ func (c *CognitoIdentityProvider) GetDeviceRequest(input *GetDeviceInput) (req * // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetDevice func (c *CognitoIdentityProvider) GetDevice(input *GetDeviceInput) (*GetDeviceOutput, error) { req, out := c.GetDeviceRequest(input) @@ -6961,6 +7001,10 @@ func (c *CognitoIdentityProvider) GetUserRequest(input *GetUserInput) (req *requ // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUser func (c *CognitoIdentityProvider) GetUser(input *GetUserInput) (*GetUserOutput, error) { req, out := c.GetUserRequest(input) @@ -7118,6 +7162,10 @@ func (c *CognitoIdentityProvider) GetUserAttributeVerificationCodeRequest(input // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAttributeVerificationCode func (c *CognitoIdentityProvider) GetUserAttributeVerificationCode(input *GetUserAttributeVerificationCodeInput) (*GetUserAttributeVerificationCodeOutput, error) { req, out := c.GetUserAttributeVerificationCodeRequest(input) @@ -7318,6 +7366,10 @@ func (c *CognitoIdentityProvider) GlobalSignOutRequest(input *GlobalSignOutInput // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GlobalSignOut func (c *CognitoIdentityProvider) GlobalSignOut(input *GlobalSignOutInput) (*GlobalSignOutOutput, error) { req, out := c.GlobalSignOutRequest(input) @@ -7467,6 +7519,10 @@ func (c *CognitoIdentityProvider) InitiateAuthRequest(input *InitiateAuthInput) // or the external ID provided in the role does not match what is provided in // the SMS configuration for the user pool. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuth func (c *CognitoIdentityProvider) InitiateAuth(input *InitiateAuthInput) (*InitiateAuthOutput, error) { req, out := c.InitiateAuthRequest(input) @@ -7574,6 +7630,10 @@ func (c *CognitoIdentityProvider) ListDevicesRequest(input *ListDevicesInput) (r // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListDevices func (c *CognitoIdentityProvider) ListDevices(input *ListDevicesInput) (*ListDevicesOutput, error) { req, out := c.ListDevicesRequest(input) @@ -8982,6 +9042,10 @@ func (c *CognitoIdentityProvider) ResendConfirmationCodeRequest(input *ResendCon // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResendConfirmationCode func (c *CognitoIdentityProvider) ResendConfirmationCode(input *ResendConfirmationCodeInput) (*ResendConfirmationCodeOutput, error) { req, out := c.ResendConfirmationCodeRequest(input) @@ -9154,6 +9218,10 @@ func (c *CognitoIdentityProvider) RespondToAuthChallengeRequest(input *RespondTo // This exception is thrown when the software token time-based one-time password // (TOTP) multi-factor authentication (MFA) isn't activated for the user pool. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RespondToAuthChallenge func (c *CognitoIdentityProvider) RespondToAuthChallenge(input *RespondToAuthChallengeInput) (*RespondToAuthChallengeOutput, error) { req, out := c.RespondToAuthChallengeRequest(input) @@ -9255,6 +9323,10 @@ func (c *CognitoIdentityProvider) RevokeTokenRequest(input *RevokeTokenInput) (r // * UnsupportedTokenTypeException // Exception that is thrown when an unsupported token is passed to an operation. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RevokeToken func (c *CognitoIdentityProvider) RevokeToken(input *RevokeTokenInput) (*RevokeTokenOutput, error) { req, out := c.RevokeTokenRequest(input) @@ -9577,6 +9649,10 @@ func (c *CognitoIdentityProvider) SetUserMFAPreferenceRequest(input *SetUserMFAP // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserMFAPreference func (c *CognitoIdentityProvider) SetUserMFAPreference(input *SetUserMFAPreferenceInput) (*SetUserMFAPreferenceOutput, error) { req, out := c.SetUserMFAPreferenceRequest(input) @@ -9803,6 +9879,10 @@ func (c *CognitoIdentityProvider) SetUserSettingsRequest(input *SetUserSettingsI // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserSettings func (c *CognitoIdentityProvider) SetUserSettings(input *SetUserSettingsInput) (*SetUserSettingsOutput, error) { req, out := c.SetUserSettingsRequest(input) @@ -9953,6 +10033,10 @@ func (c *CognitoIdentityProvider) SignUpRequest(input *SignUpInput) (req *reques // * CodeDeliveryFailureException // This exception is thrown when a verification code fails to deliver successfully. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SignUp func (c *CognitoIdentityProvider) SignUp(input *SignUpInput) (*SignUpOutput, error) { req, out := c.SignUpRequest(input) @@ -10565,6 +10649,10 @@ func (c *CognitoIdentityProvider) UpdateDeviceStatusRequest(input *UpdateDeviceS // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateDeviceStatus func (c *CognitoIdentityProvider) UpdateDeviceStatus(input *UpdateDeviceStatusInput) (*UpdateDeviceStatusOutput, error) { req, out := c.UpdateDeviceStatusRequest(input) @@ -11019,6 +11107,10 @@ func (c *CognitoIdentityProvider) UpdateUserAttributesRequest(input *UpdateUserA // * InternalErrorException // This exception is thrown when Amazon Cognito encounters an internal error. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserAttributes func (c *CognitoIdentityProvider) UpdateUserAttributes(input *UpdateUserAttributesInput) (*UpdateUserAttributesOutput, error) { req, out := c.UpdateUserAttributesRequest(input) @@ -11515,6 +11607,10 @@ func (c *CognitoIdentityProvider) VerifySoftwareTokenRequest(input *VerifySoftwa // This exception is thrown if the provided code doesn't match what the server // was expecting. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifySoftwareToken func (c *CognitoIdentityProvider) VerifySoftwareToken(input *VerifySoftwareTokenInput) (*VerifySoftwareTokenOutput, error) { req, out := c.VerifySoftwareTokenRequest(input) @@ -11643,6 +11739,10 @@ func (c *CognitoIdentityProvider) VerifyUserAttributeRequest(input *VerifyUserAt // this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // +// * ForbiddenException +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifyUserAttribute func (c *CognitoIdentityProvider) VerifyUserAttribute(input *VerifyUserAttributeInput) (*VerifyUserAttributeOutput, error) { req, out := c.VerifyUserAttributeRequest(input) @@ -15834,7 +15934,8 @@ type AliasExistsException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // The message sent to the user when an alias exists. + // The message that Amazon Cognito sends to the user when the value of an alias + // attribute is already linked to another user profile. Message_ *string `locationName:"message" type:"string"` } @@ -16090,8 +16191,8 @@ func (s *AssociateSoftwareTokenInput) SetSession(v string) *AssociateSoftwareTok type AssociateSoftwareTokenOutput struct { _ struct{} `type:"structure"` - // A unique generated shared secret code that is used in the time-based one-time - // password (TOTP) algorithm to generate a one-time code. + // A unique generated shared secret code that is used in the TOTP algorithm + // to generate a one-time code. // // SecretCode is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AssociateSoftwareTokenOutput's @@ -17063,13 +17164,13 @@ type ConfirmForgotPasswordInput struct { // sensitive information. ClientMetadata map[string]*string `type:"map"` - // The confirmation code sent by a user's request to retrieve a forgotten password. - // For more information, see ForgotPassword (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html). + // The confirmation code from your user's request to reset their password. For + // more information, see ForgotPassword (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html). // // ConfirmationCode is a required field ConfirmationCode *string `min:"1" type:"string" required:"true"` - // The password sent by a user's request to retrieve a forgotten password. + // The new password that your user wants to set. // // Password is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ConfirmForgotPasswordInput's @@ -18205,24 +18306,32 @@ type CreateUserPoolClientInput struct { // // Valid values include: // - // * ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - // flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - // setting. With this authentication flow, Amazon Cognito receives the password - // in the request instead of using the Secure Remote Password (SRP) protocol - // to verify passwords. + // ALLOW_ADMIN_USER_PASSWORD_AUTH // - // * ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. + // Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. + // This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication + // flow, Amazon Cognito receives the password in the request instead of using + // the Secure Remote Password (SRP) protocol to verify passwords. // - // * ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. - // In this flow, Amazon Cognito receives the password in the request instead - // of using the SRP protocol to verify passwords. + // ALLOW_CUSTOM_AUTH // - // * ALLOW_USER_SRP_AUTH: Enable SRP-based authentication. + // Enable Lambda trigger based authentication. // - // * ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. + // ALLOW_USER_PASSWORD_AUTH + // + // Enable user password-based authentication. In this flow, Amazon Cognito receives + // the password in the request instead of using the SRP protocol to verify passwords. + // + // ALLOW_USER_SRP_AUTH // - // If you don't specify a value for ExplicitAuthFlows, your app client activates - // the ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows. + // Enable SRP-based authentication. + // + // ALLOW_REFRESH_TOKEN_AUTH + // + // Enable the authflow that refreshes tokens. + // + // If you don't specify a value for ExplicitAuthFlows, your user client supports + // ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH. ExplicitAuthFlows []*string `type:"list" enum:"ExplicitAuthFlowsType"` // Boolean to specify whether you want to generate a secret for the user pool @@ -18279,9 +18388,10 @@ type CreateUserPoolClientInput struct { // in seconds. RefreshTokenValidity *int64 `type:"integer"` - // A list of provider names for the IdPs that this client supports. The following - // are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of - // your own SAML and OIDC providers. + // A list of provider names for the identity providers (IdPs) that are supported + // on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, + // and LoginWithAmazon. You can also specify the names that you configured for + // the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP. SupportedIdentityProviders []*string `type:"list"` // The units in which the validity times are represented. The default unit for @@ -18662,7 +18772,11 @@ type CreateUserPoolInput struct { // The attributes to be auto-verified. Possible values: email, phone_number. AutoVerifiedAttributes []*string `type:"list" enum:"VerifiedAttributeType"` - // The device configuration. + // The device-remembering configuration for a user pool. A null value indicates + // that you have deactivated device remembering in your user pool. + // + // When you provide a value for any DeviceConfiguration field, you activate + // the Amazon Cognito device-remembering feature. DeviceConfiguration *DeviceConfigurationType `type:"structure"` // The email configuration of your user pool. The email configuration type sets @@ -18725,7 +18839,7 @@ type CreateUserPoolInput struct { // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells // Amazon Cognito how to handle changes to the value of your users' email address // and phone number attributes. For more information, see Verifying updates - // to to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). + // to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). UserAttributeUpdateSettings *UserAttributeUpdateSettingsType `type:"structure"` // Enables advanced security risk detection. Set the key AdvancedSecurityMode @@ -20556,24 +20670,28 @@ func (s *DescribeUserPoolOutput) SetUserPool(v *UserPoolType) *DescribeUserPoolO return s } -// The device tracking configuration for a user pool. A user pool with device -// tracking deactivated returns a null value. +// The device-remembering configuration for a user pool. A null value indicates +// that you have deactivated device remembering in your user pool. // -// When you provide values for any DeviceConfiguration field, you activate device -// tracking. +// When you provide a value for any DeviceConfiguration field, you activate +// the Amazon Cognito device-remembering feature. type DeviceConfigurationType struct { _ struct{} `type:"structure"` // When true, device authentication can replace SMS and time-based one-time // password (TOTP) factors for multi-factor authentication (MFA). // - // Users that sign in with devices that have not been confirmed or remembered - // will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice - // is true, when your user pool requires MFA. + // Regardless of the value of this field, users that sign in with new devices + // that have not been confirmed or remembered must provide a second factor if + // your user pool requires MFA. ChallengeRequiredOnNewDevice *bool `type:"boolean"` - // When true, users can opt in to remembering their device. Your app code must - // use callback functions to return the user's choice. + // When true, Amazon Cognito doesn't remember newly-confirmed devices. Users + // who want to authenticate with their device can instead opt in to remembering + // their device. To collect a choice from your user, create an input prompt + // in your app and return the value that the user chooses in an UpdateDeviceStatus + // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) + // API request. DeviceOnlyRememberedOnUserPrompt *bool `type:"boolean"` } @@ -21346,6 +21464,73 @@ func (s *ExpiredCodeException) RequestID() string { return s.RespMetadata.RequestID } +// This exception is thrown when WAF doesn't allow your request based on a web +// ACL that's associated with your user pool. +type ForbiddenException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + // The message returned when WAF doesn't allow your request based on a web ACL + // that's associated with your user pool. + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForbiddenException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForbiddenException) GoString() string { + return s.String() +} + +func newErrorForbiddenException(v protocol.ResponseMetadata) error { + return &ForbiddenException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ForbiddenException) Code() string { + return "ForbiddenException" +} + +// Message returns the exception's message. +func (s *ForbiddenException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ForbiddenException) OrigErr() error { + return nil +} + +func (s *ForbiddenException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ForbiddenException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ForbiddenException) RequestID() string { + return s.RespMetadata.RequestID +} + // Represents the request to forget the device. type ForgetDeviceInput struct { _ struct{} `type:"structure"` @@ -22512,7 +22697,7 @@ func (s *GetUserPoolMfaConfigInput) SetUserPoolId(v string) *GetUserPoolMfaConfi type GetUserPoolMfaConfigOutput struct { _ struct{} `type:"structure"` - // The multi-factor (MFA) configuration. Valid values include: + // The multi-factor authentication (MFA) configuration. Valid values include: // // * OFF MFA won't be used for any users. // @@ -22522,10 +22707,10 @@ type GetUserPoolMfaConfigOutput struct { // MFA factor activated. MfaConfiguration *string `type:"string" enum:"UserPoolMfaType"` - // The SMS text message multi-factor (MFA) configuration. + // The SMS text message multi-factor authentication (MFA) configuration. SmsMfaConfiguration *SmsMfaConfigType `type:"structure"` - // The software token multi-factor (MFA) configuration. + // The software token multi-factor authentication (MFA) configuration. SoftwareTokenMfaConfiguration *SoftwareTokenMfaConfigType `type:"structure"` } @@ -27650,7 +27835,7 @@ type SetUserMFAPreferenceInput struct { // The SMS text message multi-factor authentication (MFA) settings. SMSMfaSettings *SMSMfaSettingsType `type:"structure"` - // The time-based one-time password software token MFA settings. + // The time-based one-time password (TOTP) software token MFA settings. SoftwareTokenMfaSettings *SoftwareTokenMfaSettingsType `type:"structure"` } @@ -30604,8 +30789,8 @@ type UpdateUserPoolClientInput struct { RefreshTokenValidity *int64 `type:"integer"` // A list of provider names for the IdPs that this client supports. The following - // are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of - // your own SAML and OIDC providers. + // are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, + // and the names of your own SAML and OIDC providers. SupportedIdentityProviders []*string `type:"list"` // The units in which the validity times are represented. The default unit for @@ -30986,7 +31171,11 @@ type UpdateUserPoolInput struct { // to update user pools. AutoVerifiedAttributes []*string `type:"list" enum:"VerifiedAttributeType"` - // Device configuration. + // The device-remembering configuration for a user pool. A null value indicates + // that you have deactivated device remembering in your user pool. + // + // When you provide a value for any DeviceConfiguration field, you activate + // the Amazon Cognito device-remembering feature. DeviceConfiguration *DeviceConfigurationType `type:"structure"` // The email configuration of your user pool. The email configuration type sets @@ -31038,7 +31227,7 @@ type UpdateUserPoolInput struct { // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells // Amazon Cognito how to handle changes to the value of your users' email address // and phone number attributes. For more information, see Verifying updates - // to to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). + // to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). UserAttributeUpdateSettings *UserAttributeUpdateSettingsType `type:"structure"` // Enables advanced security risk detection. Set the key AdvancedSecurityMode @@ -31281,7 +31470,7 @@ func (s UpdateUserPoolOutput) GoString() string { // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells // Amazon Cognito how to handle changes to the value of your users' email address // and phone number attributes. For more information, see Verifying updates -// to to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). +// to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). type UserAttributeUpdateSettingsType struct { _ struct{} `type:"structure"` @@ -32174,8 +32363,8 @@ type UserPoolClientType struct { RefreshTokenValidity *int64 `type:"integer"` // A list of provider names for the IdPs that this client supports. The following - // are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of - // your own SAML and OIDC providers. + // are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, + // and the names of your own SAML and OIDC providers. SupportedIdentityProviders []*string `type:"list"` // The time units used to specify the token validity times of each token type: @@ -32575,7 +32764,11 @@ type UserPoolType struct { // Using Your Own Domain for the Hosted UI (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html). CustomDomain *string `min:"1" type:"string"` - // The device configuration. + // The device-remembering configuration for a user pool. A null value indicates + // that you have deactivated device remembering in your user pool. + // + // When you provide a value for any DeviceConfiguration field, you activate + // the Amazon Cognito device-remembering feature. DeviceConfiguration *DeviceConfigurationType `type:"structure"` // The domain prefix, if the user pool has a domain associated with it. @@ -32669,7 +32862,7 @@ type UserPoolType struct { // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells // Amazon Cognito how to handle changes to the value of your users' email address // and phone number attributes. For more information, see Verifying updates - // to to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). + // to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). UserAttributeUpdateSettings *UserAttributeUpdateSettingsType `type:"structure"` // The user pool add-ons. diff --git a/service/cognitoidentityprovider/errors.go b/service/cognitoidentityprovider/errors.go index cf7677a81f8..11a4c9ccbf8 100644 --- a/service/cognitoidentityprovider/errors.go +++ b/service/cognitoidentityprovider/errors.go @@ -57,6 +57,13 @@ const ( // This exception is thrown if a code has expired. ErrCodeExpiredCodeException = "ExpiredCodeException" + // ErrCodeForbiddenException for service response error code + // "ForbiddenException". + // + // This exception is thrown when WAF doesn't allow your request based on a web + // ACL that's associated with your user pool. + ErrCodeForbiddenException = "ForbiddenException" + // ErrCodeGroupExistsException for service response error code // "GroupExistsException". // @@ -284,6 +291,7 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "DuplicateProviderException": newErrorDuplicateProviderException, "EnableSoftwareTokenMFAException": newErrorEnableSoftwareTokenMFAException, "ExpiredCodeException": newErrorExpiredCodeException, + "ForbiddenException": newErrorForbiddenException, "GroupExistsException": newErrorGroupExistsException, "InternalErrorException": newErrorInternalErrorException, "InvalidEmailRoleAccessPolicyException": newErrorInvalidEmailRoleAccessPolicyException, diff --git a/service/wafv2/api.go b/service/wafv2/api.go index 5e7dc02d0e1..625ec85eb49 100644 --- a/service/wafv2/api.go +++ b/service/wafv2/api.go @@ -60,7 +60,8 @@ func (c *WAFV2) AssociateWebACLRequest(input *AssociateWebACLInput) (req *reques // // Associates a web ACL with a regional application resource, to protect the // resource. A regional application can be an Application Load Balancer (ALB), -// an Amazon API Gateway REST API, or an AppSync GraphQL API. +// an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito +// user pool. // // For Amazon CloudFront, don't use this call. Instead, use your CloudFront // distribution configuration. To associate a web ACL, in the CloudFront call @@ -250,6 +251,9 @@ func (c *WAFV2) CheckCapacityRequest(input *CheckCapacityInput) (req *request.Re // has expired. You can retrieve the available versions for the managed rule // group by calling ListAvailableManagedRuleGroupVersions. // +// * WAFInvalidOperationException +// The operation isn't valid. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CheckCapacity func (c *WAFV2) CheckCapacity(input *CheckCapacityInput) (*CheckCapacityOutput, error) { req, out := c.CheckCapacityRequest(input) @@ -708,7 +712,7 @@ func (c *WAFV2) CreateWebACLRequest(input *CreateWebACLInput) (req *request.Requ // RuleGroup, and managed rule group. You can associate a web ACL with one or // more Amazon Web Services resources to protect. The resources can be an Amazon // CloudFront distribution, an Amazon API Gateway REST API, an Application Load -// Balancer, or an AppSync GraphQL API. +// Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1010,10 +1014,6 @@ func (c *WAFV2) DeleteIPSetRequest(input *DeleteIPSetInput) (req *request.Reques // WAF couldn’t perform the operation because your resource is being used // by another resource or it’s associated with another resource. // -// For DeleteWebACL, you will only get this exception if the web ACL is still -// associated with a regional resource. Deleting a web ACL that is still associated -// with an Amazon CloudFront distribution won't get this exception. -// // * WAFTagOperationException // An error occurred during the tagging operation. Retry your request. // @@ -1340,10 +1340,6 @@ func (c *WAFV2) DeleteRegexPatternSetRequest(input *DeleteRegexPatternSetInput) // WAF couldn’t perform the operation because your resource is being used // by another resource or it’s associated with another resource. // -// For DeleteWebACL, you will only get this exception if the web ACL is still -// associated with a regional resource. Deleting a web ACL that is still associated -// with an Amazon CloudFront distribution won't get this exception. -// // * WAFTagOperationException // An error occurred during the tagging operation. Retry your request. // @@ -1462,10 +1458,6 @@ func (c *WAFV2) DeleteRuleGroupRequest(input *DeleteRuleGroupInput) (req *reques // WAF couldn’t perform the operation because your resource is being used // by another resource or it’s associated with another resource. // -// For DeleteWebACL, you will only get this exception if the web ACL is still -// associated with a regional resource. Deleting a web ACL that is still associated -// with an Amazon CloudFront distribution won't get this exception. -// // * WAFTagOperationException // An error occurred during the tagging operation. Retry your request. // @@ -1599,10 +1591,6 @@ func (c *WAFV2) DeleteWebACLRequest(input *DeleteWebACLInput) (req *request.Requ // WAF couldn’t perform the operation because your resource is being used // by another resource or it’s associated with another resource. // -// For DeleteWebACL, you will only get this exception if the web ACL is still -// associated with a regional resource. Deleting a web ACL that is still associated -// with an Amazon CloudFront distribution won't get this exception. -// // * WAFTagOperationException // An error occurred during the tagging operation. Retry your request. // @@ -1794,7 +1782,7 @@ func (c *WAFV2) DisassociateWebACLRequest(input *DisassociateWebACLInput) (req * // Disassociates the specified regional application resource from any existing // web ACL association. A resource can have at most one web ACL association. // A regional application can be an Application Load Balancer (ALB), an Amazon -// API Gateway REST API, or an AppSync GraphQL API. +// API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool. // // For Amazon CloudFront, don't use this call. Instead, use your CloudFront // distribution configuration. To disassociate a web ACL, provide an empty web @@ -5515,7 +5503,7 @@ func (c *WAFV2) UpdateWebACLRequest(input *UpdateWebACLInput) (req *request.Requ // RuleGroup, and managed rule group. You can associate a web ACL with one or // more Amazon Web Services resources to protect. The resources can be an Amazon // CloudFront distribution, an Amazon API Gateway REST API, an Application Load -// Balancer, or an AppSync GraphQL API. +// Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5841,6 +5829,8 @@ type AssociateWebACLInput struct { // // * For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId // + // * For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id + // // ResourceArn is a required field ResourceArn *string `min:"20" type:"string" required:"true"` @@ -6396,7 +6386,8 @@ type CheckCapacityInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -6853,7 +6844,8 @@ type CreateIPSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -7017,7 +7009,8 @@ type CreateRegexPatternSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -7216,7 +7209,8 @@ type CreateRuleGroupInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -7454,7 +7448,8 @@ type CreateWebACLInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -8180,7 +8175,8 @@ type DeleteIPSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -8463,7 +8459,8 @@ type DeleteRegexPatternSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -8602,7 +8599,8 @@ type DeleteRuleGroupInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -8741,7 +8739,8 @@ type DeleteWebACLInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -8861,7 +8860,8 @@ type DescribeManagedRuleGroupInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -9077,6 +9077,8 @@ type DisassociateWebACLInput struct { // // * For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId // + // * For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id + // // ResourceArn is a required field ResourceArn *string `min:"20" type:"string" required:"true"` } @@ -9904,7 +9906,8 @@ type GetIPSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -10133,7 +10136,8 @@ type GetManagedRuleSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -10446,7 +10450,8 @@ type GetRateBasedStatementManagedKeysInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -10611,7 +10616,8 @@ type GetRegexPatternSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -10753,7 +10759,8 @@ type GetRuleGroupInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -10896,7 +10903,8 @@ type GetSampledRequestsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -11073,7 +11081,18 @@ func (s *GetSampledRequestsOutput) SetTimeWindow(v *TimeWindow) *GetSampledReque type GetWebACLForResourceInput struct { _ struct{} `type:"structure"` - // The ARN (Amazon Resource Name) of the resource. + // The Amazon Resource Name (ARN) of the resource whose web ACL you want to + // retrieve. + // + // The ARN must be in one of the following formats: + // + // * For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id + // + // * For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + // + // * For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId + // + // * For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id // // ResourceArn is a required field ResourceArn *string `min:"20" type:"string" required:"true"` @@ -11169,7 +11188,8 @@ type GetWebACLInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -12541,7 +12561,8 @@ type ListAvailableManagedRuleGroupVersionsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -12709,7 +12730,8 @@ type ListAvailableManagedRuleGroupsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -12836,7 +12858,8 @@ type ListIPSetsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -12965,7 +12988,8 @@ type ListLoggingConfigurationsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -13092,7 +13116,8 @@ type ListManagedRuleSetsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -13338,7 +13363,8 @@ type ListRegexPatternSetsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -13454,7 +13480,7 @@ type ListResourcesForWebACLInput struct { // Used for web ACLs that are scoped for regional applications. A regional application // can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, - // or an AppSync GraphQL API. + // an AppSync GraphQL API, or an Amazon Cognito user pool. ResourceType *string `type:"string" enum:"ResourceType"` // The Amazon Resource Name (ARN) of the web ACL. @@ -13556,7 +13582,8 @@ type ListRuleGroupsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -13804,7 +13831,8 @@ type ListWebACLsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -14156,6 +14184,8 @@ func (s *LoggingFilter) SetFilters(v []*Filter) *LoggingFilter { // configuration that you provide depends on the needs of the managed rule group. // For the ATP managed rule group, you provide the following individual configuration // objects: LoginPath, PasswordField, PayloadType and UsernameField. +// +// For example specifications, see the examples section of CreateWebACL. type ManagedRuleGroupConfig struct { _ struct{} `type:"structure"` @@ -15374,7 +15404,8 @@ type PutManagedRuleSetVersionsInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -17463,6 +17494,8 @@ func (s *SqliMatchStatement) SetTextTransformations(v []*TextTransformation) *Sq // The processing guidance for a Rule, used by WAF to determine whether a web // request matches the rule. +// +// For example specifications, see the examples section of CreateWebACL. type Statement struct { _ struct{} `type:"structure"` @@ -18447,7 +18480,8 @@ type UpdateIPSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -18624,7 +18658,8 @@ type UpdateManagedRuleSetVersionExpiryDateInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -18831,7 +18866,8 @@ type UpdateRegexPatternSetInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -19031,7 +19067,8 @@ type UpdateRuleGroupInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -19276,7 +19313,8 @@ type UpdateWebACLInput struct { // Specifies whether this is for an Amazon CloudFront distribution or for a // regional application. A regional application can be an Application Load Balancer - // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. + // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon + // Cognito user pool. // // To work with CloudFront, you must also specify the Region US East (N. Virginia) // as follows: @@ -19715,10 +19753,6 @@ func (s *VisibilityConfig) SetSampledRequestsEnabled(v bool) *VisibilityConfig { // WAF couldn’t perform the operation because your resource is being used // by another resource or it’s associated with another resource. -// -// For DeleteWebACL, you will only get this exception if the web ACL is still -// associated with a regional resource. Deleting a web ACL that is still associated -// with an Amazon CloudFront distribution won't get this exception. type WAFAssociatedItemException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -20951,7 +20985,7 @@ func (s *WAFUnavailableEntityException) RequestID() string { // RuleGroup, and managed rule group. You can associate a web ACL with one or // more Amazon Web Services resources to protect. The resources can be an Amazon // CloudFront distribution, an Amazon API Gateway REST API, an Application Load -// Balancer, or an AppSync GraphQL API. +// Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool. type WebACL struct { _ struct{} `type:"structure"` @@ -22940,6 +22974,9 @@ const ( // ResourceTypeAppsync is a ResourceType enum value ResourceTypeAppsync = "APPSYNC" + + // ResourceTypeCognitoUserPool is a ResourceType enum value + ResourceTypeCognitoUserPool = "COGNITO_USER_POOL" ) // ResourceType_Values returns all elements of the ResourceType enum @@ -22948,6 +22985,7 @@ func ResourceType_Values() []string { ResourceTypeApplicationLoadBalancer, ResourceTypeApiGateway, ResourceTypeAppsync, + ResourceTypeCognitoUserPool, } } diff --git a/service/wafv2/doc.go b/service/wafv2/doc.go index e4e3d87b63d..cfe10015d6d 100644 --- a/service/wafv2/doc.go +++ b/service/wafv2/doc.go @@ -20,14 +20,14 @@ // // WAF is a web application firewall that lets you monitor the HTTP and HTTPS // requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST -// API, an Application Load Balancer, or an AppSync GraphQL API. WAF also lets -// you control access to your content. Based on criteria that you specify, such -// as the IP addresses that requests originate from or the values of query strings, -// the Amazon API Gateway REST API, CloudFront distribution, the Application -// Load Balancer, or the AppSync GraphQL API responds to requests either with -// the requested content or with an HTTP 403 status code (Forbidden). You also -// can configure CloudFront to return a custom error page when a request is -// blocked. +// API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito +// user pool. WAF also lets you control access to your content. Based on conditions +// that you specify, such as the IP addresses that requests originate from or +// the values of query strings, the Amazon API Gateway REST API, CloudFront +// distribution, the Application Load Balancer, the AppSync GraphQL API, or +// the Amazon Cognito user pool responds to requests either with the requested +// content or with an HTTP 403 status code (Forbidden). You also can configure +// CloudFront to return a custom error page when a request is blocked. // // This API guide is for developers who need detailed information about WAF // API actions, data types, and errors. For detailed information about WAF features @@ -38,7 +38,8 @@ // // * For regional applications, you can use any of the endpoints in the list. // A regional application can be an Application Load Balancer (ALB), an Amazon -// API Gateway REST API, or an AppSync GraphQL API. +// API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user +// pool. // // * For Amazon CloudFront applications, you must use the API endpoint listed // for US East (N. Virginia): us-east-1. diff --git a/service/wafv2/errors.go b/service/wafv2/errors.go index d7e5738df88..e681843fb6f 100644 --- a/service/wafv2/errors.go +++ b/service/wafv2/errors.go @@ -13,10 +13,6 @@ const ( // // WAF couldn’t perform the operation because your resource is being used // by another resource or it’s associated with another resource. - // - // For DeleteWebACL, you will only get this exception if the web ACL is still - // associated with a regional resource. Deleting a web ACL that is still associated - // with an Amazon CloudFront distribution won't get this exception. ErrCodeWAFAssociatedItemException = "WAFAssociatedItemException" // ErrCodeWAFConfigurationWarningException for service response error code