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

UpdateReputationEntityCustomerManagedStatus

Update the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity.

The customer-managed status works in conjunction with the AWS Amazon SES-managed status to determine the overall sending capability. When you update the customer-managed status, the AWS Amazon SES-managed status remains unchanged. If AWS Amazon SES has disabled the entity, it will not be allowed to send regardless of the customer-managed status setting. When you reinstate an entity through the customer-managed status, it can continue sending only if the AWS Amazon SES-managed status also permits sending, even if there are active reputation findings, until the findings are resolved or new violations occur.

Request Syntax


PUT /v2/email/reputation/entities/ReputationEntityType/ReputationEntityReference/customer-managed-status HTTP/1.1
Content-type: application/json

{
   "SendingStatus": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ReputationEntityReference

The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.

Length Constraints: Minimum length of 1.

Required: Yes

ReputationEntityType

The type of reputation entity. Currently, only RESOURCE type entities are supported.

Valid Values: RESOURCE

Required: Yes

Request Body

The request accepts the following data in JSON format.

SendingStatus

The new customer-managed sending status for the reputation entity. This can be one of the following:

ENABLED – Allow sending for this entity.
DISABLED – Prevent sending for this entity.
REINSTATED – Allow sending even if there are active reputation findings.

Type: String

Valid Values: ENABLED | REINSTATED | DISABLED

Required: Yes

Response Syntax


HTTP/1.1 200

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.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

ConflictException

If there is already an ongoing account details update under review.

HTTP Status Code: 409

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429