describe_redshift_idc_applications `async` ¶

describe_redshift_idc_applications(
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    redshift_idc_application_arn: Optional[String] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeRedshiftIdcApplicationsResult

Lists the Amazon Redshift IAM Identity Center applications.

Parameters:

redshift_idc_application_arn (Optional[String], default: None ) –

The ARN for the Redshift application that integrates with IAM Identity Center.
max_records (Optional[IntegerOptional], default: None ) –

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 (Optional[String], default: None ) –

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.

Raises:

DependentServiceAccessDeniedFault –

A dependent service denied access for the integration.
DependentServiceUnavailableFault –

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
RedshiftIdcApplicationNotExistsFault –

The application you attempted to find doesn't exist.
UnsupportedOperationFault –

The requested operation isn't supported.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_redshift/_services/async_redshift.py

async def describe_redshift_idc_applications(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    redshift_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_redshift_idc_applications_result.DescribeRedshiftIdcApplicationsResult":
    """<p>Lists the Amazon Redshift IAM Identity Center applications.</p>

    Args:
        redshift_idc_application_arn: <p>The ARN for the Redshift 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.redshift_idc_application_not_exists_fault.RedshiftIdcApplicationNotExistsFault: <p>The application you attempted to find doesn't exist.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift.types.describe_redshift_idc_applications_message.DescribeRedshiftIdcApplicationsMessage]",
    ) -> AsyncOperationResponse[
        "capo_redshift.types.describe_redshift_idc_applications_result.DescribeRedshiftIdcApplicationsResult"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_redshift_idc_applications

        (
            output,
            http_response,
        ) = await capo_redshift._operations.redshift_service_version20121201.describe_redshift_idc_applications.async_describe_redshift_idc_applications(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRedshiftIdcApplications")
    )
    input_: capo_redshift.types.describe_redshift_idc_applications_message.DescribeRedshiftIdcApplicationsMessage = {}
    if redshift_idc_application_arn is not None:
        input_["redshift_idc_application_arn"] = redshift_idc_application_arn
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_redshift_idc_applications async ¶

describe_redshift_idc_applications `async` ¶