Skip to content

list_gateway_cluster_associations

Operation

list_gateway_cluster_associations

list_gateway_cluster_associations(request: ListGatewayClusterAssociationsInput | ListGatewayClusterAssociationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayClusterAssociationsInputDict]) -> ListGatewayClusterAssociationsOutput

Returns a list of the associations between gateways and clusters. You can filter the results by gateway, cluster, and status. The results are paginated. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

Parameters:

Name Type Description Default
request ListGatewayClusterAssociationsInput | ListGatewayClusterAssociationsInputDict | 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[ListGatewayClusterAssociationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListGatewayClusterAssociationsOutput

An instance of ListGatewayClusterAssociationsOutput.

list_gateway_cluster_associations async

list_gateway_cluster_associations(request: ListGatewayClusterAssociationsInput | ListGatewayClusterAssociationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayClusterAssociationsInputDict]) -> ListGatewayClusterAssociationsOutput

Returns a list of the associations between gateways and clusters. You can filter the results by gateway, cluster, and status. The results are paginated. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

Parameters:

Name Type Description Default
request ListGatewayClusterAssociationsInput | ListGatewayClusterAssociationsInputDict | 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[ListGatewayClusterAssociationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListGatewayClusterAssociationsOutput

An instance of ListGatewayClusterAssociationsOutput.

Input

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

ListGatewayClusterAssociationsInputDict

Bases: TypedDict

Dictionary form of ListGatewayClusterAssociationsInput.

Attributes

cluster instance-attribute
cluster: str | None

The name or Amazon Resource Name (ARN) of a cluster to filter the results by.

gateway instance-attribute
gateway: str | None

The name or Amazon Resource Name (ARN) of a gateway to filter the results by.

max_results instance-attribute
max_results: int | None

The maximum number of results that the operation returns in a single page. The default is 100.

next_token instance-attribute
next_token: str | None

The nextToken value returned from a previous paginated request.

status instance-attribute
status: Sequence[str] | None

The association status to filter the results by.

ListGatewayClusterAssociationsInput dataclass

Bases: _SerdeShape

Dataclass for ListGatewayClusterAssociationsInput structure.

Attributes

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

The name or Amazon Resource Name (ARN) of a cluster to filter the results by.

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

The name or Amazon Resource Name (ARN) of a gateway to filter the results by.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results that the operation returns in a single page. The default is 100.

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

The nextToken value returned from a previous paginated request.

status class-attribute instance-attribute
status: list[str] | None = ...

The association status to filter the results by.

Output

ListGatewayClusterAssociationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListGatewayClusterAssociationsOutput structure.

Attributes

gateway_cluster_associations class-attribute instance-attribute
gateway_cluster_associations: list[GatewayClusterAssociationSummary] | None = ...

The gateway-cluster associations that match the request.

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

The nextToken value to include in a future request to retrieve the next page of results. This value is null when there are no more results to return.

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.