AWS API Changes

2020/03/27 - AWS Global Accelerator - 5 updated api methods

Changes This update adds an event history to the ListByoipCidr API call. This enables you to see the changes that you've made for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

AdvertiseByoipCidr (updated)

Link ¶
Changes (response)

{'ByoipCidr': {'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}]}}

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'
)

type Cidr

string

param Cidr

[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.

rtype

dict

returns

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',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

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.
  - Events (list) --
    
    A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
    - (dict) --
      
      A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - Message (string) --
        
        A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - Timestamp (datetime) --
        
        A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

DeprovisionByoipCidr (updated)

Link ¶
Changes (response)

{'ByoipCidr': {'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}]}}

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'
)

type Cidr

string

param Cidr

[REQUIRED]

The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

rtype

dict

returns

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',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

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.
  - Events (list) --
    
    A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
    - (dict) --
      
      A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - Message (string) --
        
        A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - Timestamp (datetime) --
        
        A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

ListByoipCidrs (updated)

Link ¶
Changes (response)

{'ByoipCidrs': {'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}]}}

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.

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'
)

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

rtype

dict

returns

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',
            'Events': [
                {
                    'Message': 'string',
                    'Timestamp': datetime(2015, 1, 1)
                },
            ]
        },
    ],
    '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 address (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.
    - Events (list) --
      
      A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - (dict) --
        
        A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
        
        Message (string) --
        
        A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
        
        Timestamp (datetime) --
        
        A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
- NextToken (string) --
  
  The token for the next page of results.

ProvisionByoipCidr (updated)

Link ¶
Changes (response)

{'ByoipCidr': {'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}]}}

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'
    }
)

type Cidr

string

param Cidr

[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.

type CidrAuthorizationContext

dict

param CidrAuthorizationContext

[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.

rtype

dict

returns

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',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

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.
  - Events (list) --
    
    A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
    - (dict) --
      
      A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - Message (string) --
        
        A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - Timestamp (datetime) --
        
        A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

WithdrawByoipCidr (updated)

Link ¶
Changes (response)

{'ByoipCidr': {'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}]}}

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'
)

type Cidr

string

param Cidr

[REQUIRED]

The address range, in CIDR notation.

rtype

dict

returns

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',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

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.
  - Events (list) --
    
    A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
    - (dict) --
      
      A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - Message (string) --
        
        A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
      - Timestamp (datetime) --
        
        A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).