Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateIpAccessSettings

Updates IP access settings.

Request Syntax


PATCH /ipAccessSettings/ipAccessSettingsArn+ HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "displayName": "string",
   "ipRules": [ 
      { 
         "description": "string",
         "ipRange": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

ipAccessSettingsArn

The ARN of the IP access settings.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

description

The description of the IP access settings.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^.+$

Required: No

displayName

The display name of the IP access settings.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^.+$

Required: No

ipRules

The updated IP rules of the IP access settings.

Type: Array of IpRule objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ipAccessSettings": { 
      "additionalEncryptionContext": { 
         "string" : "string" 
      },
      "associatedPortalArns": [ "string" ],
      "creationDate": number,
      "customerManagedKey": "string",
      "description": "string",
      "displayName": "string",
      "ipAccessSettingsArn": "string",
      "ipRules": [ 
         { 
            "description": "string",
            "ipRange": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ipAccessSettings

The IP access settings.

Type: IpAccessSettings object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServerException

There is an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404

ThrottlingException

There is a throttling error.

HTTP Status Code: 429

ValidationException

There is a validation error.

HTTP Status Code: 400