SESV2 / Client / list_reputation_entities

list_reputation_entities

SESV2.Client.list_reputation_entities(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_reputation_entities(
    Filter={
        'string': 'string'
    },
    NextToken='string',
    PageSize=123
)
Parameters:

  • Filter (dict) –

    An object that contains filters to apply when listing reputation entities. You can filter by entity type, reputation impact, sending status, or entity reference prefix.

    • (string) –

      The filter key to use when listing reputation entities. This can be one of the following:

      • ENTITY_TYPE – Filter by entity type.

      • REPUTATION_IMPACT – Filter by reputation impact level.

      • SENDING_STATUS – Filter by aggregate sending status.

      • ENTITY_REFERENCE_PREFIX – Filter by entity reference prefix.

      • (string) –

        The filter value to match against the specified filter key.

  • NextToken (string) – A token returned from a previous call to ListReputationEntities to indicate the position in the list of reputation entities.

  • PageSize (integer) – The number of results to show in a single call to ListReputationEntities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Return type:

dict

Returns:

Response Syntax

{
    'ReputationEntities': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    A list of reputation entities in your account.

    • ReputationEntities (list) –

      An array that contains information about the reputation entities in your account.

      • (dict) –

        An object that contains information about a reputation entity, including its reference, type, policy, status records, 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.

    • NextToken (string) –

      A token that indicates that there are additional reputation entities to list. To view additional reputation entities, issue another request to ListReputationEntities, and pass this token in the NextToken parameter.

Exceptions