Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateProxy

Updates the properties of the specified proxy.

Request Syntax


{
   "ListenerPropertiesToAdd": [ 
      { 
         "Port": number,
         "Type": "string"
      }
   ],
   "ListenerPropertiesToRemove": [ 
      { 
         "Port": number,
         "Type": "string"
      }
   ],
   "NatGatewayId": "string",
   "ProxyArn": "string",
   "ProxyName": "string",
   "TlsInterceptProperties": { 
      "PcaArn": "string",
      "TlsInterceptMode": "string"
   },
   "UpdateToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ListenerPropertiesToAdd

Listener properties for HTTP and HTTPS traffic to add.

Type: Array of ListenerPropertyRequest objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Required: No

ListenerPropertiesToRemove

Listener properties for HTTP and HTTPS traffic to remove.

Type: Array of ListenerPropertyRequest objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Required: No

NatGatewayId

The NAT Gateway the proxy is attached to.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

ProxyArn

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

Type: String

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

Pattern: ^arn:aws.*

Required: No

ProxyName

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

Type: String

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

Pattern: ^[a-zA-Z0-9-]+$

Required: No

TlsInterceptProperties

TLS decryption on traffic to filter on attributes in the HTTP header.

Type: TlsInterceptPropertiesRequest object

Required: No

UpdateToken

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Type: String

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

Pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

Required: Yes

Response Syntax


{
   "Proxy": { 
      "CreateTime": number,
      "DeleteTime": number,
      "FailureCode": "string",
      "FailureMessage": "string",
      "ListenerProperties": [ 
         { 
            "Port": number,
            "Type": "string"
         }
      ],
      "NatGatewayId": "string",
      "ProxyArn": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "ProxyModifyState": "string",
      "ProxyName": "string",
      "ProxyState": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TlsInterceptProperties": { 
         "PcaArn": "string",
         "TlsInterceptMode": "string"
      },
      "UpdateTime": number
   },
   "UpdateToken": "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.

Proxy

The updated proxy resource that reflects the updates from the request.

Type: Proxy object

UpdateToken

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

Type: String

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

Pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

Errors

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

InternalServerError

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

InvalidRequestException

The operation failed because of a problem with your request. Examples include:

You specified an unsupported parameter name or value.
You tried to update a property with a value that isn't among the available types.
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

HTTP Status Code: 400

ResourceNotFoundException

Unable to locate a resource using the parameters that you provided.

HTTP Status Code: 400

ThrottlingException

Unable to process the request due to throttling limitations.

HTTP Status Code: 400

UnsupportedOperationException

The operation you requested isn't supported by Network Firewall.

HTTP Status Code: 400