Skip to content

list_farm_members 

list_farm_members(
    farm_id: FarmId,
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListFarmMembersResponse

Lists the members of a farm.

Parameters:

  • farm_id (FarmId) –

    The farm ID.

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

    The token for the next set of results, or null to start from the beginning.

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

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Raises:

Source code in docs_src/capo_deadline/_services/deadline.py 
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
def list_farm_members(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    next_token: Optional["capo_deadline.types.next_token.NextToken"] = None,
    max_results: Optional["capo_deadline.types.max_results.MaxResults"] = None,
) -> "capo_deadline.types.list_farm_members_response.ListFarmMembersResponse":
    """<p>Lists the members of a farm.</p>

    Args:
        farm_id: <p>The farm ID.</p>
        next_token: <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
        max_results: <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.list_farm_members_request.ListFarmMembersRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.list_farm_members_response.ListFarmMembersResponse"
    ]:
        import capo_deadline._operations.deadline.list_farm_members

        output, http_response = (
            capo_deadline._operations.deadline.list_farm_members.list_farm_members(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFarmMembers")
    )
    input_: capo_deadline.types.list_farm_members_request.ListFarmMembersRequest = {
        "farm_id": farm_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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