Skip to content

describe_integrations

describe_integrations(
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    integration_arn: Optional[IntegrationArn] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
    filters: Optional[DescribeIntegrationsFilterList] = None,
) -> IntegrationsMessage

Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.

Parameters:

  • integration_arn (Optional[IntegrationArn], default: None ) –

    The unique identifier of the integration.

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

    Default: 100

    Constraints: minimum 20, maximum 100.

  • marker (Optional[String], default: None ) –

    An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • filters (Optional[DescribeIntegrationsFilterList], default: None ) –

    A filter that specifies one or more resources to return.

Raises:

Source code in docs_src/capo_redshift/_services/redshift.py
def describe_integrations(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    integration_arn: Optional[
        "capo_redshift.types.integration_arn.IntegrationArn"
    ] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
    filters: Optional[
        "capo_redshift.types.describe_integrations_filter_list.DescribeIntegrationsFilterList"
    ] = None,
) -> "capo_redshift.types.integrations_message.IntegrationsMessage":
    """<p>Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.</p>

    Args:
        integration_arn: <p>The unique identifier of the integration.</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 <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>
        marker: <p>An optional pagination token provided by a previous <code>DescribeIntegrations</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
        filters: <p>A filter that specifies one or more resources to return.</p>

    Raises:
        capo_redshift.errors.integration_not_found_fault.IntegrationNotFoundFault: <p>The integration can't be found.</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_integrations_message.DescribeIntegrationsMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.integrations_message.IntegrationsMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_integrations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIntegrations")
    )
    input_: capo_redshift.types.describe_integrations_message.DescribeIntegrationsMessage = {}
    if integration_arn is not None:
        input_["integration_arn"] = integration_arn
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker
    if filters is not None:
        input_["filters"] = filters

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