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 Amazon Web Services Amazon SES-managed status to determine the overall sending capability. When you update the customer-managed status, the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon Web Services 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 Amazon Web Services Amazon SES-managed status also permits sending, even if there are active reputation findings, until the findings are resolved or new violations occur.
Parameters:
-
reputation_entity_type
(ReputationEntityType)
–
The type of reputation entity. Currently, only RESOURCE type entities are supported.
-
reputation_entity_reference
(ReputationEntityReference)
–
The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.
-
sending_status
(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.
Raises:
Source code in docs_src/capo_sesv2/_services/se_sv2.py
| def update_reputation_entity_customer_managed_status(
self,
reputation_entity_type: "capo_sesv2.types.reputation_entity_type.ReputationEntityType",
reputation_entity_reference: "capo_sesv2.types.reputation_entity_reference.ReputationEntityReference",
sending_status: "capo_sesv2.types.sending_status.SendingStatus",
*,
config_overrides: Optional[SESv2ClientConfig] = None,
) -> "capo_sesv2.types.update_reputation_entity_customer_managed_status_response.UpdateReputationEntityCustomerManagedStatusResponse":
"""<p>Update the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity.</p> <p>The customer-managed status works in conjunction with the Amazon Web Services Amazon SES-managed status to determine the overall sending capability. When you update the customer-managed status, the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon Web Services 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 Amazon Web Services Amazon SES-managed status also permits sending, even if there are active reputation findings, until the findings are resolved or new violations occur.</p>
Args:
reputation_entity_type: <p>The type of reputation entity. Currently, only <code>RESOURCE</code> type entities are supported.</p>
reputation_entity_reference: <p>The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.</p>
sending_status: <p>The new customer-managed sending status for the reputation entity. This can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Allow sending for this entity.</p> </li> <li> <p> <code>DISABLED</code> – Prevent sending for this entity.</p> </li> <li> <p> <code>REINSTATED</code> – Allow sending even if there are active reputation findings.</p> </li> </ul>
Raises:
capo_sesv2.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
capo_sesv2.errors.conflict_exception.ConflictException: <p>If there is already an ongoing account details update under review.</p>
capo_sesv2.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
capo_sesv2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_sesv2.types.update_reputation_entity_customer_managed_status_request.UpdateReputationEntityCustomerManagedStatusRequest]",
) -> OperationResponse[
"capo_sesv2.types.update_reputation_entity_customer_managed_status_response.UpdateReputationEntityCustomerManagedStatusResponse"
]:
import capo_sesv2._operations.simple_email_service_v2.update_reputation_entity_customer_managed_status
output, http_response = (
capo_sesv2._operations.simple_email_service_v2.update_reputation_entity_customer_managed_status.update_reputation_entity_customer_managed_status(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("UpdateReputationEntityCustomerManagedStatus"),
)
input_: capo_sesv2.types.update_reputation_entity_customer_managed_status_request.UpdateReputationEntityCustomerManagedStatusRequest = {
"reputation_entity_type": reputation_entity_type,
"reputation_entity_reference": reputation_entity_reference,
"sending_status": sending_status,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|