Skip to content

EC2  >  Operations  >  create_verified_access_trust_provider

create_verified_access_trust_provider

Operation

create_verified_access_trust_provider async

create_verified_access_trust_provider(request: CreateVerifiedAccessTrustProviderInput | CreateVerifiedAccessTrustProviderInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateVerifiedAccessTrustProviderOutput
create_verified_access_trust_provider(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateVerifiedAccessTrustProviderInputDict]) -> CreateVerifiedAccessTrustProviderOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateVerifiedAccessTrustProviderOutput

An instance of CreateVerifiedAccessTrustProviderOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateVerifiedAccessTrustProviderInput dataclass

Bases: _SerdeShape

Dataclass for CreateVerifiedAccessTrustProviderInput structure.

Attributes
client_token class-attribute instance-attribute
client_token: str | None = ...

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.

description class-attribute instance-attribute
description: str | None = ...

A description for the Verified Access trust provider.

device_options class-attribute instance-attribute

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

device_trust_provider_type class-attribute instance-attribute
device_trust_provider_type: str | None = ...

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

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

native_application_oidc_options class-attribute instance-attribute
native_application_oidc_options: CreateVerifiedAccessNativeApplicationOidcOptions | None = ...

The OpenID Connect (OIDC) options.

oidc_options class-attribute instance-attribute

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

policy_reference_name class-attribute instance-attribute
policy_reference_name: str | None = ...

The identifier to be used when working with policy rules.

sse_specification class-attribute instance-attribute
sse_specification: VerifiedAccessSseSpecificationRequest | None = ...

The options for server side encryption.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to assign to the Verified Access trust provider.

trust_provider_type class-attribute instance-attribute
trust_provider_type: str | None = ...

The type of trust provider.

user_trust_provider_type class-attribute instance-attribute
user_trust_provider_type: str | None = ...

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

Dictionaries

CreateVerifiedAccessTrustProviderInputDict

Bases: TypedDict

Dictionary form of CreateVerifiedAccessTrustProviderInput.

Attributes
client_token instance-attribute
client_token: str | None

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.

description instance-attribute
description: str | None

A description for the Verified Access trust provider.

device_options instance-attribute

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

device_trust_provider_type instance-attribute
device_trust_provider_type: str | None

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

dry_run instance-attribute
dry_run: bool | None

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.

native_application_oidc_options instance-attribute

The OpenID Connect (OIDC) options.

oidc_options instance-attribute

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

policy_reference_name instance-attribute
policy_reference_name: Required[str]

The identifier to be used when working with policy rules.

sse_specification instance-attribute

The options for server side encryption.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

The tags to assign to the Verified Access trust provider.

trust_provider_type instance-attribute
trust_provider_type: Required[str]

The type of trust provider.

user_trust_provider_type instance-attribute
user_trust_provider_type: str | None

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

Output

CreateVerifiedAccessTrustProviderOutput dataclass

Bases: _SerdeShape

Dataclass for CreateVerifiedAccessTrustProviderOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

verified_access_trust_provider class-attribute instance-attribute
verified_access_trust_provider: VerifiedAccessTrustProvider | None = ...

Details about the Verified Access trust provider.