Redshift / Client / describe_qev2_idc_applications

describe_qev2_idc_applications

Redshift.Client.describe_qev2_idc_applications(**kwargs)

Lists the Amazon Redshift Query Editor (QEV2) IAM Identity Center applications. To retrieve additional results, use the MaxRecords and Marker parameters.

See also: AWS API Documentation

Request Syntax

response = client.describe_qev2_idc_applications(
    Qev2IdcApplicationArn='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

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

  • MaxRecords (integer) – The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  • Marker (string) – A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Return type:

dict

Returns:

Response Syntax

{
    'Qev2IdcApplications': [
        {
            'IdcInstanceArn': 'string',
            'Qev2IdcApplicationName': 'string',
            'Qev2IdcApplicationArn': 'string',
            'IdcManagedApplicationArn': 'string',
            'IdcOnboardStatus': 'string',
            'IdcDisplayName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'Marker': '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.

    • Marker (string) –

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Exceptions