EC2 / Client / modify_verified_access_instance

modify_verified_access_instance

EC2.Client.modify_verified_access_instance(**kwargs)

Modifies the configuration of the specified Amazon Web Services Verified Access instance.

See also: AWS API Documentation

Request Syntax

response = client.modify_verified_access_instance(
    VerifiedAccessInstanceId='string',
    Description='string',
    DryRun=True|False,
    ClientToken='string',
    CidrEndpointsCustomSubDomain='string'
)

Parameters:

• VerifiedAccessInstanceId (string) –

  [REQUIRED]

  The ID of the Verified Access instance.

• Description (string) – A description for 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.

• ClientToken (string) –

  A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.

  This field is autopopulated if not provided.

• CidrEndpointsCustomSubDomain (string) – The custom subdomain.

Return type:

dict

Returns:

Response Syntax

{
    'VerifiedAccessInstance': {
        'VerifiedAccessInstanceId': 'string',
        'Description': 'string',
        'VerifiedAccessTrustProviders': [
            {
                'VerifiedAccessTrustProviderId': 'string',
                'Description': 'string',
                'TrustProviderType': 'user'|'device',
                'UserTrustProviderType': 'iam-identity-center'|'oidc',
                'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud'
            },
        ],
        'CreationTime': 'string',
        'LastUpdatedTime': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'FipsEnabled': True|False,
        'CidrEndpointsCustomSubDomain': {
            'SubDomain': 'string',
            'Nameservers': [
                'string',
            ]
        }
    }
}

Response Structure

• (dict) –

  • VerifiedAccessInstance (dict) –

    Details about the Verified Access instance.

    • VerifiedAccessInstanceId (string) –

      The ID of the Amazon Web Services Verified Access instance.

    • Description (string) –

      A description for the Amazon Web Services Verified Access instance.

    • VerifiedAccessTrustProviders (list) –

      The IDs of the Amazon Web Services Verified Access trust providers.

      • (dict) –

        Condensed information about a trust provider.

        • VerifiedAccessTrustProviderId (string) –

          The ID of the trust provider.

        • Description (string) –

          The description of trust provider.

        • TrustProviderType (string) –

          The type of trust provider (user- or device-based).

        • UserTrustProviderType (string) –

          The type of user-based trust provider.

        • DeviceTrustProviderType (string) –

          The type of device-based trust provider.

    • CreationTime (string) –

      The creation time.

    • LastUpdatedTime (string) –

      The last updated time.

    • Tags (list) –

      The tags.

      • (dict) –

        Describes a tag.

        • Key (string) –

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value (string) –

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • FipsEnabled (boolean) –

      Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.

    • CidrEndpointsCustomSubDomain (dict) –

      The custom subdomain.

      • SubDomain (string) –

        The subdomain.

      • Nameservers (list) –

        The name servers.

        • (string) –