EC2 / Paginator / DescribeSecurityGroupVpcAssociations

DescribeSecurityGroupVpcAssociations

class EC2.Paginator.DescribeSecurityGroupVpcAssociations

paginator = client.get_paginator('describe_security_group_vpc_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_security_group_vpc_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  Security group VPC association filters.

  • group-id: The security group ID.

  • vpc-id: The ID of the associated VPC.

  • vpc-owner-id: The account ID of the VPC owner.

  • state: The state of the association.

  • tag:<key>: The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key: The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'SecurityGroupVpcAssociations': [
        {
            'GroupId': 'string',
            'VpcId': 'string',
            'VpcOwnerId': 'string',
            'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
            'StateReason': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • SecurityGroupVpcAssociations (list) –

    The security group VPC associations.

    • (dict) –

      A security group association with a VPC that you made with AssociateSecurityGroupVpc.

      • GroupId (string) –

        The association’s security group ID.

      • VpcId (string) –

        The association’s VPC ID.

      • VpcOwnerId (string) –

        The Amazon Web Services account ID of the owner of the VPC.

      • State (string) –

        The association’s state.

      • StateReason (string) –

        The association’s state reason.