ec2_describe_availability_zones: Describes the Availability Zones, Local Zones, and Wavelength...

Description Usage Arguments Value Request syntax Examples

View source: R/ec2_operations.R

Description

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.

For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions, Zones and Outposts in the Amazon Elastic Compute Cloud User Guide.

Usage

1
2
ec2_describe_availability_zones(Filters, ZoneNames, ZoneIds,
  AllAvailabilityZones, DryRun)

Arguments

Filters

The filters.

  • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • message - The Zone message.

  • opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).

  • parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • region-name - The name of the Region for the Zone (for example, us-east-1).

  • state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | information | impaired | unavailable).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone, for example, local-zone.

  • zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone, for example, local-zone.

ZoneNames

The names of the Availability Zones, Local Zones, and Wavelength Zones.

ZoneIds

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

AllAvailabilityZones

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

DryRun

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
list(
  AvailabilityZones = list(
    list(
      State = "available"|"information"|"impaired"|"unavailable",
      OptInStatus = "opt-in-not-required"|"opted-in"|"not-opted-in",
      Messages = list(
        list(
          Message = "string"
        )
      ),
      RegionName = "string",
      ZoneName = "string",
      ZoneId = "string",
      GroupName = "string",
      NetworkBorderGroup = "string",
      ZoneType = "string",
      ParentZoneName = "string",
      ParentZoneId = "string"
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
svc$describe_availability_zones(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  ZoneNames = list(
    "string"
  ),
  ZoneIds = list(
    "string"
  ),
  AllAvailabilityZones = TRUE|FALSE,
  DryRun = TRUE|FALSE
)

Examples

1
2
3
4
5
6
## Not run: 
# This example describes the Availability Zones that are available to you.
# The response includes Availability Zones only for the current region.
svc$describe_availability_zones()

## End(Not run)

paws.compute documentation built on March 7, 2021, 5:10 p.m.