Skip to content

EC2  >  Operations  >  describe_security_group_rules

describe_security_group_rules

Operation

describe_security_group_rules async

describe_security_group_rules(input: DescribeSecurityGroupRulesInput, plugins: list[Plugin] | None = None) -> DescribeSecurityGroupRulesOutput

Describes one or more of your security group rules.

Parameters:

Name Type Description Default
input DescribeSecurityGroupRulesInput

An instance of DescribeSecurityGroupRulesInput.

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
DescribeSecurityGroupRulesOutput

An instance of DescribeSecurityGroupRulesOutput.

Input

DescribeSecurityGroupRulesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeSecurityGroupRulesInput 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 = ...

One or more filters.

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

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

  • tag:<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 Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. 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.

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

The IDs of the security group rules.

Output

DescribeSecurityGroupRulesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeSecurityGroupRulesOutput 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_rules class-attribute instance-attribute
security_group_rules: list[SecurityGroupRule] | None = ...

Information about security group rules.