Route53Resolver / Client / create_firewall_domain_list

create_firewall_domain_list#

Route53Resolver.Client.create_firewall_domain_list(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_firewall_domain_list(
    CreatorRequestId='string',
    Name='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • CreatorRequestId (string) –

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • Name (string) –

    [REQUIRED]

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

  • Tags (list) –

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

    • (dict) –

      One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value.

      • Key (string) – [REQUIRED]

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

      • Value (string) – [REQUIRED]

        The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you’re creating the resource for.

Return type:

dict

Returns:

Response Syntax

{
    'FirewallDomainList': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'DomainCount': 123,
        'Status': 'COMPLETE'|'COMPLETE_IMPORT_FAILED'|'IMPORTING'|'DELETING'|'UPDATING',
        'StatusMessage': 'string',
        'ManagedOwnerName': 'string',
        'CreatorRequestId': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) –

    • FirewallDomainList (dict) –

      The domain list that you just created.

      • Id (string) –

        The ID of the domain list.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the firewall domain list.

      • Name (string) –

        The name of the domain list.

      • DomainCount (integer) –

        The number of domain names that are specified in the domain list.

      • Status (string) –

        The status of the domain list.

      • StatusMessage (string) –

        Additional information about the status of the list, if available.

      • ManagedOwnerName (string) –

        The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.

      • CreatorRequestId (string) –

        A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

      • CreationTime (string) –

        The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) –

        The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions