2020/02/27 - AWS Global Accelerator - 8 new1 updated api methods
Changes Update globalaccelerator client to latest version
Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to AWS because of propagation delays. To see an AWS CLI example of advertising an address range, scroll down to Example.
To stop advertising the BYOIP address range, use WithdrawByoipCidr.
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.advertise_byoip_cidr(
Cidr='string'
)
string
[REQUIRED]
The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
State (string) --
The state of the address pool.
Add tags to an accelerator resource. To see an AWS CLI example of adding tags to an accelerator, scroll down to Example.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.
list
[REQUIRED]
The tags to add to a resource. A tag consists of a key and a value that you define.
(dict) --
A complex type that contains a Tag key and Tag value.
Key (string) -- [REQUIRED]
A string that contains a Tag key.
Value (string) -- [REQUIRED]
A string that contains a Tag value.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr.
To see an AWS CLI example of listing BYOIP CIDR addresses, scroll down to Example.
See also: AWS API Documentation
Request Syntax
client.list_byoip_cidrs(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'ByoipCidrs': [
{
'Cidr': 'string',
'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ByoipCidrs (list) --
Information about your address ranges.
(dict) --
Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
The following describes each BYOIP State that your IP address range can be in.
PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.
READY — The address range is provisioned with AWS Global Accelerator and can be advertised.
PENDING_ADVERTISING — You’ve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.
ADVERTISING — The address range is being advertised by AWS Global Accelerator.
PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.
PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.
DEPROVISIONED — The address range is deprovisioned from AWS Global Accelerator.
FAILED_PROVISION — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_ADVERTISING — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_WITHDRAW — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_DEPROVISION — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
Cidr (string) --
The address range, in CIDR notation.
State (string) --
The state of the address pool.
NextToken (string) --
The token for the next page of results.
List all tags for an accelerator. To see an AWS CLI example of listing tags for an accelerator, scroll down to Example.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
Root level tag for the Tags parameters.
(dict) --
A complex type that contains a Tag key and Tag value.
Key (string) --
A string that contains a Tag key.
Value (string) --
A string that contains a Tag value.
Releases the specified address range that you provisioned to use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. To see an AWS CLI example of deprovisioning an address range, scroll down to Example.
Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range.
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.deprovision_byoip_cidr(
Cidr='string'
)
string
[REQUIRED]
The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
State (string) --
The state of the address pool.
Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. To see an AWS CLI example of withdrawing an address range for BYOIP so it will no longer be advertised by AWS, scroll down to Example.
It can take a few minutes before traffic to the specified addresses stops routing to AWS because of propagation delays.
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.withdraw_byoip_cidr(
Cidr='string'
)
string
[REQUIRED]
The address range, in CIDR notation.
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address pool.
Cidr (string) --
The address range, in CIDR notation.
State (string) --
The state of the address pool.
Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. To see an AWS CLI example of removing tags from an accelerator, scroll down to Example. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.
list
[REQUIRED]
The tag key pairs that you want to remove from the specified resources.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Provisions an IP address range to use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
To see an AWS CLI example of provisioning an address range for BYOIP, scroll down to Example.
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
See also: AWS API Documentation
Request Syntax
client.provision_byoip_cidr(
Cidr='string',
CidrAuthorizationContext={
'Message': 'string',
'Signature': 'string'
}
)
string
[REQUIRED]
The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this or another Region.
dict
[REQUIRED]
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Message (string) -- [REQUIRED]
The plain-text authorization message for the prefix and account.
Signature (string) -- [REQUIRED]
The signed authorization message for the prefix and account.
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
State (string) --
The state of the address pool.
{'IpAddresses': ['string'], 'Tags': [{'Key': 'string', 'Value': 'string'}]}
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.
If you bring your own IP address ranges to AWS Global Accelerator (BYOIP), you can assign IP addresses from your own pool to your accelerator as the static IP address entry points. Only one IP address from each of your IP address ranges can be used for each accelerator.
See also: AWS API Documentation
Request Syntax
client.create_accelerator(
Name='string',
IpAddressType='IPV4',
IpAddresses=[
'string',
],
Enabled=True|False,
IdempotencyToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
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.
string
The value for the address type must be IPv4.
list
Optionally, if you've added your own IP address pool to Global Accelerator, you can choose IP addresses from your own pool to use for the accelerator's static IP addresses. You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.
If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
(string) --
boolean
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.
string
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.
This field is autopopulated if not provided.
list
Create tags for an accelerator.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
(dict) --
A complex type that contains a Tag key and Tag value.
Key (string) -- [REQUIRED]
A string that contains a Tag key.
Value (string) -- [REQUIRED]
A string that contains a Tag value.
dict
Response Syntax
{
'Accelerator': {
'AcceleratorArn': 'string',
'Name': 'string',
'IpAddressType': 'IPV4',
'Enabled': True|False,
'IpSets': [
{
'IpFamily': 'string',
'IpAddresses': [
'string',
]
},
],
'DnsName': '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 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 the 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, accelerator can be deleted.
IpSets (list) --
The static IP addresses that Global Accelerator associates 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.
(string) --
DnsName (string) --
The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.
The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.
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.