Skip to content

modify_integration async

modify_integration(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    integration_identifier: Optional[IntegrationIdentifier] = None,
    integration_name: Optional[IntegrationName] = None,
    data_filter: Optional[DataFilter] = None,
    description: Optional[IntegrationDescription] = None,
) -> Integration

Modifies a zero-ETL integration with Amazon Redshift.

Parameters:

Raises:

  • IntegrationConflictOperationFault –

    A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.

  • IntegrationNotFoundFault –

    The specified integration could not be found.

  • InvalidIntegrationStateFault –

    The integration is in an invalid state and can't perform the requested operation.

  • UnknownServiceError –

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

Examples:

To modify a zero-ETL integration The following example modifies the name of an existing zero-ETL integration.

>>> await client.modify_integration(integration_identifier='a1b2c3d4-5678-90ab-cdef-EXAMPLE11111', integration_name='my-renamed-integration')
Source code in docs_src/capo_rds/_services/async_rds.py
async def modify_integration(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    integration_identifier: Optional[
        "capo_rds.types.integration_identifier.IntegrationIdentifier"
    ] = None,
    integration_name: Optional[
        "capo_rds.types.integration_name.IntegrationName"
    ] = None,
    data_filter: Optional["capo_rds.types.data_filter.DataFilter"] = None,
    description: Optional[
        "capo_rds.types.integration_description.IntegrationDescription"
    ] = None,
) -> "capo_rds.types.integration.Integration":
    """<p>Modifies a zero-ETL integration with Amazon Redshift.</p>

    Args:
        integration_identifier: <p>The unique identifier of the integration to modify.</p>
        integration_name: <p>A new name for the integration.</p>
        data_filter: <p>A new data filter for the integration. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a> or <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html">Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.</p>
        description: <p>A new description for the integration.</p>

    Raises:
        capo_rds.errors.integration_conflict_operation_fault.IntegrationConflictOperationFault: <p>A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.</p>
        capo_rds.errors.integration_not_found_fault.IntegrationNotFoundFault: <p>The specified integration could not be found.</p>
        capo_rds.errors.invalid_integration_state_fault.InvalidIntegrationStateFault: <p>The integration is in an invalid state and can't perform the requested operation.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To modify a zero-ETL integration
        The following example modifies the name of an existing zero-ETL integration.

        >>> await client.modify_integration(integration_identifier='a1b2c3d4-5678-90ab-cdef-EXAMPLE11111', integration_name='my-renamed-integration')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.modify_integration_message.ModifyIntegrationMessage]",
    ) -> AsyncOperationResponse["capo_rds.types.integration.Integration"]:
        import capo_rds._operations.amazon_rd_sv19.modify_integration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyIntegration")
    )
    input_: capo_rds.types.modify_integration_message.ModifyIntegrationMessage = {}
    if integration_identifier is not None:
        input_["integration_identifier"] = integration_identifier
    if integration_name is not None:
        input_["integration_name"] = integration_name
    if data_filter is not None:
        input_["data_filter"] = data_filter
    if description is not None:
        input_["description"] = description

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