List traffic policy resources.
Parameters:
-
page_size
(Optional[PageSize], default:
None
)
–
The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.
-
next_token
(Optional[PaginationToken], default:
None
)
–
If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
Raises:
-
ValidationException
–
The request validation has failed. For details, see the accompanying error message.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
List TrafficPolicies
>>> client.list_traffic_policies()
List TrafficPolicies with PageSize
>>> client.list_traffic_policies(page_size=10)
List TrafficPolicies with NextToken
>>> client.list_traffic_policies(next_token='nextToken')
Source code in docs_src/capo_mailmanager/_services/mail_manager.py
| def list_traffic_policies(
self,
*,
config_overrides: Optional[MailManagerClientConfig] = None,
page_size: Optional["capo_mailmanager.types.page_size.PageSize"] = None,
next_token: Optional[
"capo_mailmanager.types.pagination_token.PaginationToken"
] = None,
) -> "capo_mailmanager.types.list_traffic_policies_response.ListTrafficPoliciesResponse":
"""<p>List traffic policy resources.</p>
Args:
page_size: <p>The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.</p>
next_token: <p>If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.</p>
Raises:
capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
List TrafficPolicies
>>> client.list_traffic_policies()
List TrafficPolicies with PageSize
>>> client.list_traffic_policies(page_size=10)
List TrafficPolicies with NextToken
>>> client.list_traffic_policies(next_token='nextToken')
"""
def _handler(
req: "OperationRequest[capo_mailmanager.types.list_traffic_policies_request.ListTrafficPoliciesRequest]",
) -> OperationResponse[
"capo_mailmanager.types.list_traffic_policies_response.ListTrafficPoliciesResponse"
]:
import capo_mailmanager._operations.mail_manager_svc.list_traffic_policies
output, http_response = (
capo_mailmanager._operations.mail_manager_svc.list_traffic_policies.list_traffic_policies(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListTrafficPolicies")
)
input_: capo_mailmanager.types.list_traffic_policies_request.ListTrafficPoliciesRequest = {}
if page_size is not None:
input_["page_size"] = page_size
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|