ExportVerifiedAccessInstanceClientConfigurationCommand

Suggest an Edit

Exports the client configuration for a Verified Access instance.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, ExportVerifiedAccessInstanceClientConfigurationCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, ExportVerifiedAccessInstanceClientConfigurationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // ExportVerifiedAccessInstanceClientConfigurationRequest
  VerifiedAccessInstanceId: "STRING_VALUE", // required
  DryRun: true || false,
};
const command = new ExportVerifiedAccessInstanceClientConfigurationCommand(input);
const response = await client.send(command);
// { // ExportVerifiedAccessInstanceClientConfigurationResult
//   Version: "STRING_VALUE",
//   VerifiedAccessInstanceId: "STRING_VALUE",
//   Region: "STRING_VALUE",
//   DeviceTrustProviders: [ // DeviceTrustProviderTypeList
//     "jamf" || "crowdstrike" || "jumpcloud",
//   ],
//   UserTrustProvider: { // VerifiedAccessInstanceUserTrustProviderClientConfiguration
//     Type: "iam-identity-center" || "oidc",
//     Scopes: "STRING_VALUE",
//     Issuer: "STRING_VALUE",
//     AuthorizationEndpoint: "STRING_VALUE",
//     PublicSigningKeyEndpoint: "STRING_VALUE",
//     TokenEndpoint: "STRING_VALUE",
//     UserInfoEndpoint: "STRING_VALUE",
//     ClientId: "STRING_VALUE",
//     ClientSecret: "STRING_VALUE",
//     PkceEnabled: true || false,
//   },
//   OpenVpnConfigurations: [ // VerifiedAccessInstanceOpenVpnClientConfigurationList
//     { // VerifiedAccessInstanceOpenVpnClientConfiguration
//       Config: "STRING_VALUE",
//       Routes: [ // VerifiedAccessInstanceOpenVpnClientConfigurationRouteList
//         { // VerifiedAccessInstanceOpenVpnClientConfigurationRoute
//           Cidr: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
// };

ExportVerifiedAccessInstanceClientConfigurationCommand Input

See ExportVerifiedAccessInstanceClientConfigurationCommandInput for more details

Parameter
Type
Description
VerifiedAccessInstanceId
Required
string | undefined

The ID of the Verified Access instance.

DryRun
boolean | undefined

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.

ExportVerifiedAccessInstanceClientConfigurationCommand Output

See ExportVerifiedAccessInstanceClientConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DeviceTrustProviders
DeviceTrustProviderType[] | undefined

The device trust providers.

OpenVpnConfigurations
VerifiedAccessInstanceOpenVpnClientConfiguration[] | undefined

The Open VPN configuration.

Region
string | undefined

The Region.

UserTrustProvider
VerifiedAccessInstanceUserTrustProviderClientConfiguration | undefined

The user identity trust provider.

VerifiedAccessInstanceId
string | undefined

The ID of the Verified Access instance.

Version
string | undefined

The version.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.