Skip to content

EC2  >  Operations  >  get_security_groups_for_vpc

get_security_groups_for_vpc

Operation

get_security_groups_for_vpc async

get_security_groups_for_vpc(input: GetSecurityGroupsForVpcInput, plugins: list[Plugin] | None = None) -> GetSecurityGroupsForVpcOutput

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

Parameters:

Name Type Description Default
input GetSecurityGroupsForVpcInput

An instance of GetSecurityGroupsForVpcInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetSecurityGroupsForVpcOutput

An instance of GetSecurityGroupsForVpcOutput.

Input

GetSecurityGroupsForVpcInput dataclass

Bases: _SerdeShape

Dataclass for GetSecurityGroupsForVpcInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

vpc_id class-attribute instance-attribute
vpc_id: str | None = ...

The VPC ID where the security group can be used.

Output

GetSecurityGroupsForVpcOutput dataclass

Bases: _SerdeShape

Dataclass for GetSecurityGroupsForVpcOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

security_group_for_vpcs class-attribute instance-attribute
security_group_for_vpcs: list[SecurityGroupForVpc] | None = ...

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