Redshift / Client / modify_qev2_idc_application

modify_qev2_idc_application

Redshift.Client.modify_qev2_idc_application(**kwargs)

Modifies an Amazon Redshift Query Editor (QEV2) IAM Identity Center application.

See also: AWS API Documentation

Request Syntax

response = client.modify_qev2_idc_application(
    Qev2IdcApplicationArn='string',
    IdcDisplayName='string'
)
Parameters:

  • Qev2IdcApplicationArn (string) –

    [REQUIRED]

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

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

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

Exceptions