subnet-available¶

Description¶

Wait until JMESPath query Subnets[].State returns available for all elements when polling with describe-subnets. It will poll every 15 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks.

Synopsis¶

  subnet-available
[--filters <value>]
[--subnet-ids <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--filters (list)

One or more filters.

availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet’s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name.

ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

owner-id - The ID of the Amazon Web Services account that owns the subnet.

state - The state of the subnet (pending | available ).

subnet-arn - The Amazon Resource Name (ARN) of the subnet.

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.

vpc-id - The ID of the VPC for the subnet.

(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-ids (list)

One or more subnet IDs.

Default: Describes all your subnets.

(string)

Syntax:

"string" "string" ...

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

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 wait until a subnet is available

The following wait subnet-available example pauses and resumes running only after it confirms that the specified subnet is available. It produces no output.

aws ec2 wait subnet-available \
    --subnet-ids subnet-1234567890abcdef0

Output¶

None

Table of Contents

Feedback

User Guide