Skip to content

describe_security_group_rules

describe_security_group_rules(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    filters: Optional[FilterList] = None,
    security_group_rule_ids: Optional[SecurityGroupRuleIdList] = None,
    dry_run: Optional[Boolean] = None,
    next_token: Optional[String] = None,
    max_results: Optional[DescribeSecurityGroupRulesMaxResults] = None,
) -> DescribeSecurityGroupRulesResult

Describes one or more of your security group rules.

Parameters:

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

    One or more filters.

    • group-id - The ID of the security group.

    • security-group-rule-id - The ID of the security group rule.

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

  • security_group_rule_ids (Optional[SecurityGroupRuleIdList], default: None ) –

    The IDs of the security group rules.

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

  • 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[DescribeSecurityGroupRulesMaxResults], 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. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_security_group_rules(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    security_group_rule_ids: Optional[
        "capo_ec2.types.security_group_rule_id_list.SecurityGroupRuleIdList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_security_group_rules_max_results.DescribeSecurityGroupRulesMaxResults"
    ] = None,
) -> "capo_ec2.types.describe_security_group_rules_result.DescribeSecurityGroupRulesResult":
    """<p>Describes one or more of your security group rules.</p>

    Args:
        filters: <p>One or more filters.</p> <ul> <li> <p> <code>group-id</code> - The ID of the security group.</p> </li> <li> <p> <code>security-group-rule-id</code> - The ID of the security group rule.</p> </li> <li> <p> <code>tag</code>:<key> - 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 <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> </ul>
        security_group_rule_ids: <p>The IDs of the security group rules.</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>
        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. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</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_rules_request.DescribeSecurityGroupRulesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_security_group_rules_result.DescribeSecurityGroupRulesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_security_group_rules

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

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

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