[ aws . ec2 ]

modify-availability-zone-group

Description

Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.

Use DescribeAvailabilityZones to view the value for GroupName .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  modify-availability-zone-group
--group-name <value>
--opt-in-status <value>
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--group-name (string)

The name of the Availability Zone group, Local Zone group, or Wavelength Zone group.

--opt-in-status (string)

Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The only valid value is opted-in . You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.

Possible values:

• opted-in

• not-opted-in

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To enable a zone group

The following modify-availability-zone-group example enables the specified zone group.

aws ec2 modify-availability-zone-group \
    --group-name us-west-2-lax-1 \
    --opt-in-status opted-in

Output:

{
    "Return": true
}

For more information, see Regions and Zones in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

Output

Return -> (boolean)

Is true if the request succeeds, and an error otherwise.