| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.WAF.UpdateGeoMatchSet
Description
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For
each GeoMatchConstraint object, you specify the following values:
- Whether to insert or delete the object from the array. If you want
to change an
GeoMatchConstraintobject, you delete the existing object and add a new one. - The
Type. The only valid value forTypeisCountry. - The
Value, which is a two character code for the country to add to theGeoMatchConstraintobject. Valid codes are listed in GeoMatchConstraint$Value.
To create and configure an GeoMatchSet, perform the following steps:
- Submit a CreateGeoMatchSet request.
- Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of an UpdateGeoMatchSet request. - Submit an
UpdateGeoMatchSetrequest to specify the country that you want AWS WAF to watch for.
When you update an GeoMatchSet, you specify the country that you want
to add and/or the country that you want to delete. If you want to
change a country, you delete the existing country and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
Synopsis
- data UpdateGeoMatchSet = UpdateGeoMatchSet' {}
- newUpdateGeoMatchSet :: Text -> Text -> NonEmpty GeoMatchSetUpdate -> UpdateGeoMatchSet
- updateGeoMatchSet_geoMatchSetId :: Lens' UpdateGeoMatchSet Text
- updateGeoMatchSet_changeToken :: Lens' UpdateGeoMatchSet Text
- updateGeoMatchSet_updates :: Lens' UpdateGeoMatchSet (NonEmpty GeoMatchSetUpdate)
- data UpdateGeoMatchSetResponse = UpdateGeoMatchSetResponse' {
- changeToken :: Maybe Text
- httpStatus :: Int
- newUpdateGeoMatchSetResponse :: Int -> UpdateGeoMatchSetResponse
- updateGeoMatchSetResponse_changeToken :: Lens' UpdateGeoMatchSetResponse (Maybe Text)
- updateGeoMatchSetResponse_httpStatus :: Lens' UpdateGeoMatchSetResponse Int
Creating a Request
data UpdateGeoMatchSet Source #
See: newUpdateGeoMatchSet smart constructor.
Constructors
| UpdateGeoMatchSet' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty GeoMatchSetUpdate | |
| -> UpdateGeoMatchSet |
Create a value of UpdateGeoMatchSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:geoMatchSetId:UpdateGeoMatchSet', updateGeoMatchSet_geoMatchSetId - The GeoMatchSetId of the GeoMatchSet that you want to update.
GeoMatchSetId is returned by CreateGeoMatchSet and by
ListGeoMatchSets.
$sel:changeToken:UpdateGeoMatchSet', updateGeoMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.
$sel:updates:UpdateGeoMatchSet', updateGeoMatchSet_updates - An array of GeoMatchSetUpdate objects that you want to insert into or
delete from an GeoMatchSet. For more information, see the applicable
data types:
- GeoMatchSetUpdate: Contains
ActionandGeoMatchConstraint GeoMatchConstraint: Contains
TypeandValueYou can have only one
TypeandValueperGeoMatchConstraint. To add multiple countries, include multipleGeoMatchSetUpdateobjects in your request.
Request Lenses
updateGeoMatchSet_geoMatchSetId :: Lens' UpdateGeoMatchSet Text Source #
The GeoMatchSetId of the GeoMatchSet that you want to update.
GeoMatchSetId is returned by CreateGeoMatchSet and by
ListGeoMatchSets.
updateGeoMatchSet_changeToken :: Lens' UpdateGeoMatchSet Text Source #
The value returned by the most recent call to GetChangeToken.
updateGeoMatchSet_updates :: Lens' UpdateGeoMatchSet (NonEmpty GeoMatchSetUpdate) Source #
An array of GeoMatchSetUpdate objects that you want to insert into or
delete from an GeoMatchSet. For more information, see the applicable
data types:
- GeoMatchSetUpdate: Contains
ActionandGeoMatchConstraint GeoMatchConstraint: Contains
TypeandValueYou can have only one
TypeandValueperGeoMatchConstraint. To add multiple countries, include multipleGeoMatchSetUpdateobjects in your request.
Destructuring the Response
data UpdateGeoMatchSetResponse Source #
See: newUpdateGeoMatchSetResponse smart constructor.
Constructors
| UpdateGeoMatchSetResponse' | |
Fields
| |
Instances
newUpdateGeoMatchSetResponse Source #
Create a value of UpdateGeoMatchSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:changeToken:UpdateGeoMatchSet', updateGeoMatchSetResponse_changeToken - The ChangeToken that you used to submit the UpdateGeoMatchSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
$sel:httpStatus:UpdateGeoMatchSetResponse', updateGeoMatchSetResponse_httpStatus - The response's http status code.
Response Lenses
updateGeoMatchSetResponse_changeToken :: Lens' UpdateGeoMatchSetResponse (Maybe Text) Source #
The ChangeToken that you used to submit the UpdateGeoMatchSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
updateGeoMatchSetResponse_httpStatus :: Lens' UpdateGeoMatchSetResponse Int Source #
The response's http status code.