Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListReputationEntities

List reputation entities in your Amazon SES account in the current AWS 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.

Request Syntax


POST /v2/email/reputation/entities HTTP/1.1
Content-type: application/json

{
   "Filter": { 
      "string" : "string" 
   },
   "NextToken": "string",
   "PageSize": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filter

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.

Type: String to string map

Valid Keys: ENTITY_TYPE | REPUTATION_IMPACT | SENDING_STATUS | ENTITY_REFERENCE_PREFIX

Value Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

NextToken

A token returned from a previous call to ListReputationEntities to indicate the position in the list of reputation entities.

Type: String

Required: No

PageSize

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.

Type: Integer

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ReputationEntities": [ 
      { 
         "AwsSesManagedStatus": { 
            "Cause": "string",
            "LastUpdatedTimestamp": number,
            "Status": "string"
         },
         "CustomerManagedStatus": { 
            "Cause": "string",
            "LastUpdatedTimestamp": number,
            "Status": "string"
         },
         "ReputationEntityReference": "string",
         "ReputationEntityType": "string",
         "ReputationImpact": "string",
         "ReputationManagementPolicy": "string",
         "SendingStatusAggregate": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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.

Type: String

ReputationEntities

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

Type: Array of ReputationEntity objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429