SESV2 / Paginator / ListReputationEntities

ListReputationEntities¶

class SESV2.Paginator.ListReputationEntities¶

paginator = client.get_paginator('list_reputation_entities')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SESV2.Client.list_reputation_entities().

Request Syntax

response_iterator = paginator.paginate(
    Filter={
        'string': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.