Skip to content

create_traffic_policy async

create_traffic_policy(
    traffic_policy_name: TrafficPolicyName,
    policy_statements: PolicyStatementList,
    default_action: AcceptAction,
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    max_message_size_bytes: Optional[MaxMessageSizeBytes] = None,
    tags: Optional[TagList] = None,
) -> CreateTrafficPolicyResponse

Provision a new traffic policy resource.

Parameters:

  • client_token (Optional[IdempotencyToken], default: None ) –

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

  • traffic_policy_name (TrafficPolicyName) –

    A user-friendly name for the traffic policy resource.

  • policy_statements (PolicyStatementList) –

    Conditional statements for filtering email traffic.

  • default_action (AcceptAction) –

    Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

  • max_message_size_bytes (Optional[MaxMessageSizeBytes], default: None ) –

    The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

  • tags (Optional[TagList], default: None ) –

    The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Raises:

Examples:

Create TrafficPolicy

>>> await client.create_traffic_policy(traffic_policy_name='trafficPolicyName', policy_statements=[{'Conditions': [{'IpExpression': {'Evaluate': {'Attribute': 'SENDER_IP'}, 'Operator': 'CIDR_MATCHES', 'Values': ['0.0.0.0/12']}}], 'Action': 'ALLOW'}], default_action='DENY')
Source code in docs_src/capo_mailmanager/_services/async_mail_manager.py
async def create_traffic_policy(
    self,
    traffic_policy_name: "capo_mailmanager.types.traffic_policy_name.TrafficPolicyName",
    policy_statements: "capo_mailmanager.types.policy_statement_list.PolicyStatementList",
    default_action: "capo_mailmanager.types.accept_action.AcceptAction",
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    client_token: Optional[
        "capo_mailmanager.types.idempotency_token.IdempotencyToken"
    ] = None,
    max_message_size_bytes: Optional[
        "capo_mailmanager.types.max_message_size_bytes.MaxMessageSizeBytes"
    ] = None,
    tags: Optional["capo_mailmanager.types.tag_list.TagList"] = None,
) -> "capo_mailmanager.types.create_traffic_policy_response.CreateTrafficPolicyResponse":
    """<p>Provision a new traffic policy resource.</p>

    Args:
        client_token: <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
        traffic_policy_name: <p>A user-friendly name for the traffic policy resource.</p>
        policy_statements: <p>Conditional statements for filtering email traffic.</p>
        default_action: <p>Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements</p>
        max_message_size_bytes: <p>The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.</p>
        tags: <p>The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>

    Raises:
        capo_mailmanager.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Occurs when an operation exceeds a predefined service quota or limit.</p>
        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:
        Create TrafficPolicy

        >>> await client.create_traffic_policy(traffic_policy_name='trafficPolicyName', policy_statements=[{'Conditions': [{'IpExpression': {'Evaluate': {'Attribute': 'SENDER_IP'}, 'Operator': 'CIDR_MATCHES', 'Values': ['0.0.0.0/12']}}], 'Action': 'ALLOW'}], default_action='DENY')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mailmanager.types.create_traffic_policy_request.CreateTrafficPolicyRequest]",
    ) -> AsyncOperationResponse[
        "capo_mailmanager.types.create_traffic_policy_response.CreateTrafficPolicyResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.create_traffic_policy

        (
            output,
            http_response,
        ) = await capo_mailmanager._operations.mail_manager_svc.create_traffic_policy.async_create_traffic_policy(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateTrafficPolicy")
    )
    input_: capo_mailmanager.types.create_traffic_policy_request.CreateTrafficPolicyRequest = {
        "traffic_policy_name": traffic_policy_name,
        "policy_statements": policy_statements,
        "default_action": default_action,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if max_message_size_bytes is not None:
        input_["max_message_size_bytes"] = max_message_size_bytes
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output