EC2 / Client / update_security_group_rule_descriptions_ingress

update_security_group_rule_descriptions_ingress#

EC2.Client.update_security_group_rule_descriptions_ingress(**kwargs)#

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.

Request Syntax

response = client.update_security_group_rule_descriptions_ingress(
    DryRun=True|False,
    GroupId='string',
    GroupName='string',
    IpPermissions=[
        {
            'FromPort': 123,
            'IpProtocol': 'string',
            'IpRanges': [
                {
                    'CidrIp': 'string',
                    'Description': 'string'
                },
            ],
            'Ipv6Ranges': [
                {
                    'CidrIpv6': 'string',
                    'Description': 'string'
                },
            ],
            'PrefixListIds': [
                {
                    'Description': 'string',
                    'PrefixListId': 'string'
                },
            ],
            'ToPort': 123,
            'UserIdGroupPairs': [
                {
                    'Description': 'string',
                    'GroupId': 'string',
                    'GroupName': 'string',
                    'PeeringStatus': 'string',
                    'UserId': 'string',
                    'VpcId': 'string',
                    'VpcPeeringConnectionId': 'string'
                },
            ]
        },
    ],
    SecurityGroupRuleDescriptions=[
        {
            'SecurityGroupRuleId': 'string',
            'Description': 'string'
        },
    ]
)

Parameters:

DryRun (boolean) – 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.
GroupId (string) – 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.
GroupName (string) – [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.
IpPermissions (list) –
The IP permissions for the security group rule. You must specify either IP permissions or a description.
- (dict) –
  
  Describes the permissions for a security group rule.
  - FromPort (integer) –
    
    If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
  - IpProtocol (string) –
    
    The IP protocol name ( tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
    
    Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
  - IpRanges (list) –
    
    The IPv4 address ranges.
    - (dict) –
      
      Describes an IPv4 address range.
      - CidrIp (string) –
        
        The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
      - Description (string) –
        
        A description for the security group rule that references this IPv4 address range.
        
        Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
  - Ipv6Ranges (list) –
    
    The IPv6 address ranges.
    - (dict) –
      
      Describes an IPv6 address range.
      - CidrIpv6 (string) –
        
        The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
      - Description (string) –
        
        A description for the security group rule that references this IPv6 address range.
        
        Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
  - PrefixListIds (list) –
    
    The prefix list IDs.
    - (dict) –
      
      Describes a prefix list ID.
      - Description (string) –
        
        A description for the security group rule that references this prefix list ID.
        
        Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
      - PrefixListId (string) –
        
        The ID of the prefix.
  - ToPort (integer) –
    
    If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
  - UserIdGroupPairs (list) –
    
    The security group and Amazon Web Services account ID pairs.
    - (dict) –
      
      Describes a security group and Amazon Web Services account ID pair.
      - Description (string) –
        
        A description for the security group rule that references this user ID group pair.
        
        Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
      - GroupId (string) –
        
        The ID of the security group.
      - GroupName (string) –
        
        [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID.
        
        For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
      - PeeringStatus (string) –
        
        The status of a VPC peering connection, if applicable.
      - UserId (string) –
        
        The ID of an Amazon Web Services account.
        
        For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
      - VpcId (string) –
        
        The ID of the VPC for the referenced security group, if applicable.
      - VpcPeeringConnectionId (string) –
        
        The ID of the VPC peering connection, if applicable.
SecurityGroupRuleDescriptions (list) –
The description for the ingress security group rules. You must specify either a description or IP permissions.
- (dict) –
  
  Describes the description of a security group rule.
  
  You can use this when you want to update the security group rule description for either an inbound or outbound rule.
  - SecurityGroupRuleId (string) –
    
    The ID of the security group rule.
  - Description (string) –
    
    The description of the security group rule.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

(dict) –
- Return (boolean) –
  
  Returns true if the request succeeds; otherwise, returns an error.

Examples

This example updates the description for the specified security group rule.

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

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}