UpdateIngressPoint
Update attributes of a provisioned ingress endpoint resource.
Request Syntax
{
"IngressPointConfiguration": { ... },
"IngressPointId": "string",
"IngressPointName": "string",
"RuleSetId": "string",
"StatusToUpdate": "string",
"TrafficPolicyId": "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.
- IngressPointConfiguration
-
If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
Type: IngressPointConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- IngressPointId
-
The identifier for the ingress endpoint you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- IngressPointName
-
A user friendly name for the ingress endpoint resource.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[A-Za-z0-9_\-]+$Required: No
- RuleSetId
-
The identifier of an existing rule set that you attach to an ingress endpoint resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- StatusToUpdate
-
The update status of an ingress endpoint.
Type: String
Valid Values:
ACTIVE | CLOSEDRequired: No
- TrafficPolicyId
-
The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The request configuration has conflicts. For details, see the accompanying error message.
HTTP Status Code: 400
- ResourceNotFoundException
-
Occurs when a requested resource is not found.
HTTP Status Code: 400
- ValidationException
-
The request validation has failed. For details, see the accompanying error message.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
