Vpc / Collection / security_groups

security_groups#

EC2.Vpc.security_groups#

A collection of SecurityGroup resources.A SecurityGroup 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 SecurityGroup resources in the collection.

See also: AWS API Documentation

Request Syntax

security_group_iterator = vpc.security_groups.all()
Return type:

list(ec2.SecurityGroup)

Returns:

A list of SecurityGroup resources

filter(**kwargs)#

Creates an iterable of all SecurityGroup resources in the collection filtered by kwargs passed to method. A SecurityGroup 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

security_group_iterator = vpc.security_groups.filter(
    GroupIds=[
        'string',
    ],
    GroupNames=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    DryRun=True|False,

)
Parameters:

  • GroupIds (list) –

    The IDs of the security groups. Required for security groups in a nondefault VPC.

    Default: Describes all of your security groups.

    • (string) –

  • GroupNames (list) –

    [Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.

    Default: Describes all of your security groups.

    • (string) –

  • NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.

  • 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.SecurityGroup)

Returns:

A list of SecurityGroup resources

limit(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

security_group_iterator = vpc.security_groups.limit(
    count=123
)
Parameters:

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

Return type:

list(ec2.SecurityGroup)

Returns:

A list of SecurityGroup resources

page_size(**kwargs)#

Creates an iterable of all SecurityGroup 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

security_group_iterator = vpc.security_groups.page_size(
    count=123
)
Parameters:

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

Return type:

list(ec2.SecurityGroup)

Returns:

A list of SecurityGroup resources