describe_partners ¶

def describe_partners(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    account_id: Optional[
        "capo_redshift.types.partner_integration_account_id.PartnerIntegrationAccountId"
    ] = None,
    cluster_identifier: Optional[
        "capo_redshift.types.partner_integration_cluster_identifier.PartnerIntegrationClusterIdentifier"
    ] = None,
    database_name: Optional[
        "capo_redshift.types.partner_integration_database_name.PartnerIntegrationDatabaseName"
    ] = None,
    partner_name: Optional[
        "capo_redshift.types.partner_integration_partner_name.PartnerIntegrationPartnerName"
    ] = None,
) -> "capo_redshift.types.describe_partners_output_message.DescribePartnersOutputMessage":
    """<p>Returns information about the partner integrations defined for a cluster.</p>

    Args:
        account_id: <p>The Amazon Web Services account ID that owns the cluster.</p>
        cluster_identifier: <p>The cluster identifier of the cluster whose partner integration is being described.</p>
        database_name: <p>The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.</p>
        partner_name: <p>The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.</p>

    Raises:
        capo_redshift.errors.cluster_not_found_fault.ClusterNotFoundFault: <p>The <code>ClusterIdentifier</code> parameter does not refer to an existing cluster. </p>
        capo_redshift.errors.unauthorized_partner_integration_fault.UnauthorizedPartnerIntegrationFault: <p>The partner integration is not authorized.</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_partners_input_message.DescribePartnersInputMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.describe_partners_output_message.DescribePartnersOutputMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_partners

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePartners")
    )
    input_: capo_redshift.types.describe_partners_input_message.DescribePartnersInputMessage = {}
    if account_id is not None:
        input_["account_id"] = account_id
    if cluster_identifier is not None:
        input_["cluster_identifier"] = cluster_identifier
    if database_name is not None:
        input_["database_name"] = database_name
    if partner_name is not None:
        input_["partner_name"] = partner_name

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