EC2 / Client / get_security_groups_for_vpc

get_security_groups_for_vpc

EC2.Client.get_security_groups_for_vpc(**kwargs)

Gets security groups that can be associated by the Amazon Web Services account making the request with network interfaces in the specified VPC.

See also: AWS API Documentation

Request Syntax

response = client.get_security_groups_for_vpc(
    VpcId='string',
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

• VpcId (string) –

  [REQUIRED]

  The VPC ID where the security group can be used.

• 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. For more information, see Pagination.

• Filters (list) –

  The filters. If using multiple filters, the results include security groups which match all filters.

  • group-id: The security group ID.

  • description: The security group’s description.

  • group-name: The security group name.

  • owner-id: The security group owner ID.

  • primary-vpc-id: The VPC ID in which the security group was created.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'SecurityGroupForVpcs': [
        {
            'Description': 'string',
            'GroupName': 'string',
            'OwnerId': 'string',
            'GroupId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'PrimaryVpcId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • SecurityGroupForVpcs (list) –

    The security group that can be used by interfaces in the VPC.

    • (dict) –

      A security group that can be used by interfaces in the VPC.

      • Description (string) –

        The security group’s description.

      • GroupName (string) –

        The security group name.

      • OwnerId (string) –

        The security group owner ID.

      • GroupId (string) –

        The security group ID.

      • Tags (list) –

        The security group tags.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • PrimaryVpcId (string) –

        The VPC ID in which the security group was created.