update_security_group_rule_descriptions_ingress ¶

def update_security_group_rule_descriptions_ingress(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    group_id: Optional["capo_ec2.types.security_group_id.SecurityGroupId"] = None,
    group_name: Optional[
        "capo_ec2.types.security_group_name.SecurityGroupName"
    ] = None,
    ip_permissions: Optional[
        "capo_ec2.types.ip_permission_list.IpPermissionList"
    ] = None,
    security_group_rule_descriptions: Optional[
        "capo_ec2.types.security_group_rule_description_list.SecurityGroupRuleDescriptionList"
    ] = None,
) -> "capo_ec2.types.update_security_group_rule_descriptions_ingress_result.UpdateSecurityGroupRuleDescriptionsIngressResult":
    """<p>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.</p>

    Args:
        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>
        group_id: <p>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.</p>
        group_name: <p>[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.</p>
        ip_permissions: <p>The IP permissions for the security group rule. You must specify either IP permissions or a description.</p>
        security_group_rule_descriptions: <p>The description for the ingress security group rules. You must specify either a description or IP permissions.</p>

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

    Examples:
        To update an inbound security group rule description
        This example updates the description for the specified security group rule.

        >>> client.update_security_group_rule_descriptions_ingress(group_id='sg-123abc12', ip_permissions=[{'IpProtocol': 'tcp', 'FromPort': 22, 'ToPort': 22, 'IpRanges': [{'CidrIp': '203.0.113.0/16', 'Description': 'SSH access from the LA office'}]}])
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.update_security_group_rule_descriptions_ingress_request.UpdateSecurityGroupRuleDescriptionsIngressRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.update_security_group_rule_descriptions_ingress_result.UpdateSecurityGroupRuleDescriptionsIngressResult"
    ]:
        import capo_ec2._operations.amazon_ec2.update_security_group_rule_descriptions_ingress

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateSecurityGroupRuleDescriptionsIngress"),
    )
    input_: capo_ec2.types.update_security_group_rule_descriptions_ingress_request.UpdateSecurityGroupRuleDescriptionsIngressRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if group_id is not None:
        input_["group_id"] = group_id
    if group_name is not None:
        input_["group_name"] = group_name
    if ip_permissions is not None:
        input_["ip_permissions"] = ip_permissions
    if security_group_rule_descriptions is not None:
        input_["security_group_rule_descriptions"] = (
            security_group_rule_descriptions
        )

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