Skip to content

describe_integrations async

describe_integrations(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    integration_identifier: Optional[IntegrationIdentifier] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[Marker] = None,
) -> DescribeIntegrationsResponse

Describe one or more zero-ETL integrations with Amazon Redshift.

Parameters:

  • integration_identifier (Optional[IntegrationIdentifier], default: None ) –

    The unique identifier of the integration.

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

    A filter that specifies one or more resources to return.

  • max_records (Optional[IntegerOptional], default: None ) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • marker (Optional[Marker], 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.

Raises:

Examples:

To describe a zero-ETL integration The following example retrieves information about a zero-ETL integration with Amazon Redshift.

>>> await client.describe_integrations(integration_identifier='5b9f3d79-7392-4a3e-896c-58eaa1b53231')
Source code in docs_src/capo_rds/_services/async_rds.py
async def describe_integrations(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    integration_identifier: Optional[
        "capo_rds.types.integration_identifier.IntegrationIdentifier"
    ] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
    marker: Optional["capo_rds.types.marker.Marker"] = None,
) -> "capo_rds.types.describe_integrations_response.DescribeIntegrationsResponse":
    """<p>Describe one or more zero-ETL integrations with Amazon Redshift.</p>

    Args:
        integration_identifier: <p>The unique identifier of the integration.</p>
        filters: <p>A filter that specifies one or more resources to return.</p>
        max_records: <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p> <p>Default: 100</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>

    Raises:
        capo_rds.errors.integration_not_found_fault.IntegrationNotFoundFault: <p>The specified integration could not be found.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe a zero-ETL integration
        The following example retrieves information about a zero-ETL integration with Amazon Redshift.

        >>> await client.describe_integrations(integration_identifier='5b9f3d79-7392-4a3e-896c-58eaa1b53231')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.describe_integrations_message.DescribeIntegrationsMessage]",
    ) -> AsyncOperationResponse[
        "capo_rds.types.describe_integrations_response.DescribeIntegrationsResponse"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_integrations

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.describe_integrations.async_describe_integrations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIntegrations")
    )
    input_: capo_rds.types.describe_integrations_message.DescribeIntegrationsMessage = {}
    if integration_identifier is not None:
        input_["integration_identifier"] = integration_identifier
    if filters is not None:
        input_["filters"] = filters
    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