Skip to content

update_security_group_rule_descriptions_ingress

Operation

update_security_group_rule_descriptions_ingress

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.

Parameters:

Name Type Description Default
request UpdateSecurityGroupRuleDescriptionsIngressInput | UpdateSecurityGroupRuleDescriptionsIngressInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateSecurityGroupRuleDescriptionsIngressInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateSecurityGroupRuleDescriptionsIngressOutput

An instance of UpdateSecurityGroupRuleDescriptionsIngressOutput.

update_security_group_rule_descriptions_ingress async

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.

Parameters:

Name Type Description Default
request UpdateSecurityGroupRuleDescriptionsIngressInput | UpdateSecurityGroupRuleDescriptionsIngressInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateSecurityGroupRuleDescriptionsIngressInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateSecurityGroupRuleDescriptionsIngressOutput

An instance of UpdateSecurityGroupRuleDescriptionsIngressOutput.

Input

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

UpdateSecurityGroupRuleDescriptionsIngressInputDict

Bases: TypedDict

Dictionary form of UpdateSecurityGroupRuleDescriptionsIngressInput.

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: str | None

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

group_name instance-attribute
group_name: str | None

[Default VPC] The name of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.

ip_permissions instance-attribute
ip_permissions: Sequence[IpPermission | IpPermissionDict] | None

The IP permissions for the security group rule. You must specify either IP permissions or a description.

security_group_rule_descriptions instance-attribute
security_group_rule_descriptions: Sequence[SecurityGroupRuleDescription | SecurityGroupRuleDescriptionDict] | None

The description for the ingress security group rules. You must specify either a description or IP permissions.

UpdateSecurityGroupRuleDescriptionsIngressInput dataclass

Bases: _SerdeShape

Dataclass for UpdateSecurityGroupRuleDescriptionsIngressInput 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: str | None = ...

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

group_name class-attribute instance-attribute
group_name: str | None = ...

[Default VPC] The name of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.

ip_permissions class-attribute instance-attribute
ip_permissions: list[IpPermission] | None = ...

The IP permissions for the security group rule. You must specify either IP permissions or a description.

security_group_rule_descriptions class-attribute instance-attribute
security_group_rule_descriptions: list[SecurityGroupRuleDescription] | None = ...

The description for the ingress security group rules. You must specify either a description or IP permissions.

Output

UpdateSecurityGroupRuleDescriptionsIngressOutput dataclass

Bases: _SerdeShape

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

return_ class-attribute instance-attribute
return_: bool | None = ...

Returns true if the request succeeds; otherwise, returns an error.