EC2 / Client / get_subnet_cidr_reservations

get_subnet_cidr_reservations#

EC2.Client.get_subnet_cidr_reservations(**kwargs)#

Gets information about the subnet CIDR reservations.

Request Syntax

response = client.get_subnet_cidr_reservations(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SubnetId='string',
    DryRun=True|False,
    NextToken='string',
    MaxResults=123
)

Parameters:

Filters (list) –
One or more filters.
- reservationType - The type of reservation ( prefix | explicit).
- subnet-id - The ID of the subnet.
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
SubnetId (string) –
[REQUIRED]

The ID of the subnet.
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.
NextToken (string) – The token for the next page of results.
MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'SubnetIpv4CidrReservations': [
        {
            'SubnetCidrReservationId': 'string',
            'SubnetId': 'string',
            'Cidr': 'string',
            'ReservationType': 'prefix'|'explicit',
            'OwnerId': 'string',
            'Description': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'SubnetIpv6CidrReservations': [
        {
            'SubnetCidrReservationId': 'string',
            'SubnetId': 'string',
            'Cidr': 'string',
            'ReservationType': 'prefix'|'explicit',
            'OwnerId': 'string',
            'Description': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- SubnetIpv4CidrReservations (list) –
  
  Information about the IPv4 subnet CIDR reservations.
  - (dict) –
    
    Describes a subnet CIDR reservation.
    - SubnetCidrReservationId (string) –
      
      The ID of the subnet CIDR reservation.
    - SubnetId (string) –
      
      The ID of the subnet.
    - Cidr (string) –
      
      The CIDR that has been reserved.
    - ReservationType (string) –
      
      The type of reservation.
    - OwnerId (string) –
      
      The ID of the account that owns the subnet CIDR reservation.
    - Description (string) –
      
      The description assigned to the subnet CIDR reservation.
    - Tags (list) –
      
      The tags assigned to the subnet CIDR reservation.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- SubnetIpv6CidrReservations (list) –
  
  Information about the IPv6 subnet CIDR reservations.
  - (dict) –
    
    Describes a subnet CIDR reservation.
    - SubnetCidrReservationId (string) –
      
      The ID of the subnet CIDR reservation.
    - SubnetId (string) –
      
      The ID of the subnet.
    - Cidr (string) –
      
      The CIDR that has been reserved.
    - ReservationType (string) –
      
      The type of reservation.
    - OwnerId (string) –
      
      The ID of the account that owns the subnet CIDR reservation.
    - Description (string) –
      
      The description assigned to the subnet CIDR reservation.
    - Tags (list) –
      
      The tags assigned to the subnet CIDR reservation.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.