revoke_ingress¶

EC2.SecurityGroup.revoke_ingress(**kwargs)¶

Removes the specified inbound (ingress) rules from a security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

Note

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

response = security_group.revoke_ingress(
    CidrIp='string',
    FromPort=123,
    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'
                },
            ]
        },
    ],
    IpProtocol='string',
    SourceSecurityGroupName='string',
    SourceSecurityGroupOwnerId='string',
    ToPort=123,
    DryRun=True|False,
    SecurityGroupRuleIds=[
        'string',
    ]
)

Parameters

CidrIp (string) -- The CIDR IP address range. You can't specify this parameter when specifying a source security group.
FromPort (integer) -- If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types.
GroupName (string) -- [EC2-Classic, default VPC] The name 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.
IpPermissions (list) --
The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
- (dict) --
  Describes a set of 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 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
  - IpProtocol (string) --
    The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
    
    [VPC only] 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 ranges.
    - (dict) --
      Describes an IPv4 range.
      - CidrIp (string) --
        The IPv4 CIDR range. You can either specify a CIDR range 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) --
    [VPC only] The IPv6 ranges.
    - (dict) --
      [EC2-VPC only] Describes an IPv6 range.
      - CidrIpv6 (string) --
        The IPv6 CIDR range. You can either specify a CIDR range 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) --
    [VPC only] 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 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 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.
      
      Note
      
      We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide .
      - 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) --
        The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. 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.
        
        [EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
      - 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.
IpProtocol (string) -- The IP protocol name ( tcp , udp , icmp ) or number (see Protocol Numbers ). Use -1 to specify all.
SourceSecurityGroupName (string) -- [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
SourceSecurityGroupOwnerId (string) -- [EC2-Classic] The Amazon Web Services account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
ToPort (integer) -- If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes.
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 .
SecurityGroupRuleIds (list) --
The IDs of the security group rules.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'Return': True|False,
    'UnknownIpPermissions': [
        {
            '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'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- Return (boolean) --
  
  Returns true if the request succeeds; otherwise, returns an error.
- UnknownIpPermissions (list) --
  
  The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.
  - (dict) --
    
    Describes a set of 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 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
    - IpProtocol (string) --
      
      The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
      
      [VPC only] 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 ranges.
      - (dict) --
        
        Describes an IPv4 range.
        
        CidrIp (string) --
        
        The IPv4 CIDR range. You can either specify a CIDR range 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) --
      
      [VPC only] The IPv6 ranges.
      - (dict) --
        
        [EC2-VPC only] Describes an IPv6 range.
        
        CidrIpv6 (string) --
        
        The IPv6 CIDR range. You can either specify a CIDR range 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) --
      
      [VPC only] 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 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 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.
        
        Note
        
        We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide .
        
        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) --
        
        The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. 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.
        
        [EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
        
        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.

Table Of Contents

revoke_ingress¶