2025/08/14 - Amazon Elastic Compute Cloud - 1 new3 updated api methods
Changes This release adds ModifyInstanceConnectEndpoint API to update configurations on existing EC2 Instance Connect Endpoints and improves IPv6 support through dualstack DNS names for EC2 Instance Connect Endpoints.
Modifies the specified EC2 Instance Connect Endpoint.
For more information, see Modify an EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.modify_instance_connect_endpoint(
DryRun=True|False,
InstanceConnectEndpointId='string',
IpAddressType='ipv4'|'dualstack'|'ipv6',
SecurityGroupIds=[
'string',
],
PreserveClientIp=True|False
)
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the EC2 Instance Connect Endpoint to modify.
string
The new IP address type for the EC2 Instance Connect Endpoint.
list
Changes the security groups for the EC2 Instance Connect Endpoint. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
(string) --
boolean
Indicates whether the client IP address is preserved as the source. The following are the possible values.
true - Use the client IP address as the source.
false - Use the network interface IP address as the source.
Default: false
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
{'InstanceConnectEndpoint': {'PublicDnsNames': {'Dualstack': {'DnsName': 'string',
'FipsDnsName': 'string'},
'Ipv4': {'DnsName': 'string',
'FipsDnsName': 'string'}},
'State': {'update-complete',
'update-failed',
'update-in-progress'}}}
Creates an EC2 Instance Connect Endpoint.
An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 or public IPv6 address. For more information, see Connect to your instances using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.create_instance_connect_endpoint(
DryRun=True|False,
SubnetId='string',
SecurityGroupIds=[
'string',
],
PreserveClientIp=True|False,
ClientToken='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
IpAddressType='ipv4'|'dualstack'|'ipv6'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
list
One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.
(string) --
boolean
Indicates whether the client IP address is preserved as the source. The following are the possible values.
true - Use the client IP address as the source.
false - Use the network interface IP address as the source.
Default: false
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
list
The tags to apply to the EC2 Instance Connect Endpoint during creation.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
string
The IP address type of the endpoint.
If no value is specified, the default value is determined by the IP address type of the subnet:
dualstack - If the subnet has both IPv4 and IPv6 CIDRs
ipv4 - If the subnet has only IPv4 CIDRs
ipv6 - If the subnet has only IPv6 CIDRs
dict
Response Syntax
{
'InstanceConnectEndpoint': {
'OwnerId': 'string',
'InstanceConnectEndpointId': 'string',
'InstanceConnectEndpointArn': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'update-in-progress'|'update-complete'|'update-failed',
'StateMessage': 'string',
'DnsName': 'string',
'FipsDnsName': 'string',
'NetworkInterfaceIds': [
'string',
],
'VpcId': 'string',
'AvailabilityZone': 'string',
'CreatedAt': datetime(2015, 1, 1),
'SubnetId': 'string',
'PreserveClientIp': True|False,
'SecurityGroupIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
'PublicDnsNames': {
'Ipv4': {
'DnsName': 'string',
'FipsDnsName': 'string'
},
'Dualstack': {
'DnsName': 'string',
'FipsDnsName': 'string'
}
}
},
'ClientToken': 'string'
}
Response Structure
(dict) --
InstanceConnectEndpoint (dict) --
Information about the EC2 Instance Connect Endpoint.
OwnerId (string) --
The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.
InstanceConnectEndpointId (string) --
The ID of the EC2 Instance Connect Endpoint.
InstanceConnectEndpointArn (string) --
The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.
State (string) --
The current state of the EC2 Instance Connect Endpoint.
StateMessage (string) --
The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
NetworkInterfaceIds (list) --
The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.
(string) --
VpcId (string) --
The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
AvailabilityZone (string) --
The Availability Zone of the EC2 Instance Connect Endpoint.
CreatedAt (datetime) --
The date and time that the EC2 Instance Connect Endpoint was created.
SubnetId (string) --
The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
PreserveClientIp (boolean) --
Indicates whether your client's IP address is preserved as the source. The value is true or false.
If true, your client's IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true
SecurityGroupIds (list) --
The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.
(string) --
Tags (list) --
The tags assigned to the EC2 Instance Connect Endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
IpAddressType (string) --
The IP address type of the endpoint.
PublicDnsNames (dict) --
The public DNS names of the endpoint.
Ipv4 (dict) --
The IPv4-only DNS name of the EC2 Instance Connect Endpoint.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
Dualstack (dict) --
The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
ClientToken (string) --
Unique, case-sensitive idempotency token provided by the client in the the request.
{'InstanceConnectEndpoint': {'PublicDnsNames': {'Dualstack': {'DnsName': 'string',
'FipsDnsName': 'string'},
'Ipv4': {'DnsName': 'string',
'FipsDnsName': 'string'}},
'State': {'update-complete',
'update-failed',
'update-in-progress'}}}
Deletes the specified EC2 Instance Connect Endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_instance_connect_endpoint(
DryRun=True|False,
InstanceConnectEndpointId='string'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the EC2 Instance Connect Endpoint to delete.
dict
Response Syntax
{
'InstanceConnectEndpoint': {
'OwnerId': 'string',
'InstanceConnectEndpointId': 'string',
'InstanceConnectEndpointArn': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'update-in-progress'|'update-complete'|'update-failed',
'StateMessage': 'string',
'DnsName': 'string',
'FipsDnsName': 'string',
'NetworkInterfaceIds': [
'string',
],
'VpcId': 'string',
'AvailabilityZone': 'string',
'CreatedAt': datetime(2015, 1, 1),
'SubnetId': 'string',
'PreserveClientIp': True|False,
'SecurityGroupIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
'PublicDnsNames': {
'Ipv4': {
'DnsName': 'string',
'FipsDnsName': 'string'
},
'Dualstack': {
'DnsName': 'string',
'FipsDnsName': 'string'
}
}
}
}
Response Structure
(dict) --
InstanceConnectEndpoint (dict) --
Information about the EC2 Instance Connect Endpoint.
OwnerId (string) --
The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.
InstanceConnectEndpointId (string) --
The ID of the EC2 Instance Connect Endpoint.
InstanceConnectEndpointArn (string) --
The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.
State (string) --
The current state of the EC2 Instance Connect Endpoint.
StateMessage (string) --
The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
NetworkInterfaceIds (list) --
The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.
(string) --
VpcId (string) --
The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
AvailabilityZone (string) --
The Availability Zone of the EC2 Instance Connect Endpoint.
CreatedAt (datetime) --
The date and time that the EC2 Instance Connect Endpoint was created.
SubnetId (string) --
The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
PreserveClientIp (boolean) --
Indicates whether your client's IP address is preserved as the source. The value is true or false.
If true, your client's IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true
SecurityGroupIds (list) --
The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.
(string) --
Tags (list) --
The tags assigned to the EC2 Instance Connect Endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
IpAddressType (string) --
The IP address type of the endpoint.
PublicDnsNames (dict) --
The public DNS names of the endpoint.
Ipv4 (dict) --
The IPv4-only DNS name of the EC2 Instance Connect Endpoint.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
Dualstack (dict) --
The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
{'InstanceConnectEndpoints': {'PublicDnsNames': {'Dualstack': {'DnsName': 'string',
'FipsDnsName': 'string'},
'Ipv4': {'DnsName': 'string',
'FipsDnsName': 'string'}},
'State': {'update-complete',
'update-failed',
'update-in-progress'}}}
Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.
See also: AWS API Documentation
Request Syntax
client.describe_instance_connect_endpoints(
DryRun=True|False,
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceConnectEndpointIds=[
'string',
]
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
list
One or more filters.
instance-connect-endpoint-id - The ID of the EC2 Instance Connect Endpoint.
state - The state of the EC2 Instance Connect Endpoint ( create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).
subnet-id - The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key.
vpc-id - The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
list
One or more EC2 Instance Connect Endpoint IDs.
(string) --
dict
Response Syntax
{
'InstanceConnectEndpoints': [
{
'OwnerId': 'string',
'InstanceConnectEndpointId': 'string',
'InstanceConnectEndpointArn': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'update-in-progress'|'update-complete'|'update-failed',
'StateMessage': 'string',
'DnsName': 'string',
'FipsDnsName': 'string',
'NetworkInterfaceIds': [
'string',
],
'VpcId': 'string',
'AvailabilityZone': 'string',
'CreatedAt': datetime(2015, 1, 1),
'SubnetId': 'string',
'PreserveClientIp': True|False,
'SecurityGroupIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddressType': 'ipv4'|'dualstack'|'ipv6',
'PublicDnsNames': {
'Ipv4': {
'DnsName': 'string',
'FipsDnsName': 'string'
},
'Dualstack': {
'DnsName': 'string',
'FipsDnsName': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceConnectEndpoints (list) --
Information about the EC2 Instance Connect Endpoints.
(dict) --
The EC2 Instance Connect Endpoint.
OwnerId (string) --
The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.
InstanceConnectEndpointId (string) --
The ID of the EC2 Instance Connect Endpoint.
InstanceConnectEndpointArn (string) --
The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.
State (string) --
The current state of the EC2 Instance Connect Endpoint.
StateMessage (string) --
The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
NetworkInterfaceIds (list) --
The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.
(string) --
VpcId (string) --
The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
AvailabilityZone (string) --
The Availability Zone of the EC2 Instance Connect Endpoint.
CreatedAt (datetime) --
The date and time that the EC2 Instance Connect Endpoint was created.
SubnetId (string) --
The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
PreserveClientIp (boolean) --
Indicates whether your client's IP address is preserved as the source. The value is true or false.
If true, your client's IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true
SecurityGroupIds (list) --
The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.
(string) --
Tags (list) --
The tags assigned to the EC2 Instance Connect Endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
IpAddressType (string) --
The IP address type of the endpoint.
PublicDnsNames (dict) --
The public DNS names of the endpoint.
Ipv4 (dict) --
The IPv4-only DNS name of the EC2 Instance Connect Endpoint.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
Dualstack (dict) --
The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
DnsName (string) --
The DNS name of the EC2 Instance Connect Endpoint.
FipsDnsName (string) --
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.