Amazon Elastic Compute Cloud

2023/11/16 - Amazon Elastic Compute Cloud - 10 updated api methods

Changes  Enable use of tenant-specific PublicSigningKeyUrl from device trust providers and onboard jumpcloud as a new device trust provider.

AttachVerifiedAccessTrustProvider (updated) Link ¶
Changes (response) 
{'VerifiedAccessInstance': {'VerifiedAccessTrustProviders': {'DeviceTrustProviderType': {'jumpcloud'}}},
 'VerifiedAccessTrustProvider': {'DeviceOptions': {'PublicSigningKeyUrl': 'string'},
                                 'DeviceTrustProviderType': {'jumpcloud'}}}

Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.

See also: AWS API Documentation

Request Syntax

client.attach_verified_access_trust_provider(
    VerifiedAccessInstanceId='string',
    VerifiedAccessTrustProviderId='string',
    ClientToken='string',
    DryRun=True|False
)
type VerifiedAccessInstanceId:

string

param VerifiedAccessInstanceId:

[REQUIRED]

The ID of the Verified Access instance.

type VerifiedAccessTrustProviderId:

string

param VerifiedAccessTrustProviderId:

[REQUIRED]

The ID of the Verified Access trust provider.

type ClientToken:

string

param ClientToken:

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.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'VerifiedAccessTrustProvider': {
        'VerifiedAccessTrustProviderId': 'string',
        'Description': 'string',
        'TrustProviderType': 'user'|'device',
        'UserTrustProviderType': 'iam-identity-center'|'oidc',
        'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud',
        'OidcOptions': {
            'Issuer': 'string',
            'AuthorizationEndpoint': 'string',
            'TokenEndpoint': 'string',
            'UserInfoEndpoint': 'string',
            'ClientId': 'string',
            'ClientSecret': 'string',
            'Scope': 'string'
        },
        'DeviceOptions': {
            'TenantId': 'string',
            'PublicSigningKeyUrl': 'string'
        },
        'PolicyReferenceName': 'string',
        'CreationTime': 'string',
        'LastUpdatedTime': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SseSpecification': {
            'CustomerManagedKeyEnabled': True|False,
            'KmsKeyArn': 'string'
        }
    },
    '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
    }
}

Response Structure

  • (dict) --

    • VerifiedAccessTrustProvider (dict) --

      Details about the Verified Access trust provider.

      • VerifiedAccessTrustProviderId (string) --

        The ID of the Amazon Web Services Verified Access trust provider.

      • Description (string) --

        A description for the Amazon Web Services Verified Access trust provider.

      • TrustProviderType (string) --

        The type of Verified Access trust provider.

      • UserTrustProviderType (string) --

        The type of user-based trust provider.

      • DeviceTrustProviderType (string) --

        The type of device-based trust provider.

      • OidcOptions (dict) --

        The options for an OpenID Connect-compatible user-identity trust provider.

        • Issuer (string) --

          The OIDC issuer.

        • AuthorizationEndpoint (string) --

          The OIDC authorization endpoint.

        • TokenEndpoint (string) --

          The OIDC token endpoint.

        • UserInfoEndpoint (string) --

          The OIDC user info endpoint.

        • ClientId (string) --

          The client identifier.

        • ClientSecret (string) --

          The client secret.

        • Scope (string) --

          The OpenID Connect (OIDC) scope specified.

      • DeviceOptions (dict) --

        The options for device-identity trust provider.

        • TenantId (string) --

          The ID of the tenant application with the device-identity provider.

        • PublicSigningKeyUrl (string) --

          The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

      • PolicyReferenceName (string) --

        The identifier to be used when working with policy rules.

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

      • SseSpecification (dict) --

        The options in use for server side encryption.

        • CustomerManagedKeyEnabled (boolean) --

          Indicates whether customer managed KMS keys are in use for server side encryption.

          Valid values: True | False

        • KmsKeyArn (string) --

          The ARN of the KMS key.

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

CreateVerifiedAccessInstance (updated) Link ¶
Changes (response) 
{'VerifiedAccessInstance': {'VerifiedAccessTrustProviders': {'DeviceTrustProviderType': {'jumpcloud'}}}}

An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.

See also: AWS API Documentation

Request Syntax

client.create_verified_access_instance(
    Description='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string',
    DryRun=True|False,
    FIPSEnabled=True|False
)
type Description:

string

param Description:

A description for the Verified Access instance.

type TagSpecifications:

list

param TagSpecifications:

The tags to assign to the Verified Access instance.

  • (dict) --

    The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

    • ResourceType (string) --

      The type of resource to tag on creation.

    • Tags (list) --

      The tags to apply to the resource.

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

type ClientToken:

string

param ClientToken:

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.

type DryRun:

boolean

param DryRun:

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.

type FIPSEnabled:

boolean

param FIPSEnabled:

Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.

rtype:

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

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.

CreateVerifiedAccessTrustProvider (updated) Link ¶
Changes (request, response)
Request 
{'DeviceOptions': {'PublicSigningKeyUrl': 'string'},
 'DeviceTrustProviderType': {'jumpcloud'}}
Response 
{'VerifiedAccessTrustProvider': {'DeviceOptions': {'PublicSigningKeyUrl': 'string'},
                                 'DeviceTrustProviderType': {'jumpcloud'}}}

A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.

See also: AWS API Documentation

Request Syntax

client.create_verified_access_trust_provider(
    TrustProviderType='user'|'device',
    UserTrustProviderType='iam-identity-center'|'oidc',
    DeviceTrustProviderType='jamf'|'crowdstrike'|'jumpcloud',
    OidcOptions={
        'Issuer': 'string',
        'AuthorizationEndpoint': 'string',
        'TokenEndpoint': 'string',
        'UserInfoEndpoint': 'string',
        'ClientId': 'string',
        'ClientSecret': 'string',
        'Scope': 'string'
    },
    DeviceOptions={
        'TenantId': 'string',
        'PublicSigningKeyUrl': 'string'
    },
    PolicyReferenceName='string',
    Description='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string',
    DryRun=True|False,
    SseSpecification={
        'CustomerManagedKeyEnabled': True|False,
        'KmsKeyArn': 'string'
    }
)
type TrustProviderType:

string

param TrustProviderType:

[REQUIRED]

The type of trust provider.

type UserTrustProviderType:

string

param UserTrustProviderType:

The type of user-based trust provider. This parameter is required when the provider type is user.

type DeviceTrustProviderType:

string

param DeviceTrustProviderType:

The type of device-based trust provider. This parameter is required when the provider type is device.

type OidcOptions:

dict

param OidcOptions:

The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is user.

  • Issuer (string) --

    The OIDC issuer.

  • AuthorizationEndpoint (string) --

    The OIDC authorization endpoint.

  • TokenEndpoint (string) --

    The OIDC token endpoint.

  • UserInfoEndpoint (string) --

    The OIDC user info endpoint.

  • ClientId (string) --

    The client identifier.

  • ClientSecret (string) --

    The client secret.

  • Scope (string) --

    OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

type DeviceOptions:

dict

param DeviceOptions:

The options for a device-based trust provider. This parameter is required when the provider type is device.

  • TenantId (string) --

    The ID of the tenant application with the device-identity provider.

  • PublicSigningKeyUrl (string) --

    The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

type PolicyReferenceName:

string

param PolicyReferenceName:

[REQUIRED]

The identifier to be used when working with policy rules.

type Description:

string

param Description:

A description for the Verified Access trust provider.

type TagSpecifications:

list

param TagSpecifications:

The tags to assign to the Verified Access trust provider.

  • (dict) --

    The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

    • ResourceType (string) --

      The type of resource to tag on creation.

    • Tags (list) --

      The tags to apply to the resource.

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

type ClientToken:

string

param ClientToken:

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.

type DryRun:

boolean

param DryRun:

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.

type SseSpecification:

dict

param SseSpecification:

The options for server side encryption.

  • CustomerManagedKeyEnabled (boolean) --

    Enable or disable the use of customer managed KMS keys for server side encryption.

    Valid values: True | False

  • KmsKeyArn (string) --

    The ARN of the KMS key.

rtype:

dict

returns:

Response Syntax

{
    'VerifiedAccessTrustProvider': {
        'VerifiedAccessTrustProviderId': 'string',
        'Description': 'string',
        'TrustProviderType': 'user'|'device',
        'UserTrustProviderType': 'iam-identity-center'|'oidc',
        'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud',
        'OidcOptions': {
            'Issuer': 'string',
            'AuthorizationEndpoint': 'string',
            'TokenEndpoint': 'string',
            'UserInfoEndpoint': 'string',
            'ClientId': 'string',
            'ClientSecret': 'string',
            'Scope': 'string'
        },
        'DeviceOptions': {
            'TenantId': 'string',
            'PublicSigningKeyUrl': 'string'
        },
        'PolicyReferenceName': 'string',
        'CreationTime': 'string',
        'LastUpdatedTime': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SseSpecification': {
            'CustomerManagedKeyEnabled': True|False,
            'KmsKeyArn': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • VerifiedAccessTrustProvider (dict) --

      Details about the Verified Access trust provider.

      • VerifiedAccessTrustProviderId (string) --

        The ID of the Amazon Web Services Verified Access trust provider.

      • Description (string) --

        A description for the Amazon Web Services Verified Access trust provider.

      • TrustProviderType (string) --

        The type of Verified Access trust provider.

      • UserTrustProviderType (string) --

        The type of user-based trust provider.

      • DeviceTrustProviderType (string) --

        The type of device-based trust provider.

      • OidcOptions (dict) --

        The options for an OpenID Connect-compatible user-identity trust provider.

        • Issuer (string) --

          The OIDC issuer.

        • AuthorizationEndpoint (string) --

          The OIDC authorization endpoint.

        • TokenEndpoint (string) --

          The OIDC token endpoint.

        • UserInfoEndpoint (string) --

          The OIDC user info endpoint.

        • ClientId (string) --

          The client identifier.

        • ClientSecret (string) --

          The client secret.

        • Scope (string) --

          The OpenID Connect (OIDC) scope specified.

      • DeviceOptions (dict) --

        The options for device-identity trust provider.

        • TenantId (string) --

          The ID of the tenant application with the device-identity provider.

        • PublicSigningKeyUrl (string) --

          The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

      • PolicyReferenceName (string) --

        The identifier to be used when working with policy rules.

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

      • SseSpecification (dict) --

        The options in use for server side encryption.

        • CustomerManagedKeyEnabled (boolean) --

          Indicates whether customer managed KMS keys are in use for server side encryption.

          Valid values: True | False

        • KmsKeyArn (string) --

          The ARN of the KMS key.

DeleteVerifiedAccessInstance (updated) Link ¶
Changes (response) 
{'VerifiedAccessInstance': {'VerifiedAccessTrustProviders': {'DeviceTrustProviderType': {'jumpcloud'}}}}

Delete an Amazon Web Services Verified Access instance.

See also: AWS API Documentation

Request Syntax

client.delete_verified_access_instance(
    VerifiedAccessInstanceId='string',
    DryRun=True|False,
    ClientToken='string'
)
type VerifiedAccessInstanceId:

string

param VerifiedAccessInstanceId:

[REQUIRED]

The ID of the Verified Access instance.

type DryRun:

boolean

param DryRun:

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.

type ClientToken:

string

param ClientToken:

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.

rtype:

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

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.

DeleteVerifiedAccessTrustProvider (updated) Link ¶
Changes (response) 
{'VerifiedAccessTrustProvider': {'DeviceOptions': {'PublicSigningKeyUrl': 'string'},
                                 'DeviceTrustProviderType': {'jumpcloud'}}}

Delete an Amazon Web Services Verified Access trust provider.

See also: AWS API Documentation

Request Syntax

client.delete_verified_access_trust_provider(
    VerifiedAccessTrustProviderId='string',
    DryRun=True|False,
    ClientToken='string'
)
type VerifiedAccessTrustProviderId:

string

param VerifiedAccessTrustProviderId:

[REQUIRED]

The ID of the Verified Access trust provider.

type DryRun:

boolean

param DryRun:

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.

type ClientToken:

string

param ClientToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'VerifiedAccessTrustProvider': {
        'VerifiedAccessTrustProviderId': 'string',
        'Description': 'string',
        'TrustProviderType': 'user'|'device',
        'UserTrustProviderType': 'iam-identity-center'|'oidc',
        'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud',
        'OidcOptions': {
            'Issuer': 'string',
            'AuthorizationEndpoint': 'string',
            'TokenEndpoint': 'string',
            'UserInfoEndpoint': 'string',
            'ClientId': 'string',
            'ClientSecret': 'string',
            'Scope': 'string'
        },
        'DeviceOptions': {
            'TenantId': 'string',
            'PublicSigningKeyUrl': 'string'
        },
        'PolicyReferenceName': 'string',
        'CreationTime': 'string',
        'LastUpdatedTime': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SseSpecification': {
            'CustomerManagedKeyEnabled': True|False,
            'KmsKeyArn': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • VerifiedAccessTrustProvider (dict) --

      Details about the Verified Access trust provider.

      • VerifiedAccessTrustProviderId (string) --

        The ID of the Amazon Web Services Verified Access trust provider.

      • Description (string) --

        A description for the Amazon Web Services Verified Access trust provider.

      • TrustProviderType (string) --

        The type of Verified Access trust provider.

      • UserTrustProviderType (string) --

        The type of user-based trust provider.

      • DeviceTrustProviderType (string) --

        The type of device-based trust provider.

      • OidcOptions (dict) --

        The options for an OpenID Connect-compatible user-identity trust provider.

        • Issuer (string) --

          The OIDC issuer.

        • AuthorizationEndpoint (string) --

          The OIDC authorization endpoint.

        • TokenEndpoint (string) --

          The OIDC token endpoint.

        • UserInfoEndpoint (string) --

          The OIDC user info endpoint.

        • ClientId (string) --

          The client identifier.

        • ClientSecret (string) --

          The client secret.

        • Scope (string) --

          The OpenID Connect (OIDC) scope specified.

      • DeviceOptions (dict) --

        The options for device-identity trust provider.

        • TenantId (string) --

          The ID of the tenant application with the device-identity provider.

        • PublicSigningKeyUrl (string) --

          The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

      • PolicyReferenceName (string) --

        The identifier to be used when working with policy rules.

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

      • SseSpecification (dict) --

        The options in use for server side encryption.

        • CustomerManagedKeyEnabled (boolean) --

          Indicates whether customer managed KMS keys are in use for server side encryption.

          Valid values: True | False

        • KmsKeyArn (string) --

          The ARN of the KMS key.

DescribeVerifiedAccessInstances (updated) Link ¶
Changes (response) 
{'VerifiedAccessInstances': {'VerifiedAccessTrustProviders': {'DeviceTrustProviderType': {'jumpcloud'}}}}

Describes the specified Amazon Web Services Verified Access instances.

See also: AWS API Documentation

Request Syntax

client.describe_verified_access_instances(
    VerifiedAccessInstanceIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)
type VerifiedAccessInstanceIds:

list

param VerifiedAccessInstanceIds:

The IDs of the Verified Access instances.

  • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type Filters:

list

param Filters:

One or more filters. Filter names and values are case-sensitive.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) --

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'VerifiedAccessInstances': [
        {
            '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
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • VerifiedAccessInstances (list) --

      Details about the Verified Access instances.

      • (dict) --

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

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeVerifiedAccessTrustProviders (updated) Link ¶
Changes (response) 
{'VerifiedAccessTrustProviders': {'DeviceOptions': {'PublicSigningKeyUrl': 'string'},
                                  'DeviceTrustProviderType': {'jumpcloud'}}}

Describes the specified Amazon Web Services Verified Access trust providers.

See also: AWS API Documentation

Request Syntax

client.describe_verified_access_trust_providers(
    VerifiedAccessTrustProviderIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)
type VerifiedAccessTrustProviderIds:

list

param VerifiedAccessTrustProviderIds:

The IDs of the Verified Access trust providers.

  • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type Filters:

list

param Filters:

One or more filters. Filter names and values are case-sensitive.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) --

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'VerifiedAccessTrustProviders': [
        {
            'VerifiedAccessTrustProviderId': 'string',
            'Description': 'string',
            'TrustProviderType': 'user'|'device',
            'UserTrustProviderType': 'iam-identity-center'|'oidc',
            'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud',
            'OidcOptions': {
                'Issuer': 'string',
                'AuthorizationEndpoint': 'string',
                'TokenEndpoint': 'string',
                'UserInfoEndpoint': 'string',
                'ClientId': 'string',
                'ClientSecret': 'string',
                'Scope': 'string'
            },
            'DeviceOptions': {
                'TenantId': 'string',
                'PublicSigningKeyUrl': 'string'
            },
            'PolicyReferenceName': 'string',
            'CreationTime': 'string',
            'LastUpdatedTime': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SseSpecification': {
                'CustomerManagedKeyEnabled': True|False,
                'KmsKeyArn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • VerifiedAccessTrustProviders (list) --

      Details about the Verified Access trust providers.

      • (dict) --

        Describes a Verified Access trust provider.

        • VerifiedAccessTrustProviderId (string) --

          The ID of the Amazon Web Services Verified Access trust provider.

        • Description (string) --

          A description for the Amazon Web Services Verified Access trust provider.

        • TrustProviderType (string) --

          The type of Verified Access trust provider.

        • UserTrustProviderType (string) --

          The type of user-based trust provider.

        • DeviceTrustProviderType (string) --

          The type of device-based trust provider.

        • OidcOptions (dict) --

          The options for an OpenID Connect-compatible user-identity trust provider.

          • Issuer (string) --

            The OIDC issuer.

          • AuthorizationEndpoint (string) --

            The OIDC authorization endpoint.

          • TokenEndpoint (string) --

            The OIDC token endpoint.

          • UserInfoEndpoint (string) --

            The OIDC user info endpoint.

          • ClientId (string) --

            The client identifier.

          • ClientSecret (string) --

            The client secret.

          • Scope (string) --

            The OpenID Connect (OIDC) scope specified.

        • DeviceOptions (dict) --

          The options for device-identity trust provider.

          • TenantId (string) --

            The ID of the tenant application with the device-identity provider.

          • PublicSigningKeyUrl (string) --

            The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

        • PolicyReferenceName (string) --

          The identifier to be used when working with policy rules.

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

        • SseSpecification (dict) --

          The options in use for server side encryption.

          • CustomerManagedKeyEnabled (boolean) --

            Indicates whether customer managed KMS keys are in use for server side encryption.

            Valid values: True | False

          • KmsKeyArn (string) --

            The ARN of the KMS key.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DetachVerifiedAccessTrustProvider (updated) Link ¶
Changes (response) 
{'VerifiedAccessInstance': {'VerifiedAccessTrustProviders': {'DeviceTrustProviderType': {'jumpcloud'}}},
 'VerifiedAccessTrustProvider': {'DeviceOptions': {'PublicSigningKeyUrl': 'string'},
                                 'DeviceTrustProviderType': {'jumpcloud'}}}

Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.

See also: AWS API Documentation

Request Syntax

client.detach_verified_access_trust_provider(
    VerifiedAccessInstanceId='string',
    VerifiedAccessTrustProviderId='string',
    ClientToken='string',
    DryRun=True|False
)
type VerifiedAccessInstanceId:

string

param VerifiedAccessInstanceId:

[REQUIRED]

The ID of the Verified Access instance.

type VerifiedAccessTrustProviderId:

string

param VerifiedAccessTrustProviderId:

[REQUIRED]

The ID of the Verified Access trust provider.

type ClientToken:

string

param ClientToken:

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.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'VerifiedAccessTrustProvider': {
        'VerifiedAccessTrustProviderId': 'string',
        'Description': 'string',
        'TrustProviderType': 'user'|'device',
        'UserTrustProviderType': 'iam-identity-center'|'oidc',
        'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud',
        'OidcOptions': {
            'Issuer': 'string',
            'AuthorizationEndpoint': 'string',
            'TokenEndpoint': 'string',
            'UserInfoEndpoint': 'string',
            'ClientId': 'string',
            'ClientSecret': 'string',
            'Scope': 'string'
        },
        'DeviceOptions': {
            'TenantId': 'string',
            'PublicSigningKeyUrl': 'string'
        },
        'PolicyReferenceName': 'string',
        'CreationTime': 'string',
        'LastUpdatedTime': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SseSpecification': {
            'CustomerManagedKeyEnabled': True|False,
            'KmsKeyArn': 'string'
        }
    },
    '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
    }
}

Response Structure

  • (dict) --

    • VerifiedAccessTrustProvider (dict) --

      Details about the Verified Access trust provider.

      • VerifiedAccessTrustProviderId (string) --

        The ID of the Amazon Web Services Verified Access trust provider.

      • Description (string) --

        A description for the Amazon Web Services Verified Access trust provider.

      • TrustProviderType (string) --

        The type of Verified Access trust provider.

      • UserTrustProviderType (string) --

        The type of user-based trust provider.

      • DeviceTrustProviderType (string) --

        The type of device-based trust provider.

      • OidcOptions (dict) --

        The options for an OpenID Connect-compatible user-identity trust provider.

        • Issuer (string) --

          The OIDC issuer.

        • AuthorizationEndpoint (string) --

          The OIDC authorization endpoint.

        • TokenEndpoint (string) --

          The OIDC token endpoint.

        • UserInfoEndpoint (string) --

          The OIDC user info endpoint.

        • ClientId (string) --

          The client identifier.

        • ClientSecret (string) --

          The client secret.

        • Scope (string) --

          The OpenID Connect (OIDC) scope specified.

      • DeviceOptions (dict) --

        The options for device-identity trust provider.

        • TenantId (string) --

          The ID of the tenant application with the device-identity provider.

        • PublicSigningKeyUrl (string) --

          The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

      • PolicyReferenceName (string) --

        The identifier to be used when working with policy rules.

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

      • SseSpecification (dict) --

        The options in use for server side encryption.

        • CustomerManagedKeyEnabled (boolean) --

          Indicates whether customer managed KMS keys are in use for server side encryption.

          Valid values: True | False

        • KmsKeyArn (string) --

          The ARN of the KMS key.

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

ModifyVerifiedAccessInstance (updated) Link ¶
Changes (response) 
{'VerifiedAccessInstance': {'VerifiedAccessTrustProviders': {'DeviceTrustProviderType': {'jumpcloud'}}}}

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

See also: AWS API Documentation

Request Syntax

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

string

param VerifiedAccessInstanceId:

[REQUIRED]

The ID of the Verified Access instance.

type Description:

string

param Description:

A description for the Verified Access instance.

type DryRun:

boolean

param DryRun:

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.

type ClientToken:

string

param ClientToken:

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.

rtype:

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

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.

ModifyVerifiedAccessTrustProvider (updated) Link ¶
Changes (request, response)
Request 
{'DeviceOptions': {'PublicSigningKeyUrl': 'string'}}
Response 
{'VerifiedAccessTrustProvider': {'DeviceOptions': {'PublicSigningKeyUrl': 'string'},
                                 'DeviceTrustProviderType': {'jumpcloud'}}}

Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.

See also: AWS API Documentation

Request Syntax

client.modify_verified_access_trust_provider(
    VerifiedAccessTrustProviderId='string',
    OidcOptions={
        'Issuer': 'string',
        'AuthorizationEndpoint': 'string',
        'TokenEndpoint': 'string',
        'UserInfoEndpoint': 'string',
        'ClientId': 'string',
        'ClientSecret': 'string',
        'Scope': 'string'
    },
    DeviceOptions={
        'PublicSigningKeyUrl': 'string'
    },
    Description='string',
    DryRun=True|False,
    ClientToken='string',
    SseSpecification={
        'CustomerManagedKeyEnabled': True|False,
        'KmsKeyArn': 'string'
    }
)
type VerifiedAccessTrustProviderId:

string

param VerifiedAccessTrustProviderId:

[REQUIRED]

The ID of the Verified Access trust provider.

type OidcOptions:

dict

param OidcOptions:

The options for an OpenID Connect-compatible user-identity trust provider.

  • Issuer (string) --

    The OIDC issuer.

  • AuthorizationEndpoint (string) --

    The OIDC authorization endpoint.

  • TokenEndpoint (string) --

    The OIDC token endpoint.

  • UserInfoEndpoint (string) --

    The OIDC user info endpoint.

  • ClientId (string) --

    The client identifier.

  • ClientSecret (string) --

    The client secret.

  • Scope (string) --

    OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

type DeviceOptions:

dict

param DeviceOptions:

The options for a device-based trust provider. This parameter is required when the provider type is device.

  • PublicSigningKeyUrl (string) --

    The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

type Description:

string

param Description:

A description for the Verified Access trust provider.

type DryRun:

boolean

param DryRun:

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.

type ClientToken:

string

param ClientToken:

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.

type SseSpecification:

dict

param SseSpecification:

The options for server side encryption.

  • CustomerManagedKeyEnabled (boolean) --

    Enable or disable the use of customer managed KMS keys for server side encryption.

    Valid values: True | False

  • KmsKeyArn (string) --

    The ARN of the KMS key.

rtype:

dict

returns:

Response Syntax

{
    'VerifiedAccessTrustProvider': {
        'VerifiedAccessTrustProviderId': 'string',
        'Description': 'string',
        'TrustProviderType': 'user'|'device',
        'UserTrustProviderType': 'iam-identity-center'|'oidc',
        'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud',
        'OidcOptions': {
            'Issuer': 'string',
            'AuthorizationEndpoint': 'string',
            'TokenEndpoint': 'string',
            'UserInfoEndpoint': 'string',
            'ClientId': 'string',
            'ClientSecret': 'string',
            'Scope': 'string'
        },
        'DeviceOptions': {
            'TenantId': 'string',
            'PublicSigningKeyUrl': 'string'
        },
        'PolicyReferenceName': 'string',
        'CreationTime': 'string',
        'LastUpdatedTime': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SseSpecification': {
            'CustomerManagedKeyEnabled': True|False,
            'KmsKeyArn': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • VerifiedAccessTrustProvider (dict) --

      Details about the Verified Access trust provider.

      • VerifiedAccessTrustProviderId (string) --

        The ID of the Amazon Web Services Verified Access trust provider.

      • Description (string) --

        A description for the Amazon Web Services Verified Access trust provider.

      • TrustProviderType (string) --

        The type of Verified Access trust provider.

      • UserTrustProviderType (string) --

        The type of user-based trust provider.

      • DeviceTrustProviderType (string) --

        The type of device-based trust provider.

      • OidcOptions (dict) --

        The options for an OpenID Connect-compatible user-identity trust provider.

        • Issuer (string) --

          The OIDC issuer.

        • AuthorizationEndpoint (string) --

          The OIDC authorization endpoint.

        • TokenEndpoint (string) --

          The OIDC token endpoint.

        • UserInfoEndpoint (string) --

          The OIDC user info endpoint.

        • ClientId (string) --

          The client identifier.

        • ClientSecret (string) --

          The client secret.

        • Scope (string) --

          The OpenID Connect (OIDC) scope specified.

      • DeviceOptions (dict) --

        The options for device-identity trust provider.

        • TenantId (string) --

          The ID of the tenant application with the device-identity provider.

        • PublicSigningKeyUrl (string) --

          The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.

      • PolicyReferenceName (string) --

        The identifier to be used when working with policy rules.

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

      • SseSpecification (dict) --

        The options in use for server side encryption.

        • CustomerManagedKeyEnabled (boolean) --

          Indicates whether customer managed KMS keys are in use for server side encryption.

          Valid values: True | False

        • KmsKeyArn (string) --

          The ARN of the KMS key.