Skip to content

describe_integrations

Operation

describe_integrations

describe_integrations(request: DescribeIntegrationsInput | DescribeIntegrationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIntegrationsInputDict]) -> DescribeIntegrationsOutput

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

Parameters:

Name Type Description Default
request DescribeIntegrationsInput | DescribeIntegrationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeIntegrationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIntegrationsOutput

An instance of DescribeIntegrationsOutput.

describe_integrations async

describe_integrations(request: DescribeIntegrationsInput | DescribeIntegrationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIntegrationsInputDict]) -> DescribeIntegrationsOutput

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

Parameters:

Name Type Description Default
request DescribeIntegrationsInput | DescribeIntegrationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeIntegrationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeIntegrationsOutput

An instance of DescribeIntegrationsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeIntegrationsInputDict

Bases: TypedDict

Dictionary form of DescribeIntegrationsInput.

Attributes

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

A filter that specifies one or more resources to return.

integration_identifier instance-attribute
integration_identifier: str | None

The unique identifier of the integration.

marker instance-attribute
marker: str | 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.

max_records instance-attribute
max_records: int | 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.

DescribeIntegrationsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeIntegrationsInput structure.

Attributes

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

A filter that specifies one or more resources to return.

integration_identifier class-attribute instance-attribute
integration_identifier: str | None = ...

The unique identifier of the integration.

marker class-attribute instance-attribute
marker: str | 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.

max_records class-attribute instance-attribute
max_records: int | 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.

Output

DescribeIntegrationsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeIntegrationsOutput structure.

Attributes

integrations class-attribute instance-attribute
integrations: list[Integration] | None = ...

A list of integrations.

marker class-attribute instance-attribute
marker: str | None = ...

A pagination token that can be used in a later DescribeIntegrations request.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.