EC2 / Client / export_verified_access_instance_client_configuration

export_verified_access_instance_client_configuration#

EC2.Client.export_verified_access_instance_client_configuration(**kwargs)#

Exports the client configuration for a Verified Access instance.

Request Syntax

response = client.export_verified_access_instance_client_configuration(
    VerifiedAccessInstanceId='string',
    DryRun=True|False
)

Parameters:

VerifiedAccessInstanceId (string) –
[REQUIRED]

The ID of the Verified Access instance.
DryRun (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.

Return type:

dict

Returns:

Response Syntax

{
    'Version': 'string',
    'VerifiedAccessInstanceId': 'string',
    'Region': 'string',
    'DeviceTrustProviders': [
        'jamf'|'crowdstrike'|'jumpcloud',
    ],
    'UserTrustProvider': {
        'Type': 'iam-identity-center'|'oidc',
        'Scopes': 'string',
        'Issuer': 'string',
        'AuthorizationEndpoint': 'string',
        'PublicSigningKeyEndpoint': 'string',
        'TokenEndpoint': 'string',
        'UserInfoEndpoint': 'string',
        'ClientId': 'string',
        'ClientSecret': 'string',
        'PkceEnabled': True|False
    },
    'OpenVpnConfigurations': [
        {
            'Config': 'string',
            'Routes': [
                {
                    'Cidr': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- 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 (dict) –
  
  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.
  - (dict) –
    
    Describes a set of routes.
    - Config (string) –
      
      The base64-encoded Open VPN client configuration.
    - Routes (list) –
      
      The routes.
      - (dict) –
        
        Describes a route.
        
        Cidr (string) –
        
        The CIDR block.