get-firewall-domain-list¶

Description¶

Retrieves the specified firewall domain list.

Synopsis¶

  get-firewall-domain-list
--firewall-domain-list-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--firewall-domain-list-id (string)

The ID of the domain list.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get a Route 53 Resolver DNS Firewall domain list

The following get-firewall-domain-list example retrieves the domain list with the ID you specify.

aws route53resolver get-firewall-domain-list \
    --firewall-domain-list-id rslvr-fdl-42b60677cexample

Output:

{
    "FirewallDomainList": {
        "Id": "rslvr-fdl-9e956e9ffexample",
        "Arn": "arn:aws:route53resolver:us-west-2:123457689012:firewall-domain-list/rslvr-fdl-42b60677cexample",
        "Name": "test",
        "DomainCount": 0,
        "Status": "COMPLETE",
        "StatusMessage": "Created Firewall Domain List",
        "CreatorRequestId": "my-request-id",
        "CreationTime": "2021-05-25T15:55:51.115365Z",
        "ModificationTime": "2021-05-25T15:55:51.115365Z"
    }
}

For more information, see Managing your own domain lists in the Amazon Route 53 Developer Guide.

Output¶

FirewallDomainList -> (structure)

The domain list that you requested.

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).

Table of Contents

Feedback

User Guide