AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

export-verified-access-instance-client-configuration

Description

Exports the client configuration for a Verified Access instance.

See also: AWS API Documentation

Synopsis

  export-verified-access-instance-client-configuration
--verified-access-instance-id <value>
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--verified-access-instance-id (string)

The ID of the Verified Access instance.

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Version -> (string)

The version.

VerifiedAccessInstanceId -> (string)

The ID of the Verified Access instance.

Region -> (string)

The Region.

DeviceTrustProviders -> (list)

The device trust providers.

(string)

UserTrustProvider -> (structure)

The user identity trust provider.

Type -> (string)

The trust provider type.

Scopes -> (string)

The set of user claims to be requested from the IdP.

Issuer -> (string)

The OIDC issuer identifier of the IdP.

AuthorizationEndpoint -> (string)

The authorization endpoint of the IdP.

PublicSigningKeyEndpoint -> (string)

The public signing key endpoint.

TokenEndpoint -> (string)

The token endpoint of the IdP.

UserInfoEndpoint -> (string)

The user info endpoint of the IdP.

ClientId -> (string)

The OAuth 2.0 client identifier.

ClientSecret -> (string)

The OAuth 2.0 client secret.

PkceEnabled -> (boolean)

Indicates whether Proof of Key Code Exchange (PKCE) is enabled.

OpenVpnConfigurations -> (list)

The Open VPN configuration.

(structure)

Describes a set of routes.

Config -> (string)

The base64-encoded Open VPN client configuration.

Routes -> (list)

The routes.

(structure)

Describes a route.

Cidr -> (string)

The CIDR block.