Skip to content

describe_security_group_vpc_associations

describe_security_group_vpc_associations(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    filters: Optional[FilterList] = None,
    next_token: Optional[String] = None,
    max_results: Optional[DescribeSecurityGroupVpcAssociationsMaxResults] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeSecurityGroupVpcAssociationsResult

Describes security group VPC associations made with AssociateSecurityGroupVpc.

Parameters:

  • filters (Optional[FilterList], default: None ) –

    Security group VPC association filters.

    • group-id: The security group ID.

    • group-owner-id: The group owner ID.

    • state: The state of the association.

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

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

  • next_token (Optional[String], default: None ) –

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

  • max_results (Optional[DescribeSecurityGroupVpcAssociationsMaxResults], default: 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.

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_security_group_vpc_associations(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_security_group_vpc_associations_max_results.DescribeSecurityGroupVpcAssociationsMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_security_group_vpc_associations_result.DescribeSecurityGroupVpcAssociationsResult":
    """<p>Describes security group VPC associations made with <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateSecurityGroupVpc.html">AssociateSecurityGroupVpc</a>.</p>

    Args:
        filters: <p>Security group VPC association filters.</p> <ul> <li> <p> <code>group-id</code>: The security group ID.</p> </li> <li> <p> <code>group-owner-id</code>: The group owner ID.</p> </li> <li> <p> <code>state</code>: The state of the association.</p> </li> <li> <p> <code>vpc-id</code>: The ID of the associated VPC.</p> </li> <li> <p> <code>vpc-owner-id</code>: The account ID of the VPC owner.</p> </li> </ul>
        next_token: <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
        max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_security_group_vpc_associations_request.DescribeSecurityGroupVpcAssociationsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_security_group_vpc_associations_result.DescribeSecurityGroupVpcAssociationsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_security_group_vpc_associations

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_security_group_vpc_associations.describe_security_group_vpc_associations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSecurityGroupVpcAssociations")
    )
    input_: capo_ec2.types.describe_security_group_vpc_associations_request.DescribeSecurityGroupVpcAssociationsRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output