EC2 / Paginator / DescribeVerifiedAccessTrustProviders

DescribeVerifiedAccessTrustProviders

class EC2.Paginator.DescribeVerifiedAccessTrustProviders

paginator = client.get_paginator('describe_verified_access_trust_providers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_verified_access_trust_providers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    VerifiedAccessTrustProviderIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• VerifiedAccessTrustProviderIds (list) –

  The IDs of the Verified Access trust providers.

  • (string) –

• Filters (list) –

  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.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • 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) –

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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'
            },
            'NativeApplicationOidcOptions': {
                'PublicSigningKeyEndpoint': 'string',
                'Issuer': 'string',
                'AuthorizationEndpoint': 'string',
                'TokenEndpoint': 'string',
                'UserInfoEndpoint': 'string',
                'ClientId': 'string',
                'Scope': '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.

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