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.
Parameters:
-
filter
(Optional[ReputationEntityFilter], default:
None
)
–
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.
-
next_token
(Optional[NextToken], default:
None
)
–
A token returned from a previous call to ListReputationEntities to indicate the position in the list of reputation entities.
-
page_size
(Optional[MaxItems], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_sesv2/_services/se_sv2.py
| def list_reputation_entities(
self,
*,
config_overrides: Optional[SESv2ClientConfig] = None,
filter: Optional[
"capo_sesv2.types.reputation_entity_filter.ReputationEntityFilter"
] = None,
next_token: Optional["capo_sesv2.types.next_token.NextToken"] = None,
page_size: Optional["capo_sesv2.types.max_items.MaxItems"] = None,
) -> "capo_sesv2.types.list_reputation_entities_response.ListReputationEntitiesResponse":
"""<p>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.</p> <p> <i>Reputation entities</i> 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.</p>
Args:
filter: <p>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.</p>
next_token: <p>A token returned from a previous call to <code>ListReputationEntities</code> to indicate the position in the list of reputation entities.</p>
page_size: <p>The number of results to show in a single call to <code>ListReputationEntities</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>
Raises:
capo_sesv2.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
capo_sesv2.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
capo_sesv2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_sesv2.types.list_reputation_entities_request.ListReputationEntitiesRequest]",
) -> OperationResponse[
"capo_sesv2.types.list_reputation_entities_response.ListReputationEntitiesResponse"
]:
import capo_sesv2._operations.simple_email_service_v2.list_reputation_entities
output, http_response = (
capo_sesv2._operations.simple_email_service_v2.list_reputation_entities.list_reputation_entities(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListReputationEntities")
)
input_: capo_sesv2.types.list_reputation_entities_request.ListReputationEntitiesRequest = {}
if filter is not None:
input_["filter"] = filter
if next_token is not None:
input_["next_token"] = next_token
if page_size is not None:
input_["page_size"] = page_size
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|