Skip to content

EC2  >  Operations  >  describe_security_group_references

describe_security_group_references

Operation

describe_security_group_references async

describe_security_group_references(request: DescribeSecurityGroupReferencesInput | DescribeSecurityGroupReferencesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeSecurityGroupReferencesOutput
describe_security_group_references(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeSecurityGroupReferencesInputDict]) -> DescribeSecurityGroupReferencesOutput

Describes the VPCs on the other side of a VPC peering or Transit Gateway connection that are referencing the security groups you've specified in this request.

Parameters:

Name Type Description Default
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
DescribeSecurityGroupReferencesOutput

An instance of DescribeSecurityGroupReferencesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeSecurityGroupReferencesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeSecurityGroupReferencesInput 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.

group_id class-attribute instance-attribute
group_id: list[str] | None = ...

The IDs of the security groups in your account.

Dictionaries

DescribeSecurityGroupReferencesInputDict

Bases: TypedDict

Dictionary form of DescribeSecurityGroupReferencesInput.

Attributes
dry_run 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.

group_id instance-attribute
group_id: Required[Sequence[str]]

The IDs of the security groups in your account.

Output

DescribeSecurityGroupReferencesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeSecurityGroupReferencesOutput structure.

Attributes

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_reference_set class-attribute instance-attribute
security_group_reference_set: list[SecurityGroupReference] | None = ...

Information about the VPCs with the referencing security groups.