Skip to content

describe_inbound_integrations

describe_inbound_integrations(
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    integration_arn: Optional[InboundIntegrationArn] = None,
    target_arn: Optional[TargetArn] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> InboundIntegrationsMessage

Returns a list of inbound integrations.

Parameters:

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

    The Amazon Resource Name (ARN) of the inbound integration.

  • target_arn (Optional[TargetArn], default: None ) –

    The Amazon Resource Name (ARN) of the target of an inbound 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 parameter that specifies the starting point to return a set of response records. When the results of a DescribeInboundIntegrations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Raises:

Source code in docs_src/capo_redshift/_services/redshift.py
def describe_inbound_integrations(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    integration_arn: Optional[
        "capo_redshift.types.inbound_integration_arn.InboundIntegrationArn"
    ] = None,
    target_arn: Optional["capo_redshift.types.target_arn.TargetArn"] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.inbound_integrations_message.InboundIntegrationsMessage":
    """<p>Returns a list of inbound integrations.</p>

    Args:
        integration_arn: <p>The Amazon Resource Name (ARN) of the inbound integration.</p>
        target_arn: <p>The Amazon Resource Name (ARN) of the target of an inbound 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 parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeInboundIntegrations</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>

    Raises:
        capo_redshift.errors.integration_not_found_fault.IntegrationNotFoundFault: <p>The integration can't be found.</p>
        capo_redshift.errors.invalid_namespace_fault.InvalidNamespaceFault: <p>The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.</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_inbound_integrations_message.DescribeInboundIntegrationsMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.inbound_integrations_message.InboundIntegrationsMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_inbound_integrations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeInboundIntegrations")
    )
    input_: capo_redshift.types.describe_inbound_integrations_message.DescribeInboundIntegrationsMessage = {}
    if integration_arn is not None:
        input_["integration_arn"] = integration_arn
    if target_arn is not None:
        input_["target_arn"] = target_arn
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

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