EC2 / Client / attach_verified_access_trust_provider

attach_verified_access_trust_provider#

EC2.Client.attach_verified_access_trust_provider(**kwargs)#

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

Request Syntax

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

Parameters:

VerifiedAccessInstanceId (string) –
[REQUIRED]

The ID of the Verified Access instance.
VerifiedAccessTrustProviderId (string) –
[REQUIRED]

The ID of the Verified Access trust provider.
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.
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

{
    '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'
        },
        'NativeApplicationOidcOptions': {
            'PublicSigningKeyEndpoint': 'string',
            'Issuer': 'string',
            'AuthorizationEndpoint': 'string',
            'TokenEndpoint': 'string',
            'UserInfoEndpoint': 'string',
            'ClientId': 'string',
            'Scope': '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,
        'CidrEndpointsCustomSubDomain': {
            'SubDomain': 'string',
            'Nameservers': [
                '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.
  - NativeApplicationOidcOptions (dict) –
    
    The OpenID Connect (OIDC) options.
    - PublicSigningKeyEndpoint (string) –
      
      The public signing key endpoint.
    - Issuer (string) –
      
      The OIDC issuer identifier of the IdP.
    - AuthorizationEndpoint (string) –
      
      The authorization endpoint of the IdP.
    - 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.
    - Scope (string) –
      
      The set of user claims to be requested from the IdP.
- 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) –