Redshift / Paginator / DescribeQev2IdcApplications

DescribeQev2IdcApplications

class Redshift.Paginator.DescribeQev2IdcApplications
paginator = client.get_paginator('describe_qev2_idc_applications')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_qev2_idc_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Qev2IdcApplicationArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • Qev2IdcApplicationArn (string) – The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center.

  • 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

{
    'Qev2IdcApplications': [
        {
            'IdcInstanceArn': 'string',
            'Qev2IdcApplicationName': 'string',
            'Qev2IdcApplicationArn': 'string',
            'IdcManagedApplicationArn': 'string',
            'IdcOnboardStatus': 'string',
            'IdcDisplayName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Qev2IdcApplications (list) –

      The list of Amazon Redshift Query Editor (QEV2) IAM Identity Center applications.

      • (dict) –

        Contains configuration and status information for an Amazon Redshift Query Editor (QEV2) application that is registered with IAM Identity Center.

        • IdcInstanceArn (string) –

          The Amazon Resource Name (ARN) for the IAM Identity Center instance that the Amazon Redshift Query Editor (QEV2) application integrates with.

        • Qev2IdcApplicationName (string) –

          The name of the Amazon Redshift Query Editor (QEV2) application in IAM Identity Center.

        • Qev2IdcApplicationArn (string) –

          The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center.

        • IdcManagedApplicationArn (string) –

          The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) IAM Identity Center managed application.

        • IdcOnboardStatus (string) –

          The onboarding status for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application.

        • IdcDisplayName (string) –

          The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console.

        • Tags (list) –

          A list of tags associated with the application. Tags are key-value pairs that you can use to organize and identify your resources.

          • (dict) –

            A tag consisting of a name/value pair for a resource.

            • Key (string) –

              The key, or name, for the resource tag.

            • Value (string) –

              The value for the resource tag.

    • NextToken (string) –

      A token to resume pagination.