[ aws . ec2 ]

get-subnet-cidr-reservations

Description

Gets information about the subnet CIDR reservations.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-subnet-cidr-reservations
[--filters <value>]
--subnet-id <value>
[--dry-run | --no-dry-run]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

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

(structure)

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.

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--subnet-id (string)

The ID of the subnet.

--dry-run | --no-dry-run (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 .

--next-token (string)

The token for the next page of results.

--max-results (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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about a subnet CIDR reservation

The following get-subnet-cidr-reservations example displays information about the specified subnet CIDR reservation.

aws ec2 get-subnet-cidr-reservations \
    --subnet-id subnet-03c51e2e6cEXAMPLE

Output:

{
    "SubnetIpv4CidrReservations": [
        {
            "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE",
            "SubnetId": "subnet-03c51e2e6cEXAMPLE",
            "Cidr": "10.1.0.16/28",
            "ReservationType": "prefix",
            "OwnerId": "123456789012"
        }
    ],
    "SubnetIpv6CidrReservations": []
}

For more information, see Subnet CIDR reservations in the Amazon VPC User Guide.

Output

SubnetIpv4CidrReservations -> (list)

Information about the IPv4 subnet CIDR reservations.

(structure)

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.

(structure)

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 255 Unicode characters.

SubnetIpv6CidrReservations -> (list)

Information about the IPv6 subnet CIDR reservations.

(structure)

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.

(structure)

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 255 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.