2026/09/28 - Amazon Elastic Compute Cloud - 3 new 8 updated api methods
Changes API changes to AWS Client VPN to support device posture assessment and Cedar authorization policies
Deletes the authorization policy for a Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_client_vpn_endpoint_authorization_policy(
ClientVpnEndpointId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the Client VPN endpoint.
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.
dict
Response Syntax
{
'Status': 'creating'|'updating'|'active'|'failed'|'deleting'
}
Response Structure
(dict) --
Status (string) --
The current state of the authorization policy.
Describes the authorization policy for a Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
client.get_client_vpn_endpoint_authorization_policy(
ClientVpnEndpointId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the Client VPN endpoint.
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.
dict
Response Syntax
{
'ClientVpnEndpointId': 'string',
'PolicyDocument': 'string',
'Description': 'string',
'ShadowMode': 'enabled'|'disabled',
'Status': 'creating'|'updating'|'active'|'failed'|'deleting'
}
Response Structure
(dict) --
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
PolicyDocument (string) --
The authorization policy document, written in the Cedar policy language.
Description (string) --
A brief description of the authorization policy.
ShadowMode (string) --
Specifies whether the authorization policy is evaluated in shadow mode. Possible values include:
enabled - The authorization policy is evaluated and the results are logged, but access is not enforced.
disabled - The authorization policy is enforced.
Status (string) --
The current state of the authorization policy.
Creates or updates the authorization policy for a Client VPN endpoint. A Client VPN endpoint can have one authorization policy. If a policy already exists for the endpoint, the values that you specify replace the corresponding values in the existing policy, and values that you do not specify remain unchanged.
See also: AWS API Documentation
Request Syntax
client.modify_client_vpn_endpoint_authorization_policy(
ClientVpnEndpointId='string',
PolicyDocument='string',
Description='string',
ShadowMode='enabled'|'disabled',
ClientToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the Client VPN endpoint.
string
The authorization policy document, written in the Cedar policy language. This parameter is required when you create the authorization policy for a Client VPN endpoint that does not already have one.
string
A brief description of the authorization policy.
string
Specifies whether the authorization policy is evaluated in shadow mode. Possible values include:
enabled - The authorization policy is evaluated and the results are logged, but access is not enforced.
disabled - The authorization policy is enforced.
The default value is disabled.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
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.
dict
Response Syntax
{
'Status': 'creating'|'updating'|'active'|'failed'|'deleting'
}
Response Structure
(dict) --
Status (string) --
The current state of the authorization policy.
{'ConnectionLogOptions': {'IncludeAuthorizationPolicyContext': 'boolean'},
'DevicePostureOptions': {'Enabled': 'boolean',
'TrustProviders': [{'PublicSigningKeyUrl': 'string',
'TenantId': 'string',
'TrustProviderType': 'crowdstrike '
'| jamf | '
'jumpcloud'}]}}
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
See also: AWS API Documentation
Request Syntax
client.create_client_vpn_endpoint(
ClientCidrBlock='string',
ServerCertificateArn='string',
AuthenticationOptions=[
{
'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication',
'ActiveDirectory': {
'DirectoryId': 'string'
},
'MutualAuthentication': {
'ClientRootCertificateChainArn': 'string'
},
'FederatedAuthentication': {
'SAMLProviderArn': 'string',
'SelfServiceSAMLProviderArn': 'string'
}
},
],
ConnectionLogOptions={
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string',
'IncludeAuthorizationPolicyContext': True|False
},
DnsServers=[
'string',
],
TransportProtocol='tcp'|'udp',
VpnPort=123,
Description='string',
SplitTunnel=True|False,
DryRun=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'|'image-usage-report'|'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-metering-policy'|'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'|'vpc-encryption-control'|'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'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
SecurityGroupIds=[
'string',
],
VpcId='string',
SelfServicePortal='enabled'|'disabled',
ClientConnectOptions={
'Enabled': True|False,
'LambdaFunctionArn': 'string'
},
SessionTimeoutHours=123,
ClientLoginBannerOptions={
'Enabled': True|False,
'BannerText': 'string'
},
ClientRouteEnforcementOptions={
'Enforced': True|False
},
DisconnectOnSessionTimeout=True|False,
EndpointIpAddressType='ipv4'|'ipv6'|'dual-stack',
TrafficIpAddressType='ipv4'|'ipv6'|'dual-stack',
TransitGatewayConfiguration={
'TransitGatewayId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
]
},
DevicePostureOptions={
'TrustProviders': [
{
'TrustProviderType': 'crowdstrike'|'jamf'|'jumpcloud',
'TenantId': 'string',
'PublicSigningKeyUrl': 'string'
},
],
'Enabled': True|False
}
)
string
The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
string
[REQUIRED]
The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
list
[REQUIRED]
Information about the authentication method to be used to authenticate clients.
(dict) --
Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.
Type (string) --
The type of client authentication to be used.
ActiveDirectory (dict) --
Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
DirectoryId (string) --
The ID of the Active Directory to be used for authentication.
MutualAuthentication (dict) --
Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
ClientRootCertificateChainArn (string) --
The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in Certificate Manager (ACM).
FederatedAuthentication (dict) --
Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
SAMLProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider.
SelfServiceSAMLProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
dict
[REQUIRED]
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Enabled (boolean) --
Indicates whether connection logging is enabled.
CloudwatchLogGroup (string) --
The name of the CloudWatch Logs log group. Required if connection logging is enabled.
CloudwatchLogStream (string) --
The name of the CloudWatch Logs log stream to which the connection data is published.
IncludeAuthorizationPolicyContext (boolean) --
Specifies whether to include the authorization policy evaluation context in the connection logs for the Client VPN endpoint.
list
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
(string) --
string
The transport protocol to be used by the VPN session.
Default value: udp
integer
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
string
A brief description of the Client VPN endpoint.
boolean
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
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
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
list
The tags to apply to the Client VPN 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.
list
The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
(string) --
string
The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
string
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
dict
The options for managing connection authorization for new client connections.
Enabled (boolean) --
Indicates whether client connect options are enabled. The default is false (not enabled).
LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
integer
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
dict
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Enabled (boolean) --
Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Valid values: true | false
Default value: false
BannerText (string) --
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
dict
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
Enforced (boolean) --
Enable or disable Client Route Enforcement. The state can either be true (enabled) or false (disabled). The default is false.
Valid values: true | false
Default value: false
boolean
Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
string
The IP address type for the Client VPN endpoint. Valid values are ipv4 (default) for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing. When set to dual-stack, clients can connect to the endpoint using either IPv4 or IPv6 addresses..
string
The IP address type for traffic within the Client VPN tunnel. Valid values are ipv4 (default) for IPv4 traffic only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 traffic. When set to dual-stack, clients can access both IPv4 and IPv6 resources through the VPN .
dict
The Transit Gateway configuration for the Client VPN endpoint. Use this parameter to associate the endpoint with a Transit Gateway instead of a VPC. You cannot specify both TransitGatewayConfiguration and VpcId/ SecurityGroupIds.
TransitGatewayId (string) --
The ID of the Transit Gateway to associate with the Client VPN endpoint.
AvailabilityZones (list) --
The Availability Zone names for the Transit Gateway association. You can specify up to the maximum number of Availability Zones supported by the Transit Gateway. You cannot specify both AvailabilityZones and AvailabilityZoneIds.
(string) --
AvailabilityZoneIds (list) --
The Availability Zone IDs for the Transit Gateway association. You can specify up to the maximum number of Availability Zones supported by the Transit Gateway. You cannot specify both AvailabilityZones and AvailabilityZoneIds.
(string) --
dict
The device posture options for the Client VPN endpoint. Use this parameter to specify the device trust providers that the endpoint uses to evaluate the security posture of connecting devices.
TrustProviders (list) --
The device trust providers to configure for the Client VPN endpoint.
(dict) --
Describes a device trust provider to configure for a Client VPN endpoint.
TrustProviderType (string) --
The type of the device trust provider. Possible values include:
crowdstrike - CrowdStrike device trust provider.
jamf - Jamf device trust provider.
jumpcloud - JumpCloud device trust provider.
TenantId (string) --
The tenant ID associated with your device trust provider account.
PublicSigningKeyUrl (string) --
The URL of the public signing key that is used to verify the identity token issued by the device trust provider.
Enabled (boolean) --
Indicates whether device posture evaluation is enabled for the Client VPN endpoint. Specify false to disable device posture, which clears the configured device trust providers.
dict
Response Syntax
{
'ClientVpnEndpointId': 'string',
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted'|'pending',
'Message': 'string'
},
'DnsName': 'string'
}
Response Structure
(dict) --
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
pending - The Client VPN endpoint has been created with a Transit Gateway configuration and is waiting for the Transit Gateway attachment to be accepted. The Client VPN endpoint cannot accept connections.
Message (string) --
A message about the status of the Client VPN endpoint.
DnsName (string) --
The DNS name to be used by clients when establishing their VPN session.
{'Rir': {'nicbr'}}
Response {'IpamInternetRegistryAssociation': {'Rir': {'nicbr'},
'State': {'disable-complete',
'disable-failed',
'disable-in-progress'}}}
Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.
See also: AWS API Documentation
Request Syntax
client.create_ipam_internet_registry_association(
DryRun=True|False,
IpamId='string',
Rir='ripe'|'apnic'|'arin'|'lacnic'|'nicbr',
OrganizationHandle='string',
Description='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'|'image-usage-report'|'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-metering-policy'|'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'|'vpc-encryption-control'|'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'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check'|'capacity-reservation-modification-quote',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
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 IPAM to associate with the internet registry.
string
[REQUIRED]
The Regional Internet Registry to associate with. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
string
[REQUIRED]
The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID).
string
A description for the internet registry association.
list
The tags to assign to the internet registry association.
(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
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic'|'nicbr',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'disable-in-progress'|'disable-complete'|'disable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
StateMessage (string) --
A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(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.
{'IpamInternetRegistryAssociation': {'Rir': {'nicbr'},
'State': {'disable-complete',
'disable-failed',
'disable-in-progress'}}}
Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry.
See also: AWS API Documentation
Request Syntax
client.delete_ipam_internet_registry_association(
DryRun=True|False,
IpamInternetRegistryAssociationId='string'
)
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 IPAM internet registry association to delete.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic'|'nicbr',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'disable-in-progress'|'disable-complete'|'disable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the deleted internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
StateMessage (string) --
A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(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.
{'Connections': {'AuthorizationPolicyLastEvaluatedTime': 'string'}}
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
client.describe_client_vpn_connections(
ClientVpnEndpointId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123,
DryRun=True|False
)
string
[REQUIRED]
The ID of the Client VPN endpoint.
list
One or more filters. Filter names and values are case-sensitive.
connection-id - The ID of the connection.
username - For Active Directory client authentication, the user name of the client who established the client connection.
(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) --
string
The token to retrieve the next page of results.
integer
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
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.
dict
Response Syntax
{
'Connections': [
{
'ClientVpnEndpointId': 'string',
'Timestamp': 'string',
'ConnectionId': 'string',
'Username': 'string',
'ConnectionEstablishedTime': 'string',
'IngressBytes': 'string',
'EgressBytes': 'string',
'IngressPackets': 'string',
'EgressPackets': 'string',
'ClientIp': 'string',
'ClientIpv6Address': 'string',
'CommonName': 'string',
'Status': {
'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated',
'Message': 'string'
},
'ConnectionEndTime': 'string',
'PostureComplianceStatuses': [
'string',
],
'AuthorizationPolicyLastEvaluatedTime': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Connections (list) --
Information about the active and terminated client connections.
(dict) --
Describes a client connection.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint to which the client is connected.
Timestamp (string) --
The current date and time.
ConnectionId (string) --
The ID of the client connection.
Username (string) --
The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.
ConnectionEstablishedTime (string) --
The date and time the client connection was established.
IngressBytes (string) --
The number of bytes sent by the client.
EgressBytes (string) --
The number of bytes received by the client.
IngressPackets (string) --
The number of packets sent by the client.
EgressPackets (string) --
The number of packets received by the client.
ClientIp (string) --
The IP address of the client.
ClientIpv6Address (string) --
The IPv6 address assigned to the client connection when using a dual-stack Client VPN endpoint. This field is only populated when the endpoint is configured for dual-stack addressing, and the client is using IPv6 for connectivity.
CommonName (string) --
The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.
Status (dict) --
The current state of the client connection.
Code (string) --
The state of the client connection.
Message (string) --
A message about the status of the client connection, if applicable.
ConnectionEndTime (string) --
The date and time the client connection was terminated.
PostureComplianceStatuses (list) --
The statuses returned by the client connect handler for posture compliance, if applicable.
(string) --
AuthorizationPolicyLastEvaluatedTime (string) --
The date and time the authorization policy was last evaluated for the client connection, if applicable.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'ClientVpnEndpoints': {'ConnectionLogOptions': {'IncludeAuthorizationPolicyContext': 'boolean'},
'DevicePostureOptions': {'TrustProviders': [{'PublicSigningKeyUrl': 'string',
'TenantId': 'string',
'TrustProviderType': 'crowdstrike '
'| '
'jamf '
'| '
'jumpcloud'}]}}}
Describes one or more Client VPN endpoints in the account.
See also: AWS API Documentation
Request Syntax
client.describe_client_vpn_endpoints(
ClientVpnEndpointIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
list
The ID of the Client VPN endpoint.
(string) --
integer
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
string
The token to retrieve the next page of results.
list
One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint.
transport-protocol - The transport protocol ( tcp | udp).
(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) --
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.
dict
Response Syntax
{
'ClientVpnEndpoints': [
{
'ClientVpnEndpointId': 'string',
'Description': 'string',
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted'|'pending',
'Message': 'string'
},
'CreationTime': 'string',
'DeletionTime': 'string',
'DnsName': 'string',
'ClientCidrBlock': 'string',
'DnsServers': [
'string',
],
'SplitTunnel': True|False,
'VpnProtocol': 'openvpn',
'TransportProtocol': 'tcp'|'udp',
'VpnPort': 123,
'AssociatedTargetNetworks': [
{
'NetworkId': 'string',
'NetworkType': 'vpc'
},
],
'ServerCertificateArn': 'string',
'AuthenticationOptions': [
{
'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication',
'ActiveDirectory': {
'DirectoryId': 'string'
},
'MutualAuthentication': {
'ClientRootCertificateChain': 'string'
},
'FederatedAuthentication': {
'SamlProviderArn': 'string',
'SelfServiceSamlProviderArn': 'string'
}
},
],
'ConnectionLogOptions': {
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string',
'IncludeAuthorizationPolicyContext': True|False
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string',
'SelfServicePortalUrl': 'string',
'ClientConnectOptions': {
'Enabled': True|False,
'LambdaFunctionArn': 'string',
'Status': {
'Code': 'applying'|'applied',
'Message': 'string'
}
},
'SessionTimeoutHours': 123,
'ClientLoginBannerOptions': {
'Enabled': True|False,
'BannerText': 'string'
},
'ClientRouteEnforcementOptions': {
'Enforced': True|False
},
'DisconnectOnSessionTimeout': True|False,
'EndpointIpAddressType': 'ipv4'|'ipv6'|'dual-stack',
'TrafficIpAddressType': 'ipv4'|'ipv6'|'dual-stack',
'TransitGatewayConfiguration': {
'TransitGatewayId': 'string',
'TransitGatewayAttachmentId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
]
},
'DevicePostureOptions': {
'TrustProviders': [
{
'TrustProviderType': 'crowdstrike'|'jamf'|'jumpcloud',
'TenantId': 'string',
'PublicSigningKeyUrl': 'string'
},
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ClientVpnEndpoints (list) --
Information about the Client VPN endpoints.
(dict) --
Describes a Client VPN endpoint.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
Description (string) --
A brief description of the endpoint.
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
pending - The Client VPN endpoint has been created with a Transit Gateway configuration and is waiting for the Transit Gateway attachment to be accepted. The Client VPN endpoint cannot accept connections.
Message (string) --
A message about the status of the Client VPN endpoint.
CreationTime (string) --
The date and time the Client VPN endpoint was created.
DeletionTime (string) --
The date and time the Client VPN endpoint was deleted, if applicable.
DnsName (string) --
The DNS name to be used by clients when connecting to the Client VPN endpoint.
ClientCidrBlock (string) --
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
DnsServers (list) --
Information about the DNS servers to be used for DNS resolution.
(string) --
SplitTunnel (boolean) --
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
VpnProtocol (string) --
The protocol used by the VPN session.
TransportProtocol (string) --
The transport protocol used by the Client VPN endpoint.
VpnPort (integer) --
The port number for the Client VPN endpoint.
AssociatedTargetNetworks (list) --
Information about the associated target networks. A target network is a subnet in a VPC.
(dict) --
Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
NetworkId (string) --
The ID of the subnet.
NetworkType (string) --
The target network type.
ServerCertificateArn (string) --
The ARN of the server certificate.
AuthenticationOptions (list) --
Information about the authentication method used by the Client VPN endpoint.
(dict) --
Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.
Type (string) --
The authentication type used.
ActiveDirectory (dict) --
Information about the Active Directory, if applicable.
DirectoryId (string) --
The ID of the Active Directory used for authentication.
MutualAuthentication (dict) --
Information about the authentication certificates, if applicable.
ClientRootCertificateChain (string) --
The ARN of the client certificate.
FederatedAuthentication (dict) --
Information about the IAM SAML identity provider, if applicable.
SamlProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider.
SelfServiceSamlProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
ConnectionLogOptions (dict) --
Information about the client connection logging options for the Client VPN endpoint.
Enabled (boolean) --
Indicates whether client connection logging is enabled for the Client VPN endpoint.
CloudwatchLogGroup (string) --
The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
CloudwatchLogStream (string) --
The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
IncludeAuthorizationPolicyContext (boolean) --
Specifies whether the authorization policy evaluation context is included in the connection logs for the Client VPN endpoint.
Tags (list) --
Any tags assigned to the Client VPN 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.
SecurityGroupIds (list) --
The IDs of the security groups for the target network.
(string) --
VpcId (string) --
The ID of the VPC.
SelfServicePortalUrl (string) --
The URL of the self-service portal.
ClientConnectOptions (dict) --
The options for managing connection authorization for new client connections.
Enabled (boolean) --
Indicates whether client connect options are enabled.
LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
Status (dict) --
The status of any updates to the client connect options.
Code (string) --
The status code.
Message (string) --
The status message.
SessionTimeoutHours (integer) --
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
ClientLoginBannerOptions (dict) --
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Enabled (boolean) --
Current state of text banner feature.
Valid values: true | false
BannerText (string) --
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
ClientRouteEnforcementOptions (dict) --
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
Enforced (boolean) --
Status of the client route enforcement feature, indicating whether Client Route Enforcement is true (enabled) or false (disabled).
Valid values: true | false
Default value: false
DisconnectOnSessionTimeout (boolean) --
Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
EndpointIpAddressType (string) --
The IP address type of the Client VPN endpoint. Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or ``dual-stack ``for both IPv4 and IPv6 addressing.
TrafficIpAddressType (string) --
The IP address type of the Client VPN endpoint. Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
TransitGatewayConfiguration (dict) --
The Transit Gateway configuration for the Client VPN endpoint.
TransitGatewayId (string) --
The ID of the Transit Gateway.
TransitGatewayAttachmentId (string) --
The ID of the Transit Gateway attachment.
AvailabilityZones (list) --
The Availability Zone names for the Transit Gateway association.
(string) --
AvailabilityZoneIds (list) --
The Availability Zone IDs for the Transit Gateway association.
(string) --
DevicePostureOptions (dict) --
The device trust providers configured for the Client VPN endpoint, if applicable.
TrustProviders (list) --
The device trust providers configured for the Client VPN endpoint.
(dict) --
Information about a device trust provider configured for a Client VPN endpoint.
TrustProviderType (string) --
The type of the device trust provider. Possible values include:
crowdstrike - CrowdStrike device trust provider.
jamf - Jamf device trust provider.
jumpcloud - JumpCloud device trust provider.
TenantId (string) --
The tenant ID associated with your device trust provider account.
PublicSigningKeyUrl (string) --
The URL of the public signing key that is used to verify the identity token issued by the device trust provider.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'IpamInternetRegistryAssociations': {'Rir': {'nicbr'},
'State': {'disable-complete',
'disable-failed',
'disable-in-progress'}}}
Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.describe_ipam_internet_registry_associations(
DryRun=True|False,
IpamInternetRegistryAssociationIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
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.
list
The IDs of the internet registry associations to describe.
(string) --
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
list
One or more filters to apply to the results.
(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) --
dict
Response Syntax
{
'NextToken': 'string',
'IpamInternetRegistryAssociations': [
{
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic'|'nicbr',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'disable-in-progress'|'disable-complete'|'disable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results.
IpamInternetRegistryAssociations (list) --
The internet registry associations.
(dict) --
Contains information about an association between an IPAM and a Regional Internet Registry (RIR) for delegated RPKI management.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
StateMessage (string) --
A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(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.
{'IpamInternetRegistryAssociation': {'Rir': {'nicbr'},
'State': {'disable-complete',
'disable-failed',
'disable-in-progress'}}}
Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.
See also: AWS API Documentation
Request Syntax
client.enable_ipam_internet_registry_association(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
RpkiVersion='string',
ServiceUri='string',
ChildHandle='string',
ParentHandle='string',
ParentBpkiTa='string',
ClientToken='string'
)
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 IPAM internet registry association to enable.
string
[REQUIRED]
The RPKI version to use from the Parent Response XML.
string
[REQUIRED]
The RPKI service URI for the publication point from the Parent Response XML.
string
[REQUIRED]
The child handle for the BPKI certificate hierarchy from the Parent Response XML.
string
[REQUIRED]
The parent handle for the BPKI certificate hierarchy from the Parent Response XML.
string
[REQUIRED]
The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic'|'nicbr',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'disable-in-progress'|'disable-complete'|'disable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the enabled internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
StateMessage (string) --
A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(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.
{'ConnectionLogOptions': {'IncludeAuthorizationPolicyContext': 'boolean'},
'DevicePostureOptions': {'Enabled': 'boolean',
'TrustProviders': [{'PublicSigningKeyUrl': 'string',
'TenantId': 'string',
'TrustProviderType': 'crowdstrike '
'| jamf | '
'jumpcloud'}]}}
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
See also: AWS API Documentation
Request Syntax
client.modify_client_vpn_endpoint(
ClientVpnEndpointId='string',
ServerCertificateArn='string',
ConnectionLogOptions={
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string',
'IncludeAuthorizationPolicyContext': True|False
},
DnsServers={
'CustomDnsServers': [
'string',
],
'Enabled': True|False
},
VpnPort=123,
Description='string',
SplitTunnel=True|False,
DryRun=True|False,
SecurityGroupIds=[
'string',
],
VpcId='string',
SelfServicePortal='enabled'|'disabled',
ClientConnectOptions={
'Enabled': True|False,
'LambdaFunctionArn': 'string'
},
SessionTimeoutHours=123,
ClientLoginBannerOptions={
'Enabled': True|False,
'BannerText': 'string'
},
ClientRouteEnforcementOptions={
'Enforced': True|False
},
DisconnectOnSessionTimeout=True|False,
TransitGatewayConfiguration={
'TransitGatewayId': 'string',
'AvailabilityZones': [
'string',
],
'AvailabilityZoneIds': [
'string',
]
},
DevicePostureOptions={
'TrustProviders': [
{
'TrustProviderType': 'crowdstrike'|'jamf'|'jumpcloud',
'TenantId': 'string',
'PublicSigningKeyUrl': 'string'
},
],
'Enabled': True|False
}
)
string
[REQUIRED]
The ID of the Client VPN endpoint to modify.
string
The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).
dict
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Enabled (boolean) --
Indicates whether connection logging is enabled.
CloudwatchLogGroup (string) --
The name of the CloudWatch Logs log group. Required if connection logging is enabled.
CloudwatchLogStream (string) --
The name of the CloudWatch Logs log stream to which the connection data is published.
IncludeAuthorizationPolicyContext (boolean) --
Specifies whether to include the authorization policy evaluation context in the connection logs for the Client VPN endpoint.
dict
Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
CustomDnsServers (list) --
The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.
(string) --
Enabled (boolean) --
Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
integer
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
string
A brief description of the Client VPN endpoint.
boolean
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
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.
list
The IDs of one or more security groups to apply to the target network.
(string) --
string
The ID of the VPC to associate with the Client VPN endpoint.
string
Specify whether to enable the self-service portal for the Client VPN endpoint.
dict
The options for managing connection authorization for new client connections.
Enabled (boolean) --
Indicates whether client connect options are enabled. The default is false (not enabled).
LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
integer
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
dict
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Enabled (boolean) --
Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Valid values: true | false
Default value: false
BannerText (string) --
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
dict
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
Enforced (boolean) --
Enable or disable Client Route Enforcement. The state can either be true (enabled) or false (disabled). The default is false.
Valid values: true | false
Default value: false
boolean
Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
dict
The Transit Gateway configuration for the Client VPN endpoint. This option is currently not supported.
TransitGatewayId (string) --
The ID of the Transit Gateway to associate with the Client VPN endpoint.
AvailabilityZones (list) --
The Availability Zone names for the Transit Gateway association. You can specify up to the maximum number of Availability Zones supported by the Transit Gateway. You cannot specify both AvailabilityZones and AvailabilityZoneIds.
(string) --
AvailabilityZoneIds (list) --
The Availability Zone IDs for the Transit Gateway association. You can specify up to the maximum number of Availability Zones supported by the Transit Gateway. You cannot specify both AvailabilityZones and AvailabilityZoneIds.
(string) --
dict
The device posture options for the Client VPN endpoint. Specifying this parameter replaces the entire device posture configuration for the endpoint. To remove all device trust providers, specify an empty list.
TrustProviders (list) --
The device trust providers to configure for the Client VPN endpoint.
(dict) --
Describes a device trust provider to configure for a Client VPN endpoint.
TrustProviderType (string) --
The type of the device trust provider. Possible values include:
crowdstrike - CrowdStrike device trust provider.
jamf - Jamf device trust provider.
jumpcloud - JumpCloud device trust provider.
TenantId (string) --
The tenant ID associated with your device trust provider account.
PublicSigningKeyUrl (string) --
The URL of the public signing key that is used to verify the identity token issued by the device trust provider.
Enabled (boolean) --
Indicates whether device posture evaluation is enabled for the Client VPN endpoint. Specify false to disable device posture, which clears the configured device trust providers.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.