2023/07/20 - Amazon Route 53 Resolver - 5 new8 updated api methods
Changes This release adds support for Route 53 On Outposts, a new feature that allows customers to run Route 53 Resolver and Resolver endpoints locally on their Outposts.
Deletes a Resolver on the Outpost.
See also: AWS API Documentation
Request Syntax
client.delete_outpost_resolver(
Id='string'
)
string
[REQUIRED]
A unique string that identifies the Resolver on the Outpost.
dict
Response Syntax
{
'OutpostResolver': {
'Arn': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'CreatorRequestId': 'string',
'Id': 'string',
'InstanceCount': 123,
'PreferredInstanceType': 'string',
'Name': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING'|'ACTION_NEEDED'|'FAILED_CREATION'|'FAILED_DELETION',
'StatusMessage': 'string',
'OutpostArn': 'string'
}
}
Response Structure
(dict) --
OutpostResolver (dict) --
Information about the DeleteOutpostResolver request, including the status of the request.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver on an Outpost.
CreationTime (string) --
The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Id (string) --
The ID of the Resolver on Outpost.
InstanceCount (integer) --
Amazon EC2 instance count for the Resolver on the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
Name (string) --
Name of the Resolver.
Status (string) --
Status of the Resolver.
StatusMessage (string) --
A detailed description of the Resolver.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
Creates an Route 53 Resolver on an Outpost.
See also: AWS API Documentation
Request Syntax
client.create_outpost_resolver(
CreatorRequestId='string',
Name='string',
InstanceCount=123,
PreferredInstanceType='string',
OutpostArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.
CreatorRequestId can be any unique string, for example, a date/time stamp.
string
[REQUIRED]
A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
integer
Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4.
string
[REQUIRED]
The Amazon EC2 instance type. If you specify this, you must also specify a value for the OutpostArn.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.
list
A string that helps identify the Route 53 Resolvers on Outpost.
(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.
dict
Response Syntax
{
'OutpostResolver': {
'Arn': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'CreatorRequestId': 'string',
'Id': 'string',
'InstanceCount': 123,
'PreferredInstanceType': 'string',
'Name': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING'|'ACTION_NEEDED'|'FAILED_CREATION'|'FAILED_DELETION',
'StatusMessage': 'string',
'OutpostArn': 'string'
}
}
Response Structure
(dict) --
OutpostResolver (dict) --
Information about the CreateOutpostResolver request, including the status of the request.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver on an Outpost.
CreationTime (string) --
The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Id (string) --
The ID of the Resolver on Outpost.
InstanceCount (integer) --
Amazon EC2 instance count for the Resolver on the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
Name (string) --
Name of the Resolver.
Status (string) --
Status of the Resolver.
StatusMessage (string) --
A detailed description of the Resolver.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_outpost_resolvers(
OutpostArn='string',
MaxResults=123,
NextToken='string'
)
string
The Amazon Resource Name (ARN) of the Outpost.
integer
The maximum number of Resolvers on the Outpost that you want to return in the response to a ListOutpostResolver request. If you don't specify a value for MaxResults, the request returns up to 100 Resolvers.
string
For the first ListOutpostResolver request, omit this value.
dict
Response Syntax
{
'OutpostResolvers': [
{
'Arn': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'CreatorRequestId': 'string',
'Id': 'string',
'InstanceCount': 123,
'PreferredInstanceType': 'string',
'Name': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING'|'ACTION_NEEDED'|'FAILED_CREATION'|'FAILED_DELETION',
'StatusMessage': 'string',
'OutpostArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OutpostResolvers (list) --
The Resolvers on Outposts that were created by using the current Amazon Web Services account, and that match the specified filters, if any.
(dict) --
A complex type that contains settings for an existing Resolver on an Outpost.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver on an Outpost.
CreationTime (string) --
The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Id (string) --
The ID of the Resolver on Outpost.
InstanceCount (integer) --
Amazon EC2 instance count for the Resolver on the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
Name (string) --
Name of the Resolver.
Status (string) --
Status of the Resolver.
StatusMessage (string) --
A detailed description of the Resolver.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
NextToken (string) --
If more than MaxResults Resolvers match the specified criteria, you can submit another ListOutpostResolver request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost.
See also: AWS API Documentation
Request Syntax
client.update_outpost_resolver(
Id='string',
Name='string',
InstanceCount=123,
PreferredInstanceType='string'
)
string
[REQUIRED]
A unique string that identifies Resolver on an Outpost.
string
Name of the Resolver on the Outpost.
integer
The Amazon EC2 instance count for a Resolver on the Outpost.
string
Amazon EC2 instance type.
dict
Response Syntax
{
'OutpostResolver': {
'Arn': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'CreatorRequestId': 'string',
'Id': 'string',
'InstanceCount': 123,
'PreferredInstanceType': 'string',
'Name': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING'|'ACTION_NEEDED'|'FAILED_CREATION'|'FAILED_DELETION',
'StatusMessage': 'string',
'OutpostArn': 'string'
}
}
Response Structure
(dict) --
OutpostResolver (dict) --
The response to an UpdateOutpostResolver request.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver on an Outpost.
CreationTime (string) --
The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Id (string) --
The ID of the Resolver on Outpost.
InstanceCount (integer) --
Amazon EC2 instance count for the Resolver on the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
Name (string) --
Name of the Resolver.
Status (string) --
Status of the Resolver.
StatusMessage (string) --
A detailed description of the Resolver.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.
See also: AWS API Documentation
Request Syntax
client.get_outpost_resolver(
Id='string'
)
string
[REQUIRED]
The ID of the Resolver on the Outpost.
dict
Response Syntax
{
'OutpostResolver': {
'Arn': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'CreatorRequestId': 'string',
'Id': 'string',
'InstanceCount': 123,
'PreferredInstanceType': 'string',
'Name': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING'|'ACTION_NEEDED'|'FAILED_CREATION'|'FAILED_DELETION',
'StatusMessage': 'string',
'OutpostArn': 'string'
}
}
Response Structure
(dict) --
OutpostResolver (dict) --
Information about the GetOutpostResolver request, including the status of the request.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver on an Outpost.
CreationTime (string) --
The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Id (string) --
The ID of the Resolver on Outpost.
InstanceCount (integer) --
Amazon EC2 instance count for the Resolver on the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
Name (string) --
Name of the Resolver.
Status (string) --
Status of the Resolver.
StatusMessage (string) --
A detailed description of the Resolver.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
{'ResolverEndpoint': {'OutpostArn': 'string',
'PreferredInstanceType': 'string'}}
Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.
To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.
See also: AWS API Documentation
Request Syntax
client.associate_resolver_endpoint_ip_address(
ResolverEndpointId='string',
IpAddress={
'IpId': 'string',
'SubnetId': 'string',
'Ip': 'string',
'Ipv6': 'string'
}
)
string
[REQUIRED]
The ID of the Resolver endpoint that you want to associate IP addresses with.
dict
[REQUIRED]
Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.
IpId (string) --
Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.
SubnetId (string) --
The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.
Ip (string) --
The new IPv4 address.
Ipv6 (string) --
The new IPv6 address.
dict
Response Syntax
{
'ResolverEndpoint': {
'Id': 'string',
'CreatorRequestId': 'string',
'Arn': 'string',
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'Direction': 'INBOUND'|'OUTBOUND',
'IpAddressCount': 123,
'HostVPCId': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
'StatusMessage': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'ResolverEndpointType': 'IPV6'|'IPV4'|'DUALSTACK',
'OutpostArn': 'string',
'PreferredInstanceType': 'string'
}
}
Response Structure
(dict) --
ResolverEndpoint (dict) --
The response to an AssociateResolverEndpointIpAddress request.
Id (string) --
The ID of the Resolver endpoint.
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver endpoint.
Name (string) --
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
SecurityGroupIds (list) --
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
(string) --
Direction (string) --
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
IpAddressCount (integer) --
The number of IP addresses that the Resolver endpoint can use for DNS queries.
HostVPCId (string) --
The ID of the VPC that you want to create the Resolver endpoint in.
Status (string) --
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
StatusMessage (string) --
A detailed description of the status of the Resolver endpoint.
CreationTime (string) --
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
ResolverEndpointType (string) --
The Resolver endpoint IP address type.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
{'OutpostArn': 'string', 'PreferredInstanceType': 'string'}
Response {'ResolverEndpoint': {'OutpostArn': 'string',
'PreferredInstanceType': 'string'}}
Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:
An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC from your network.
An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network.
See also: AWS API Documentation
Request Syntax
client.create_resolver_endpoint(
CreatorRequestId='string',
Name='string',
SecurityGroupIds=[
'string',
],
Direction='INBOUND'|'OUTBOUND',
IpAddresses=[
{
'SubnetId': 'string',
'Ip': 'string',
'Ipv6': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ResolverEndpointType='IPV6'|'IPV4'|'DUALSTACK',
OutpostArn='string',
PreferredInstanceType='string'
)
string
[REQUIRED]
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
string
A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
list
[REQUIRED]
The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
(string) --
string
[REQUIRED]
Specify the applicable value:
INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network
OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network
list
[REQUIRED]
The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.
(dict) --
In a CreateResolverEndpoint request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). IpAddressRequest also includes the ID of the subnet that contains the IP address.
SubnetId (string) -- [REQUIRED]
The ID of the subnet that contains the IP address.
Ip (string) --
The IPv4 address that you want to use for DNS queries.
Ipv6 (string) --
The IPv6 address that you want to use for DNS queries.
list
A list of the tag keys and values that you want to associate with the endpoint.
(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.
string
For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.
string
The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.
string
The instance type. If you specify this, you must also specify a value for the OutpostArn.
dict
Response Syntax
{
'ResolverEndpoint': {
'Id': 'string',
'CreatorRequestId': 'string',
'Arn': 'string',
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'Direction': 'INBOUND'|'OUTBOUND',
'IpAddressCount': 123,
'HostVPCId': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
'StatusMessage': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'ResolverEndpointType': 'IPV6'|'IPV4'|'DUALSTACK',
'OutpostArn': 'string',
'PreferredInstanceType': 'string'
}
}
Response Structure
(dict) --
ResolverEndpoint (dict) --
Information about the CreateResolverEndpoint request, including the status of the request.
Id (string) --
The ID of the Resolver endpoint.
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver endpoint.
Name (string) --
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
SecurityGroupIds (list) --
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
(string) --
Direction (string) --
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
IpAddressCount (integer) --
The number of IP addresses that the Resolver endpoint can use for DNS queries.
HostVPCId (string) --
The ID of the VPC that you want to create the Resolver endpoint in.
Status (string) --
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
StatusMessage (string) --
A detailed description of the status of the Resolver endpoint.
CreationTime (string) --
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
ResolverEndpointType (string) --
The Resolver endpoint IP address type.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
{'ResolverEndpoint': {'OutpostArn': 'string',
'PreferredInstanceType': 'string'}}
Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound Resolver endpoint:
Inbound: DNS queries from your network are no longer routed to the DNS service for the specified VPC.
Outbound: DNS queries from a VPC are no longer routed to your network.
See also: AWS API Documentation
Request Syntax
client.delete_resolver_endpoint(
ResolverEndpointId='string'
)
string
[REQUIRED]
The ID of the Resolver endpoint that you want to delete.
dict
Response Syntax
{
'ResolverEndpoint': {
'Id': 'string',
'CreatorRequestId': 'string',
'Arn': 'string',
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'Direction': 'INBOUND'|'OUTBOUND',
'IpAddressCount': 123,
'HostVPCId': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
'StatusMessage': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'ResolverEndpointType': 'IPV6'|'IPV4'|'DUALSTACK',
'OutpostArn': 'string',
'PreferredInstanceType': 'string'
}
}
Response Structure
(dict) --
ResolverEndpoint (dict) --
Information about the DeleteResolverEndpoint request, including the status of the request.
Id (string) --
The ID of the Resolver endpoint.
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver endpoint.
Name (string) --
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
SecurityGroupIds (list) --
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
(string) --
Direction (string) --
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
IpAddressCount (integer) --
The number of IP addresses that the Resolver endpoint can use for DNS queries.
HostVPCId (string) --
The ID of the VPC that you want to create the Resolver endpoint in.
Status (string) --
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
StatusMessage (string) --
A detailed description of the status of the Resolver endpoint.
CreationTime (string) --
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
ResolverEndpointType (string) --
The Resolver endpoint IP address type.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
{'ResolverEndpoint': {'OutpostArn': 'string',
'PreferredInstanceType': 'string'}}
Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.
To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.
See also: AWS API Documentation
Request Syntax
client.disassociate_resolver_endpoint_ip_address(
ResolverEndpointId='string',
IpAddress={
'IpId': 'string',
'SubnetId': 'string',
'Ip': 'string',
'Ipv6': 'string'
}
)
string
[REQUIRED]
The ID of the Resolver endpoint that you want to disassociate an IP address from.
dict
[REQUIRED]
The IPv4 address that you want to remove from a Resolver endpoint.
IpId (string) --
Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.
SubnetId (string) --
The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.
Ip (string) --
The new IPv4 address.
Ipv6 (string) --
The new IPv6 address.
dict
Response Syntax
{
'ResolverEndpoint': {
'Id': 'string',
'CreatorRequestId': 'string',
'Arn': 'string',
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'Direction': 'INBOUND'|'OUTBOUND',
'IpAddressCount': 123,
'HostVPCId': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
'StatusMessage': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'ResolverEndpointType': 'IPV6'|'IPV4'|'DUALSTACK',
'OutpostArn': 'string',
'PreferredInstanceType': 'string'
}
}
Response Structure
(dict) --
ResolverEndpoint (dict) --
The response to an DisassociateResolverEndpointIpAddress request.
Id (string) --
The ID of the Resolver endpoint.
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver endpoint.
Name (string) --
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
SecurityGroupIds (list) --
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
(string) --
Direction (string) --
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
IpAddressCount (integer) --
The number of IP addresses that the Resolver endpoint can use for DNS queries.
HostVPCId (string) --
The ID of the VPC that you want to create the Resolver endpoint in.
Status (string) --
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
StatusMessage (string) --
A detailed description of the status of the Resolver endpoint.
CreationTime (string) --
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
ResolverEndpointType (string) --
The Resolver endpoint IP address type.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
{'ResolverEndpoint': {'OutpostArn': 'string',
'PreferredInstanceType': 'string'}}
Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint.
See also: AWS API Documentation
Request Syntax
client.get_resolver_endpoint(
ResolverEndpointId='string'
)
string
[REQUIRED]
The ID of the Resolver endpoint that you want to get information about.
dict
Response Syntax
{
'ResolverEndpoint': {
'Id': 'string',
'CreatorRequestId': 'string',
'Arn': 'string',
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'Direction': 'INBOUND'|'OUTBOUND',
'IpAddressCount': 123,
'HostVPCId': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
'StatusMessage': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'ResolverEndpointType': 'IPV6'|'IPV4'|'DUALSTACK',
'OutpostArn': 'string',
'PreferredInstanceType': 'string'
}
}
Response Structure
(dict) --
ResolverEndpoint (dict) --
Information about the Resolver endpoint that you specified in a GetResolverEndpoint request.
Id (string) --
The ID of the Resolver endpoint.
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver endpoint.
Name (string) --
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
SecurityGroupIds (list) --
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
(string) --
Direction (string) --
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
IpAddressCount (integer) --
The number of IP addresses that the Resolver endpoint can use for DNS queries.
HostVPCId (string) --
The ID of the VPC that you want to create the Resolver endpoint in.
Status (string) --
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
StatusMessage (string) --
A detailed description of the status of the Resolver endpoint.
CreationTime (string) --
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
ResolverEndpointType (string) --
The Resolver endpoint IP address type.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
{'IpAddresses': {'Status': {'UPDATE_FAILED'}}}
Gets the IP addresses for a specified Resolver endpoint.
See also: AWS API Documentation
Request Syntax
client.list_resolver_endpoint_ip_addresses(
ResolverEndpointId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the Resolver endpoint that you want to get IP addresses for.
integer
The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults, Resolver returns up to 100 IP addresses.
string
For the first ListResolverEndpointIpAddresses request, omit this value.
If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.
dict
Response Syntax
{
'NextToken': 'string',
'MaxResults': 123,
'IpAddresses': [
{
'IpId': 'string',
'SubnetId': 'string',
'Ip': 'string',
'Ipv6': 'string',
'Status': 'CREATING'|'FAILED_CREATION'|'ATTACHING'|'ATTACHED'|'REMAP_DETACHING'|'REMAP_ATTACHING'|'DETACHING'|'FAILED_RESOURCE_GONE'|'DELETING'|'DELETE_FAILED_FAS_EXPIRED'|'UPDATING'|'UPDATE_FAILED',
'StatusMessage': 'string',
'CreationTime': 'string',
'ModificationTime': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.
MaxResults (integer) --
The value that you specified for MaxResults in the request.
IpAddresses (list) --
Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).
(dict) --
In the response to a GetResolverEndpoint request, information about the IP addresses that the Resolver endpoint uses for DNS queries.
IpId (string) --
The ID of one IP address.
SubnetId (string) --
The ID of one subnet.
Ip (string) --
One IPv4 address that the Resolver endpoint uses for DNS queries.
Ipv6 (string) --
One IPv6 address that the Resolver endpoint uses for DNS queries.
Status (string) --
A status code that gives the current status of the request.
StatusMessage (string) --
A message that provides additional information about the status of the request.
CreationTime (string) --
The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).
{'ResolverEndpoints': {'OutpostArn': 'string',
'PreferredInstanceType': 'string'}}
Lists all the Resolver endpoints that were created using the current Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_resolver_endpoints(
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
integer
The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints.
string
For the first ListResolverEndpoints request, omit this value.
If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.
list
An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.
(dict) --
For Resolver list operations ( ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations), and ListResolverDnssecConfigs), an optional specification to return a subset of objects.
To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.
Name (string) --
The name of the parameter that you want to use to filter objects.
The valid values for Name depend on the action that you're including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.
ListResolverEndpoints
Valid values for Name include the following:
CreatorRequestId: The value that you specified when you created the Resolver endpoint.
Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION for Name, specify INBOUND or OUTBOUND for Values.
HostVPCId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network. In a CreateResolverEndpoint request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a Resolver endpoint is returned in the HostVPCId element.
IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.
Name: The name of the Resolver endpoint.
SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the Resolver endpoint.
Status: The status of the Resolver endpoint. If you specify Status for Name, specify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING, AUTO_RECOVERING, ACTION_NEEDED, or DELETING. For more information, see Status in ResolverEndpoint.
ListResolverRules
Valid values for Name include the following:
CreatorRequestId: The value that you specified when you created the Resolver rule.
DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the value that you specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com: example.com.
Name: The name of the Resolver rule.
ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.
Status: The status of the Resolver rule. If you specify Status for Name, specify one of the following status codes for Values: COMPLETE, DELETING, UPDATING, or FAILED.
Type: The type of the Resolver rule. If you specify TYPE for Name, specify FORWARD or SYSTEM for Values.
ListResolverRuleAssociations
Valid values for Name include the following:
Name: The name of the Resolver rule association.
ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.
Status: The status of the Resolver rule association. If you specify Status for Name, specify one of the following status codes for Values: CREATING, COMPLETE, DELETING, or FAILED.
VPCId: The ID of the VPC that the Resolver rule is associated with.
ListResolverQueryLogConfigs
Valid values for Name include the following:
Arn: The ARN for the query logging configuration.
AssociationCount: The number of VPCs that are associated with the query logging configuration.
CreationTime: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId: A unique string that identifies the request that created the query logging configuration.
Destination: The Amazon Web Services service that you want to forward query logs to. Valid values include the following:
S3
CloudWatchLogs
KinesisFirehose
DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
Id: The ID of the query logging configuration
Name: The name of the query logging configuration
OwnerId: The Amazon Web Services account ID for the account that created the query logging configuration.
ShareStatus: An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Valid values include: NOT_SHARED, SHARED_WITH_ME, or SHARED_BY_ME.
Status: The status of the query logging configuration. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.
ListResolverQueryLogConfigAssociations
Valid values for Name include the following:
CreationTime: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
Error: If the value of Status is FAILED, specify the cause: DESTINATION_NOT_FOUND or ACCESS_DENIED.
Id: The ID of the query logging association.
ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.
ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.
Status: The status of the query logging association. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.
Values (list) --
When you're using a List operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'MaxResults': 123,
'ResolverEndpoints': [
{
'Id': 'string',
'CreatorRequestId': 'string',
'Arn': 'string',
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'Direction': 'INBOUND'|'OUTBOUND',
'IpAddressCount': 123,
'HostVPCId': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
'StatusMessage': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'ResolverEndpointType': 'IPV6'|'IPV4'|'DUALSTACK',
'OutpostArn': 'string',
'PreferredInstanceType': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
MaxResults (integer) --
The value that you specified for MaxResults in the request.
ResolverEndpoints (list) --
The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any.
(dict) --
In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, Updates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.
Id (string) --
The ID of the Resolver endpoint.
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver endpoint.
Name (string) --
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
SecurityGroupIds (list) --
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
(string) --
Direction (string) --
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
IpAddressCount (integer) --
The number of IP addresses that the Resolver endpoint can use for DNS queries.
HostVPCId (string) --
The ID of the VPC that you want to create the Resolver endpoint in.
Status (string) --
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
StatusMessage (string) --
A detailed description of the status of the Resolver endpoint.
CreationTime (string) --
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
ResolverEndpointType (string) --
The Resolver endpoint IP address type.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.
{'ResolverEndpoint': {'OutpostArn': 'string',
'PreferredInstanceType': 'string'}}
Updates the name, or enpoint type for an inbound or an outbound Resolver endpoint. You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can't be updated to other type.
See also: AWS API Documentation
Request Syntax
client.update_resolver_endpoint(
ResolverEndpointId='string',
Name='string',
ResolverEndpointType='IPV6'|'IPV4'|'DUALSTACK',
UpdateIpAddresses=[
{
'IpId': 'string',
'Ipv6': 'string'
},
]
)
string
[REQUIRED]
The ID of the Resolver endpoint that you want to update.
string
The name of the Resolver endpoint that you want to update.
string
Specifies the endpoint type for what type of IP address the endpoint uses to forward DNS queries.
Updating to IPV6 type isn't currently supported.
list
Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to dual-stack. If you don't specify an IPv6 address, one will be automatically chosen from your subnet.
(dict) --
Provides information about the IP address type in response to UpdateResolverEndpoint.
IpId (string) -- [REQUIRED]
The ID of the IP address, specified by the ResolverEndpointId.
Ipv6 (string) -- [REQUIRED]
The IPv6 address that you want to use for DNS queries.
dict
Response Syntax
{
'ResolverEndpoint': {
'Id': 'string',
'CreatorRequestId': 'string',
'Arn': 'string',
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'Direction': 'INBOUND'|'OUTBOUND',
'IpAddressCount': 123,
'HostVPCId': 'string',
'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
'StatusMessage': 'string',
'CreationTime': 'string',
'ModificationTime': 'string',
'ResolverEndpointType': 'IPV6'|'IPV4'|'DUALSTACK',
'OutpostArn': 'string',
'PreferredInstanceType': 'string'
}
}
Response Structure
(dict) --
ResolverEndpoint (dict) --
The response to an UpdateResolverEndpoint request.
Id (string) --
The ID of the Resolver endpoint.
CreatorRequestId (string) --
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Arn (string) --
The ARN (Amazon Resource Name) for the Resolver endpoint.
Name (string) --
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
SecurityGroupIds (list) --
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
(string) --
Direction (string) --
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
IpAddressCount (integer) --
The number of IP addresses that the Resolver endpoint can use for DNS queries.
HostVPCId (string) --
The ID of the VPC that you want to create the Resolver endpoint in.
Status (string) --
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
StatusMessage (string) --
A detailed description of the status of the Resolver endpoint.
CreationTime (string) --
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime (string) --
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
ResolverEndpointType (string) --
The Resolver endpoint IP address type.
OutpostArn (string) --
The ARN (Amazon Resource Name) for the Outpost.
PreferredInstanceType (string) --
The Amazon EC2 instance type.