Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . route53resolver ]
get-firewall-rule-group¶
Synopsis¶
get-firewall-rule-group
--firewall-rule-group-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--firewall-rule-group-id (string)
The unique identifier of the firewall rule group.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
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 Firewall rule group
The following get-firewall-rule-group example retrieves information about a DNS Firewall rule group with the ID you provide.
aws route53resolver get-firewall-rule-group \
--firewall-rule-group-id rslvr-frg-47f93271fexample
Output:
{
"FirewallRuleGroup": {
"Id": "rslvr-frg-47f93271fexample",
"Arn": "arn:aws:route53resolver:us-west-2:123456789012:firewall-rule-group/rslvr-frg-47f93271fexample",
"Name": "test",
"RuleCount": 0,
"Status": "COMPLETE",
"StatusMessage": "Created Firewall Rule Group",
"OwnerId": "123456789012",
"CreatorRequestId": "my-request-id",
"ShareStatus": "NOT_SHARED",
"CreationTime": "2021-05-25T18:59:26.490017Z",
"ModificationTime": "2021-05-25T18:59:26.490017Z"
}
}
For more information, see Managing rule groups and rules in DNS Firewall in the Amazon Route 53 Developer Guide.
Output¶
FirewallRuleGroup -> (structure)
A collection of rules used to filter DNS network traffic.
Id -> (string)
The ID of the rule group.Arn -> (string)
The ARN (Amazon Resource Name) of the rule group.Name -> (string)
The name of the rule group.RuleCount -> (integer)
The number of rules in the rule group.Status -> (string)
The status of the domain list.StatusMessage -> (string)
Additional information about the status of the rule group, if available.OwnerId -> (string)
The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.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.ShareStatus -> (string)
Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).CreationTime -> (string)
The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).ModificationTime -> (string)
The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).