ImportFirewallDomains
Imports domain names from a file into a domain list, for use in a DNS firewall rule group.
Each domain specification in your domain list must satisfy the following requirements:
-
It can optionally start with
*
(asterisk). -
With the exception of the optional starting asterisk, it must only contain the following characters:
A-Z
,a-z
,0-9
,-
(hyphen). -
It must be from 1-255 characters in length.
Request Syntax
{
"DomainFileUrl": "string
",
"FirewallDomainListId": "string
",
"Operation": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DomainFileUrl
-
The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.
The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
- FirewallDomainListId
-
The ID of the domain list that you want to modify with the import operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- Operation
-
What you want DNS Firewall to do with the domains that are listed in the file. This must be set to
REPLACE
, which updates the domain list to exactly match the list in the file.Type: String
Valid Values:
REPLACE
Required: Yes
Response Syntax
{
"Id": "string",
"Name": "string",
"Status": "string",
"StatusMessage": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Id
-
The Id of the firewall domain list that DNS Firewall just updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- Name
-
The name of the domain list.
Type: String
Length Constraints: Maximum length of 64.
Pattern:
(?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)
- Status
-
Status of the import request.
Type: String
Valid Values:
COMPLETE | COMPLETE_IMPORT_FAILED | IMPORTING | DELETING | UPDATING
- StatusMessage
-
Additional information about the status of the list, if available.
Type: String
Length Constraints: Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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.
HTTP Status Code: 400
- ConflictException
-
The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.
HTTP Status Code: 400
- InternalServiceErrorException
-
We encountered an unknown error. Try again in a few minutes.
HTTP Status Code: 400
- LimitExceededException
-
The request caused one or more limits to be exceeded.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource doesn't exist.
HTTP Status Code: 400
- ThrottlingException
-
The request was throttled. Try again in a few minutes.
HTTP Status Code: 400
- ValidationException
-
You have provided an invalid command. If you ran the
UpdateFirewallDomains
request. supported values areADD
,REMOVE
, orREPLACE
a domain.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: