[ aws . workspaces ]

describe-account-modifications

Description

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-account-modifications is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: AccountModifications

Synopsis

  describe-account-modifications
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

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

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

AccountModifications -> (list)

The list of modifications to the configuration of BYOL.

(structure)

Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.

ModificationState -> (string)

The state of the modification to the configuration of BYOL.

DedicatedTenancySupport -> (string)

The status of BYOL (whether BYOL is being enabled or disabled).

DedicatedTenancyManagementCidrRange -> (string)

The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.

StartTime -> (timestamp)

The timestamp when the modification of the BYOL configuration was started.

ErrorCode -> (string)

The error code that is returned if the configuration of BYOL cannot be modified.

ErrorMessage -> (string)

The text of the error message that is returned if the configuration of BYOL cannot be modified.

NextToken -> (string)

The token to use to retrieve the next set of results, or null if no more results are available.