SESV2 / Client / get_reputation_entity

get_reputation_entity

SESV2.Client.get_reputation_entity(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_reputation_entity(
    ReputationEntityReference='string',
    ReputationEntityType='RESOURCE'
)
Parameters:

  • ReputationEntityReference (string) –

    [REQUIRED]

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

  • ReputationEntityType (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ReputationEntity': {
        'ReputationEntityReference': 'string',
        'ReputationEntityType': 'RESOURCE',
        'ReputationManagementPolicy': 'string',
        'CustomerManagedStatus': {
            'Status': 'ENABLED'|'REINSTATED'|'DISABLED',
            'Cause': 'string',
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
        'AwsSesManagedStatus': {
            'Status': 'ENABLED'|'REINSTATED'|'DISABLED',
            'Cause': 'string',
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
        'SendingStatusAggregate': 'ENABLED'|'REINSTATED'|'DISABLED',
        'ReputationImpact': 'LOW'|'HIGH'
    }
}

Response Structure

  • (dict) –

    Information about the requested reputation entity.

    • ReputationEntity (dict) –

      The reputation entity information, including status records, policy configuration, and reputation impact.

      • ReputationEntityReference (string) –

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

      • ReputationEntityType (string) –

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

      • ReputationManagementPolicy (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.

      • CustomerManagedStatus (dict) –

        The customer-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

        • Status (string) –

          The current sending status. This can be one of the following:

          • ENABLED – Sending is allowed.

          • DISABLED – Sending is prevented.

          • REINSTATED – Sending is allowed even with active reputation findings.

        • Cause (string) –

          A description of the reason for the current status, or null if no specific cause is available.

        • LastUpdatedTimestamp (datetime) –

          The timestamp when this status was last updated.

      • AwsSesManagedStatus (dict) –

        The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.

        • Status (string) –

          The current sending status. This can be one of the following:

          • ENABLED – Sending is allowed.

          • DISABLED – Sending is prevented.

          • REINSTATED – Sending is allowed even with active reputation findings.

        • Cause (string) –

          A description of the reason for the current status, or null if no specific cause is available.

        • LastUpdatedTimestamp (datetime) –

          The timestamp when this status was last updated.

      • SendingStatusAggregate (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.

      • ReputationImpact (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.

Exceptions