EC2 / Client / revoke_security_group_ingress

revoke_security_group_ingress#

EC2.Client.revoke_security_group_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.

For a 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.

For a non-default VPC, if the values you specify do not match the existing rule’s values, an InvalidPermission.NotFound client error is returned, and no rules are 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.

Request Syntax

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

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 ICMP type or -1 (all ICMP types).
GroupId (string) – The ID of the security group.
GroupName (string) – [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 the permissions for a security group rule.
  - 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.
  - 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).
  - 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 ._-:/()#,@[]+=;{}!$*
      - 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.
      - 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.
      - GroupId (string) –
        
        The ID of the security group.
      - 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.
      - PeeringStatus (string) –
        
        The status of a VPC peering connection, if applicable.
  - IpRanges (list) –
    
    The IPv4 address ranges.
    - (dict) –
      
      Describes an IPv4 address range.
      - 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 ._-:/()#,@[]+=&;{}!$*
      - 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.
  - Ipv6Ranges (list) –
    
    The IPv6 address ranges.
    - (dict) –
      
      Describes an IPv6 address range.
      - 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 ._-:/()#,@[]+=&;{}!$*
      - 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.
  - 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.
IpProtocol (string) – The IP protocol name ( tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
SourceSecurityGroupName (string) – [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. 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) – Not supported.
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 ICMP code or -1 (all ICMP codes).
SecurityGroupRuleIds (list) –
The IDs of the security group rules.
- (string) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False,
    'UnknownIpPermissions': [
        {
            'IpProtocol': 'string',
            'FromPort': 123,
            'ToPort': 123,
            'UserIdGroupPairs': [
                {
                    'Description': 'string',
                    'UserId': 'string',
                    'GroupName': 'string',
                    'GroupId': 'string',
                    'VpcId': 'string',
                    'VpcPeeringConnectionId': 'string',
                    'PeeringStatus': 'string'
                },
            ],
            'IpRanges': [
                {
                    'Description': 'string',
                    'CidrIp': 'string'
                },
            ],
            'Ipv6Ranges': [
                {
                    'Description': 'string',
                    'CidrIpv6': 'string'
                },
            ],
            'PrefixListIds': [
                {
                    'Description': 'string',
                    'PrefixListId': 'string'
                },
            ]
        },
    ],
    'RevokedSecurityGroupRules': [
        {
            'SecurityGroupRuleId': 'string',
            'GroupId': 'string',
            'IsEgress': True|False,
            'IpProtocol': 'string',
            'FromPort': 123,
            'ToPort': 123,
            'CidrIpv4': 'string',
            'CidrIpv6': 'string',
            'PrefixListId': 'string',
            'ReferencedGroupId': 'string',
            'Description': '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 the permissions for a security group rule.
    - 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.
    - 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).
    - 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 ._-:/()#,@[]+=;{}!$*
        
        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.
        
        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.
        
        GroupId (string) –
        
        The ID of the security group.
        
        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.
        
        PeeringStatus (string) –
        
        The status of a VPC peering connection, if applicable.
    - IpRanges (list) –
      
      The IPv4 address ranges.
      - (dict) –
        
        Describes an IPv4 address range.
        
        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 ._-:/()#,@[]+=&;{}!$*
        
        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.
    - Ipv6Ranges (list) –
      
      The IPv6 address ranges.
      - (dict) –
        
        Describes an IPv6 address range.
        
        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 ._-:/()#,@[]+=&;{}!$*
        
        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.
    - 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.
- RevokedSecurityGroupRules (list) –
  
  Details about the revoked security group rules.
  - (dict) –
    
    A security group rule removed with RevokeSecurityGroupEgress or RevokeSecurityGroupIngress.
    - SecurityGroupRuleId (string) –
      
      A security group rule ID.
    - GroupId (string) –
      
      A security group ID.
    - IsEgress (boolean) –
      
      Defines if a security group rule is an outbound rule.
    - IpProtocol (string) –
      
      The security group rule’s protocol.
    - FromPort (integer) –
      
      The ‘from’ port number of the security group rule.
    - ToPort (integer) –
      
      The ‘to’ port number of the security group rule.
    - CidrIpv4 (string) –
      
      The IPv4 CIDR of the traffic source.
    - CidrIpv6 (string) –
      
      The IPv6 CIDR of the traffic source.
    - PrefixListId (string) –
      
      The ID of a prefix list that’s the traffic source.
    - ReferencedGroupId (string) –
      
      The ID of a referenced security group.
    - Description (string) –
      
      A description of the revoked security group rule.