Table of Contents
A low-level client representing AWS Global Accelerator:
import boto3
client = boto3.client('globalaccelerator')
These are the available methods:
Check if an operation can be paginated.
Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to Example .
See also: AWS API Documentation
Request Syntax
response = client.create_accelerator(
Name='string',
IpAddressType='IPV4',
Enabled=True|False,
IdempotencyToken='string'
)
[REQUIRED]
The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.
dict
Response Syntax
{
'Accelerator': {
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'Status': 'DEPLOYED'|'IN_PROGRESS',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Accelerator (dict) --
The accelerator that is created by specifying a listener and the supported IP address types.
AcceleratorArn (string) --
The Amazon Resource Name (ARN) of the accelerator.
Name (string) --
The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
IpAddressType (string) --
The value for the address type must be IPv4.
Enabled (boolean) --
Indicates whether theaccelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets (list) --
IP address set associated with the accelerator.
(dict) --
A complex type for the set of IP addresses for an accelerator.
IpFamily (string) --
The types of IP addresses included in this IP set.
IpAddresses (list) --
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
Status (string) --
Describes the deployment status of the accelerator.
CreatedTime (datetime) --
The date and time that the accelerator was created.
LastModifiedTime (datetime) --
The date and time that the accelerator was last modified.
Create an endpoint group for the specified accelerator. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example .
See also: AWS API Documentation
Request Syntax
response = client.create_endpoint_group(
ListenerArn='string',
EndpointGroupRegion='string',
EndpointConfigurations=[
{
'EndpointId': 'string',
'Weight': 123
},
],
TrafficDialPercentage=...,
HealthCheckPort=123,
HealthCheckProtocol='TCP'|'HTTP'|'HTTPS',
HealthCheckPath='string',
HealthCheckIntervalSeconds=123,
ThresholdCount=123,
IdempotencyToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
[REQUIRED]
The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
The list of endpoint objects.
A complex type for endpoints.
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
dict
Response Syntax
{
'EndpointGroup': {
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string'
},
],
'TrafficDialPercentage': ...,
'HealthCheckPort': 123,
'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
'HealthCheckPath': 'string',
'HealthCheckIntervalSeconds': 123,
'ThresholdCount': 123
}
}
Response Structure
(dict) --
EndpointGroup (dict) --
The information about the endpoint group that was created.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region that this endpoint group belongs.
EndpointDescriptions (list) --
The list of endpoint objects.
(dict) --
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
EndpointId (string) --
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy , the reason code can be one of the following values:
If the endpoint state is initial , the reason code can be one of the following values:
TrafficDialPercentage (float) --
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
HealthCheckPort (integer) --
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
HealthCheckProtocol (string) --
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
HealthCheckPath (string) --
If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
HealthCheckIntervalSeconds (integer) --
The elapsed time, in seconds, between health checks for each endpoint. The default value is 30.
ThresholdCount (integer) --
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. To see an AWS CLI example of creating a listener, scroll down to Example .
See also: AWS API Documentation
Request Syntax
response = client.create_listener(
AcceleratorArn='string',
PortRanges=[
{
'FromPort': 123,
'ToPort': 123
},
],
Protocol='TCP'|'UDP',
ClientAffinity='NONE'|'SOURCE_IP',
IdempotencyToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of your accelerator.
[REQUIRED]
The list of port ranges to support for connections from clients to your accelerator.
A complex type for a range of ports for a listener.
The first port in the range of ports, inclusive.
The last port in the range of ports, inclusive.
[REQUIRED]
The protocol for connections from clients to your accelerator.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.
AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE , Global Accelerator uses the "five-tuple" (5-tuple) properties—client IP address, client port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to CLIENT_IP instead. When you use the CLIENT_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— client IP address and destination IP address—to select the hash value. For UDP, Global Accelerator always uses two-tuple properties to select the hash value.
The default value is NONE .
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
dict
Response Syntax
{
'Listener': {
'ListenerArn': 'string',
'PortRanges': [
{
'FromPort': 123,
'ToPort': 123
},
],
'Protocol': 'TCP'|'UDP',
'ClientAffinity': 'NONE'|'SOURCE_IP'
}
}
Response Structure
(dict) --
Listener (dict) --
The listener that you've created.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
PortRanges (list) --
The list of port ranges for the connections from clients to the accelerator.
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
Protocol (string) --
The protocol for the connections from clients to the accelerator.
ClientAffinity (string) --
The client properties that Global Accelerator uses to select an endpoint so that you can choose to route traffic from users to their original endpoint. The default value is NONE .
Delete an accelerator. Note: before you can delete an accelerator, you must disable it.
See also: AWS API Documentation
Request Syntax
response = client.delete_accelerator(
AcceleratorArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of an accelerator.
Delete an endpoint group from a listener.
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint_group(
EndpointGroupArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group to delete.
Delete a listener from an accelerator.
See also: AWS API Documentation
Request Syntax
response = client.delete_listener(
ListenerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example .
See also: AWS API Documentation
Request Syntax
response = client.describe_accelerator(
AcceleratorArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator to describe.
{
'Accelerator': {
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'Status': 'DEPLOYED'|'IN_PROGRESS',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
Response Structure
The description of the accelerator.
The Amazon Resource Name (ARN) of the accelerator.
The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
The value for the address type must be IPv4.
Indicates whether theaccelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IP address set associated with the accelerator.
A complex type for the set of IP addresses for an accelerator.
The types of IP addresses included in this IP set.
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
Describes the deployment status of the accelerator.
The date and time that the accelerator was created.
The date and time that the accelerator was last modified.
Describe the attributes of an accelerator.
See also: AWS API Documentation
Request Syntax
response = client.describe_accelerator_attributes(
AcceleratorArn='string'
)
{
'AcceleratorAttributes': {
'FlowLogsEnabled': True|False,
'FlowLogsS3Bucket': 'string',
'FlowLogsS3Prefix': 'string'
}
}
Response Structure
The attributes of the accelerator.
Indicates whether flow logs are enabled. The value is true or false. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
The name of the Amazon S3 bucket for the flow logs. This attribute is required if flow logs are enabled. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
The prefix for the location in the Amazon S3 bucket for the flow logs. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.
Describe an endpoint group.
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoint_group(
EndpointGroupArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group to describe.
{
'EndpointGroup': {
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string'
},
],
'TrafficDialPercentage': ...,
'HealthCheckPort': 123,
'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
'HealthCheckPath': 'string',
'HealthCheckIntervalSeconds': 123,
'ThresholdCount': 123
}
}
Response Structure
The description of an endpoint group.
The Amazon Resource Name (ARN) of the endpoint group.
The AWS Region that this endpoint group belongs.
The list of endpoint objects.
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .
The health status of the endpoint.
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy , the reason code can be one of the following values:
If the endpoint state is initial , the reason code can be one of the following values:
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
The elapsed time, in seconds, between health checks for each endpoint. The default value is 30.
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
Describe a listener.
See also: AWS API Documentation
Request Syntax
response = client.describe_listener(
ListenerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener to describe.
{
'Listener': {
'ListenerArn': 'string',
'PortRanges': [
{
'FromPort': 123,
'ToPort': 123
},
],
'Protocol': 'TCP'|'UDP',
'ClientAffinity': 'NONE'|'SOURCE_IP'
}
}
Response Structure
The description of a listener.
The Amazon Resource Name (ARN) of the listener.
The list of port ranges for the connections from clients to the accelerator.
A complex type for a range of ports for a listener.
The first port in the range of ports, inclusive.
The last port in the range of ports, inclusive.
The protocol for the connections from clients to the accelerator.
The client properties that Global Accelerator uses to select an endpoint so that you can choose to route traffic from users to their original endpoint. The default value is NONE .
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
List the accelerators for an AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_accelerators(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Accelerators': [
{
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'Status': 'DEPLOYED'|'IN_PROGRESS',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Accelerators (list) --
The list of accelerators for a customer account.
(dict) --
An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.
AcceleratorArn (string) --
The Amazon Resource Name (ARN) of the accelerator.
Name (string) --
The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
IpAddressType (string) --
The value for the address type must be IPv4.
Enabled (boolean) --
Indicates whether theaccelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets (list) --
IP address set associated with the accelerator.
(dict) --
A complex type for the set of IP addresses for an accelerator.
IpFamily (string) --
The types of IP addresses included in this IP set.
IpAddresses (list) --
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
Status (string) --
Describes the deployment status of the accelerator.
CreatedTime (datetime) --
The date and time that the accelerator was created.
LastModifiedTime (datetime) --
The date and time that the accelerator was last modified.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
List the endpoint groups that are associated with a listener.
See also: AWS API Documentation
Request Syntax
response = client.list_endpoint_groups(
ListenerArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
dict
Response Syntax
{
'EndpointGroups': [
{
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string'
},
],
'TrafficDialPercentage': ...,
'HealthCheckPort': 123,
'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
'HealthCheckPath': 'string',
'HealthCheckIntervalSeconds': 123,
'ThresholdCount': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EndpointGroups (list) --
The list of the endpoint groups associated with a listener.
(dict) --
A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region that this endpoint group belongs.
EndpointDescriptions (list) --
The list of endpoint objects.
(dict) --
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
EndpointId (string) --
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy , the reason code can be one of the following values:
If the endpoint state is initial , the reason code can be one of the following values:
TrafficDialPercentage (float) --
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
HealthCheckPort (integer) --
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
HealthCheckProtocol (string) --
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
HealthCheckPath (string) --
If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
HealthCheckIntervalSeconds (integer) --
The elapsed time, in seconds, between health checks for each endpoint. The default value is 30.
ThresholdCount (integer) --
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
List the listeners for an accelerator.
See also: AWS API Documentation
Request Syntax
response = client.list_listeners(
AcceleratorArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'PortRanges': [
{
'FromPort': 123,
'ToPort': 123
},
],
'Protocol': 'TCP'|'UDP',
'ClientAffinity': 'NONE'|'SOURCE_IP'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Listeners (list) --
The list of listeners for an accelerator.
(dict) --
A complex type for a listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
PortRanges (list) --
The list of port ranges for the connections from clients to the accelerator.
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
Protocol (string) --
The protocol for the connections from clients to the accelerator.
ClientAffinity (string) --
The client properties that Global Accelerator uses to select an endpoint so that you can choose to route traffic from users to their original endpoint. The default value is NONE .
NextToken (string) --
The token for the next set of results. You receive this token from a previous call.
Update an accelerator.
See also: AWS API Documentation
Request Syntax
response = client.update_accelerator(
AcceleratorArn='string',
Name='string',
IpAddressType='IPV4',
Enabled=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator to update.
Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
dict
Response Syntax
{
'Accelerator': {
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'Status': 'DEPLOYED'|'IN_PROGRESS',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Accelerator (dict) --
Information about the updated accelerator.
AcceleratorArn (string) --
The Amazon Resource Name (ARN) of the accelerator.
Name (string) --
The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
IpAddressType (string) --
The value for the address type must be IPv4.
Enabled (boolean) --
Indicates whether theaccelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets (list) --
IP address set associated with the accelerator.
(dict) --
A complex type for the set of IP addresses for an accelerator.
IpFamily (string) --
The types of IP addresses included in this IP set.
IpAddresses (list) --
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
Status (string) --
Describes the deployment status of the accelerator.
CreatedTime (datetime) --
The date and time that the accelerator was created.
LastModifiedTime (datetime) --
The date and time that the accelerator was last modified.
Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example .
See also: AWS API Documentation
Request Syntax
response = client.update_accelerator_attributes(
AcceleratorArn='string',
FlowLogsEnabled=True|False,
FlowLogsS3Bucket='string',
FlowLogsS3Prefix='string'
)
dict
Response Syntax
{
'AcceleratorAttributes': {
'FlowLogsEnabled': True|False,
'FlowLogsS3Bucket': 'string',
'FlowLogsS3Prefix': 'string'
}
}
Response Structure
(dict) --
AcceleratorAttributes (dict) --
Updated attributes for the accelerator.
FlowLogsEnabled (boolean) --
Indicates whether flow logs are enabled. The value is true or false. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
FlowLogsS3Bucket (string) --
The name of the Amazon S3 bucket for the flow logs. This attribute is required if flow logs are enabled. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
FlowLogsS3Prefix (string) --
The prefix for the location in the Amazon S3 bucket for the flow logs. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.
Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example .
See also: AWS API Documentation
Request Syntax
response = client.update_endpoint_group(
EndpointGroupArn='string',
EndpointConfigurations=[
{
'EndpointId': 'string',
'Weight': 123
},
],
TrafficDialPercentage=...,
HealthCheckPort=123,
HealthCheckProtocol='TCP'|'HTTP'|'HTTPS',
HealthCheckPath='string',
HealthCheckIntervalSeconds=123,
ThresholdCount=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the endpoint group.
The list of endpoint objects.
A complex type for endpoints.
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
dict
Response Syntax
{
'EndpointGroup': {
'EndpointGroupArn': 'string',
'EndpointGroupRegion': 'string',
'EndpointDescriptions': [
{
'EndpointId': 'string',
'Weight': 123,
'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
'HealthReason': 'string'
},
],
'TrafficDialPercentage': ...,
'HealthCheckPort': 123,
'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
'HealthCheckPath': 'string',
'HealthCheckIntervalSeconds': 123,
'ThresholdCount': 123
}
}
Response Structure
(dict) --
EndpointGroup (dict) --
The information about the endpoint group that was updated.
EndpointGroupArn (string) --
The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroupRegion (string) --
The AWS Region that this endpoint group belongs.
EndpointDescriptions (list) --
The list of endpoint objects.
(dict) --
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
EndpointId (string) --
An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.
Weight (integer) --
The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .
HealthState (string) --
The health status of the endpoint.
HealthReason (string) --
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy , the reason code can be one of the following values:
If the endpoint state is initial , the reason code can be one of the following values:
TrafficDialPercentage (float) --
The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
HealthCheckPort (integer) --
The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
HealthCheckProtocol (string) --
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
HealthCheckPath (string) --
If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
HealthCheckIntervalSeconds (integer) --
The elapsed time, in seconds, between health checks for each endpoint. The default value is 30.
ThresholdCount (integer) --
The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
Update a listener.
See also: AWS API Documentation
Request Syntax
response = client.update_listener(
ListenerArn='string',
PortRanges=[
{
'FromPort': 123,
'ToPort': 123
},
],
Protocol='TCP'|'UDP',
ClientAffinity='NONE'|'SOURCE_IP'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener to update.
The updated list of port ranges for the connections from clients to the accelerator.
A complex type for a range of ports for a listener.
The first port in the range of ports, inclusive.
The last port in the range of ports, inclusive.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the source port and protocol of the user request. This gives you control over whether and how to maintain client affinity to a given endpoint.
The default value is NONE .
dict
Response Syntax
{
'Listener': {
'ListenerArn': 'string',
'PortRanges': [
{
'FromPort': 123,
'ToPort': 123
},
],
'Protocol': 'TCP'|'UDP',
'ClientAffinity': 'NONE'|'SOURCE_IP'
}
}
Response Structure
(dict) --
Listener (dict) --
Information for the updated listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
PortRanges (list) --
The list of port ranges for the connections from clients to the accelerator.
(dict) --
A complex type for a range of ports for a listener.
FromPort (integer) --
The first port in the range of ports, inclusive.
ToPort (integer) --
The last port in the range of ports, inclusive.
Protocol (string) --
The protocol for the connections from clients to the accelerator.
ClientAffinity (string) --
The client properties that Global Accelerator uses to select an endpoint so that you can choose to route traffic from users to their original endpoint. The default value is NONE .
The available paginators are: