Skip to content

create_firewall_domain_list

create_firewall_domain_list(
    creator_request_id: CreatorRequestId,
    name: Name,
    *,
    config_overrides: Optional[Route53ResolverClientConfig] = None,
    tags: Optional[TagList] = None,
) -> CreateFirewallDomainListResponse

Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.

Parameters:

  • creator_request_id (CreatorRequestId) –

    A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

  • name (Name) –

    A name that lets you identify the domain list to manage and use it.

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

    A list of the tag keys and values that you want to associate with the domain list.

Raises:

  • AccessDeniedException –

    The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

    This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

  • InternalServiceErrorException –

    We encountered an unknown error. Try again in a few minutes.

  • LimitExceededException –

    The request caused one or more limits to be exceeded.

  • ThrottlingException –

    The request was throttled. Try again in a few minutes.

  • ValidationException –

    You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_route53resolver/_services/route53_resolver.py
def create_firewall_domain_list(
    self,
    creator_request_id: "capo_route53resolver.types.creator_request_id.CreatorRequestId",
    name: "capo_route53resolver.types.name.Name",
    *,
    config_overrides: Optional[Route53ResolverClientConfig] = None,
    tags: Optional["capo_route53resolver.types.tag_list.TagList"] = None,
) -> "capo_route53resolver.types.create_firewall_domain_list_response.CreateFirewallDomainListResponse":
    """<p>Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using <a>ImportFirewallDomains</a>, or with domain strings, using <a>UpdateFirewallDomains</a>. </p>

    Args:
        creator_request_id: <p>A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp. </p>
        name: <p>A name that lets you identify the domain list to manage and use it.</p>
        tags: <p>A list of the tag keys and values that you want to associate with the domain list. </p>

    Raises:
        capo_route53resolver.errors.access_denied_exception.AccessDeniedException: <p>The current account doesn't have the IAM permissions required to perform the specified Resolver operation.</p> <p>This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.</p>
        capo_route53resolver.errors.internal_service_error_exception.InternalServiceErrorException: <p>We encountered an unknown error. Try again in a few minutes.</p>
        capo_route53resolver.errors.limit_exceeded_exception.LimitExceededException: <p>The request caused one or more limits to be exceeded.</p>
        capo_route53resolver.errors.throttling_exception.ThrottlingException: <p>The request was throttled. Try again in a few minutes.</p>
        capo_route53resolver.errors.validation_exception.ValidationException: <p>You have provided an invalid command. If you ran the <code>UpdateFirewallDomains</code> request. supported values are <code>ADD</code>, <code>REMOVE</code>, or <code>REPLACE</code> a domain.</p>
        capo_route53resolver.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route53resolver.types.create_firewall_domain_list_request.CreateFirewallDomainListRequest]",
    ) -> OperationResponse[
        "capo_route53resolver.types.create_firewall_domain_list_response.CreateFirewallDomainListResponse"
    ]:
        import capo_route53resolver._operations.route53_resolver.create_firewall_domain_list

        output, http_response = (
            capo_route53resolver._operations.route53_resolver.create_firewall_domain_list.create_firewall_domain_list(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateFirewallDomainList")
    )
    input_: capo_route53resolver.types.create_firewall_domain_list_request.CreateFirewallDomainListRequest = {
        "creator_request_id": creator_request_id,
        "name": name,
    }
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output