describe_qev2_idc_applications ¶

def describe_qev2_idc_applications(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    qev2_idc_application_arn: Optional["capo_redshift.types.string.String"] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.describe_qev2_idc_applications_result.DescribeQev2IdcApplicationsResult":
    """<p>Lists the Amazon Redshift Query Editor (QEV2) IAM Identity Center applications. To retrieve additional results, use the MaxRecords and Marker parameters.</p>

    Args:
        qev2_idc_application_arn: <p>The Amazon Resource Name (ARN) for the Amazon Redshift Query Editor (QEV2) application that integrates with IAM Identity Center.</p>
        max_records: <p>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.</p>
        marker: <p>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. </p>

    Raises:
        capo_redshift.errors.dependent_service_access_denied_fault.DependentServiceAccessDeniedFault: <p>A dependent service denied access for the integration.</p>
        capo_redshift.errors.dependent_service_unavailable_fault.DependentServiceUnavailableFault: <p>Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.</p>
        capo_redshift.errors.qev2_idc_application_not_exists_fault.Qev2IdcApplicationNotExistsFault: <p>The specified Amazon Redshift Query Editor (QEV2) IAM Identity Center application doesn't exist. Verify that the application ARN is correct and that the application exists in this Region.</p>
        capo_redshift.errors.unsupported_operation_fault.UnsupportedOperationFault: <p>The requested operation isn't supported.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift.types.describe_qev2_idc_applications_message.DescribeQev2IdcApplicationsMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.describe_qev2_idc_applications_result.DescribeQev2IdcApplicationsResult"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_qev2_idc_applications

        output, http_response = (
            capo_redshift._operations.redshift_service_version20121201.describe_qev2_idc_applications.describe_qev2_idc_applications(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeQev2IdcApplications")
    )
    input_: capo_redshift.types.describe_qev2_idc_applications_message.DescribeQev2IdcApplicationsMessage = {}
    if qev2_idc_application_arn is not None:
        input_["qev2_idc_application_arn"] = qev2_idc_application_arn
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output