reputation_entities

Creates, updates, deletes, gets or lists a reputation_entities resource.

Overview

Name	reputation_entities
Type	Resource
Id	aws.sesv2.reputation_entities

Fields

The following fields are returned by SELECT queries:

get_reputation_entity

Name	Datatype	Description
aws_ses_managed_status	object	The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.
customer_managed_status	object	The customer-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.
reputation_entity_reference	string	The unique identifier for a reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.
reputation_entity_type	string	The type of reputation entity. Currently, only RESOURCE type entities are supported, which represent resources in your Amazon SES account that have reputation tracking capabilities. (RESOURCE)
reputation_impact	string	The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the ListRecommendations operation. (LOW, HIGH)
reputation_management_policy	string	The Amazon Resource Name (ARN) of the reputation management policy applied to this entity. This is an Amazon Web Services Amazon SES-managed policy.
sending_status_aggregate	string	The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is DISABLED, the aggregate status will be DISABLED and the entity will not be allowed to send emails. When the customer-managed status is set to REINSTATED, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending. (ENABLED, REINSTATED, DISABLED)

list_reputation_entities

Name	Datatype	Description
aws_ses_managed_status	object	The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.
customer_managed_status	object	The customer-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.
reputation_entity_reference	string	The unique identifier for a reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.
reputation_entity_type	string	The type of reputation entity. Currently, only RESOURCE type entities are supported, which represent resources in your Amazon SES account that have reputation tracking capabilities. (RESOURCE)
reputation_impact	string	The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the ListRecommendations operation. (LOW, HIGH)
reputation_management_policy	string	The Amazon Resource Name (ARN) of the reputation management policy applied to this entity. This is an Amazon Web Services Amazon SES-managed policy.
sending_status_aggregate	string	The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is DISABLED, the aggregate status will be DISABLED and the entity will not be allowed to send emails. When the customer-managed status is set to REINSTATED, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending. (ENABLED, REINSTATED, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_reputation_entity	select	reputation_entity_reference, reputation_entity_type, region		Retrieve information about a specific reputation entity, including its reputation management policy, customer-managed status, Amazon Web Services Amazon SES-managed status, and aggregate sending status. Reputation entities represent resources in your Amazon SES account that have reputation tracking and management capabilities. The reputation impact reflects the highest impact reputation finding for the entity. Reputation findings can be retrieved using the ListRecommendations operation.
list_reputation_entities	select	region		List reputation entities in your Amazon SES account in the current Amazon Web Services Region. You can filter the results by entity type, reputation impact, sending status, or entity reference prefix. Reputation entities represent resources in your account that have reputation tracking and management capabilities. Use this operation to get an overview of all entities and their current reputation status.
update_reputation_entity_customer_managed_status	update	reputation_entity_type, reputation_entity_reference, region, SendingStatus		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.
update_reputation_entity_policy	update	reputation_entity_type, reputation_entity_reference, region, ReputationEntityPolicy		Update the reputation management policy for a reputation entity. The policy determines how the entity responds to reputation findings, such as automatically pausing sending when certain thresholds are exceeded. Reputation management policies are Amazon Web Services Amazon SES-managed (predefined policies). You can select from none, standard, and strict policies.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
reputation_entity_reference	string	The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.
reputation_entity_type	string	The type of reputation entity. Currently, only RESOURCE type entities are supported.

SELECT examples

get_reputation_entity

Retrieve information about a specific reputation entity, including its reputation management policy, customer-managed status, Amazon Web Services Amazon SES-managed status, and aggregate sending status. Reputation entities represent resources in your Amazon SES account that have reputation tracking and management capabilities. The reputation impact reflects the highest impact reputation finding for the entity. Reputation findings can be retrieved using the ListRecommendations operation.

SELECT
aws_ses_managed_status,
customer_managed_status,
reputation_entity_reference,
reputation_entity_type,
reputation_impact,
reputation_management_policy,
sending_status_aggregate
FROM aws.sesv2.reputation_entities
WHERE reputation_entity_reference = '{{ reputation_entity_reference }}' -- required
AND reputation_entity_type = '{{ reputation_entity_type }}' -- required
AND region = '{{ region }}' -- required
;

list_reputation_entities

List reputation entities in your Amazon SES account in the current Amazon Web Services Region. You can filter the results by entity type, reputation impact, sending status, or entity reference prefix. Reputation entities represent resources in your account that have reputation tracking and management capabilities. Use this operation to get an overview of all entities and their current reputation status.

SELECT
aws_ses_managed_status,
customer_managed_status,
reputation_entity_reference,
reputation_entity_type,
reputation_impact,
reputation_management_policy,
sending_status_aggregate
FROM aws.sesv2.reputation_entities
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_reputation_entity_customer_managed_status

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.

UPDATE aws.sesv2.reputation_entities
SET 
SendingStatus = '{{ SendingStatus }}'
WHERE 
reputation_entity_type = '{{ reputation_entity_type }}' --required
AND reputation_entity_reference = '{{ reputation_entity_reference }}' --required
AND region = '{{ region }}' --required
AND SendingStatus = '{{ SendingStatus }}' --required;

update_reputation_entity_policy

Update the reputation management policy for a reputation entity. The policy determines how the entity responds to reputation findings, such as automatically pausing sending when certain thresholds are exceeded. Reputation management policies are Amazon Web Services Amazon SES-managed (predefined policies). You can select from none, standard, and strict policies.

UPDATE aws.sesv2.reputation_entities
SET 
ReputationEntityPolicy = '{{ ReputationEntityPolicy }}'
WHERE 
reputation_entity_type = '{{ reputation_entity_type }}' --required
AND reputation_entity_reference = '{{ reputation_entity_reference }}' --required
AND region = '{{ region }}' --required
AND ReputationEntityPolicy = '{{ ReputationEntityPolicy }}' --required;