DescribeSecurityGroupVpcAssociationsCommand

Suggest an Edit

Describes security group VPC associations made with AssociateSecurityGroupVpc .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeSecurityGroupVpcAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeSecurityGroupVpcAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeSecurityGroupVpcAssociationsRequest
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // ValueStringList
        "STRING_VALUE",
      ],
    },
  ],
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  DryRun: true || false,
};
const command = new DescribeSecurityGroupVpcAssociationsCommand(input);
const response = await client.send(command);
// { // DescribeSecurityGroupVpcAssociationsResult
//   SecurityGroupVpcAssociations: [ // SecurityGroupVpcAssociationList
//     { // SecurityGroupVpcAssociation
//       GroupId: "STRING_VALUE",
//       VpcId: "STRING_VALUE",
//       VpcOwnerId: "STRING_VALUE",
//       State: "associating" || "associated" || "association-failed" || "disassociating" || "disassociated" || "disassociation-failed",
//       StateReason: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeSecurityGroupVpcAssociationsCommand Input

See DescribeSecurityGroupVpcAssociationsCommandInput for more details

Parameter
Type
Description
DryRun
boolean | undefined

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
Filter[] | undefined

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

MaxResults
number | undefined

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 .

NextToken
string | undefined

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

DescribeSecurityGroupVpcAssociationsCommand Output

See DescribeSecurityGroupVpcAssociationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

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.

SecurityGroupVpcAssociations
SecurityGroupVpcAssociation[] | undefined

The security group VPC associations.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.