Instance / Collection / vpc_addresses

vpc_addresses#

EC2.Instance.vpc_addresses#

A collection of VpcAddress resources.A VpcAddress Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all VpcAddress resources in the collection.

See also: AWS API Documentation

Request Syntax

vpc_address_iterator = instance.vpc_addresses.all()
Return type:

list(ec2.VpcAddress)

Returns:

A list of VpcAddress resources

filter(**kwargs)#

Creates an iterable of all VpcAddress resources in the collection filtered by kwargs passed to method. A VpcAddress collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

vpc_address_iterator = instance.vpc_addresses.filter(
    PublicIps=[
        'string',
    ],
    AllocationIds=[
        'string',
    ],
    DryRun=True|False
)
Parameters:

  • PublicIps (list) –

    One or more Elastic IP addresses.

    Default: Describes all your Elastic IP addresses.

    • (string) –

  • AllocationIds (list) –

    [EC2-VPC] Information about the allocation IDs.

    • (string) –

  • DryRun (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.

Return type:

list(ec2.VpcAddress)

Returns:

A list of VpcAddress resources

limit(**kwargs)#

Creates an iterable up to a specified amount of VpcAddress resources in the collection.

See also: AWS API Documentation

Request Syntax

vpc_address_iterator = instance.vpc_addresses.limit(
    count=123
)
Parameters:

count (integer) – The limit to the number of resources in the iterable.

Return type:

list(ec2.VpcAddress)

Returns:

A list of VpcAddress resources

page_size(**kwargs)#

Creates an iterable of all VpcAddress resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

vpc_address_iterator = instance.vpc_addresses.page_size(
    count=123
)
Parameters:

count (integer) – The number of items returned by each service call

Return type:

list(ec2.VpcAddress)

Returns:

A list of VpcAddress resources