Skip to content

list_target_groups async

list_target_groups(
    *,
    config_overrides: Optional[AsyncVPCLatticeClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
    vpc_identifier: Optional[VpcId] = None,
    target_group_type: Optional[TargetGroupType] = None,
) -> ListTargetGroupsResponse

Lists your target groups. You can narrow your search by using the filters below in your request.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return.

  • next_token (Optional[NextToken], default: None ) –

    A pagination token for the next page of results.

  • vpc_identifier (Optional[VpcId], default: None ) –

    The ID or ARN of the VPC.

  • target_group_type (Optional[TargetGroupType], default: None ) –

    The target group type.

Raises:

Source code in docs_src/capo_vpc_lattice/_services/async_vpc_lattice.py
async def list_target_groups(
    self,
    *,
    config_overrides: Optional[AsyncVPCLatticeClientConfig] = None,
    max_results: Optional["capo_vpc_lattice.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_vpc_lattice.types.next_token.NextToken"] = None,
    vpc_identifier: Optional["capo_vpc_lattice.types.vpc_id.VpcId"] = None,
    target_group_type: Optional[
        "capo_vpc_lattice.types.target_group_type.TargetGroupType"
    ] = None,
) -> "capo_vpc_lattice.types.list_target_groups_response.ListTargetGroupsResponse":
    """<p>Lists your target groups. You can narrow your search by using the filters below in your request.</p>

    Args:
        max_results: <p>The maximum number of results to return.</p>
        next_token: <p>A pagination token for the next page of results.</p>
        vpc_identifier: <p>The ID or ARN of the VPC.</p>
        target_group_type: <p>The target group type.</p>

    Raises:
        capo_vpc_lattice.errors.access_denied_exception.AccessDeniedException: <p>The user does not have sufficient access to perform this action.</p>
        capo_vpc_lattice.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_vpc_lattice.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_vpc_lattice.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_vpc_lattice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_vpc_lattice.types.list_target_groups_request.ListTargetGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_vpc_lattice.types.list_target_groups_response.ListTargetGroupsResponse"
    ]:
        import capo_vpc_lattice._operations.mercury_control_plane.list_target_groups

        (
            output,
            http_response,
        ) = await capo_vpc_lattice._operations.mercury_control_plane.list_target_groups.async_list_target_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTargetGroups")
    )
    input_: capo_vpc_lattice.types.list_target_groups_request.ListTargetGroupsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if vpc_identifier is not None:
        input_["vpc_identifier"] = vpc_identifier
    if target_group_type is not None:
        input_["target_group_type"] = target_group_type

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