Skip to content

list_targets

list_targets(
    target_group_identifier: TargetGroupIdentifier,
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
    targets: Optional[TargetList] = None,
) -> ListTargetsResponse

Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.

Parameters:

Raises:

Source code in docs_src/capo_vpc_lattice/_services/vpc_lattice.py
def list_targets(
    self,
    target_group_identifier: "capo_vpc_lattice.types.target_group_identifier.TargetGroupIdentifier",
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
    max_results: Optional["capo_vpc_lattice.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_vpc_lattice.types.next_token.NextToken"] = None,
    targets: Optional["capo_vpc_lattice.types.target_list.TargetList"] = None,
) -> "capo_vpc_lattice.types.list_targets_response.ListTargetsResponse":
    """<p>Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.</p>

    Args:
        target_group_identifier: <p>The ID or ARN of the target group.</p>
        max_results: <p>The maximum number of results to return.</p>
        next_token: <p>A pagination token for the next page of results.</p>
        targets: <p>The targets.</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.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</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.
    """

    def _handler(
        req: "OperationRequest[capo_vpc_lattice.types.list_targets_request.ListTargetsRequest]",
    ) -> OperationResponse[
        "capo_vpc_lattice.types.list_targets_response.ListTargetsResponse"
    ]:
        import capo_vpc_lattice._operations.mercury_control_plane.list_targets

        output, http_response = (
            capo_vpc_lattice._operations.mercury_control_plane.list_targets.list_targets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTargets")
    )
    input_: capo_vpc_lattice.types.list_targets_request.ListTargetsRequest = {
        "target_group_identifier": target_group_identifier
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if targets is not None:
        input_["targets"] = targets

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