You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SageMaker::Types::ListWorkforcesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListWorkforcesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  sort_by: "Name", # accepts Name, CreateDate
  sort_order: "Ascending", # accepts Ascending, Descending
  name_contains: "WorkforceName",
  next_token: "NextToken",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of workforces returned in the response.

Returns:

  • (Integer) —

    The maximum number of workforces returned in the response.

#name_contains ⇒ String

A filter you can use to search for workforces using part of the workforce name.

Returns:

  • (String) —

    A filter you can use to search for workforces using part of the workforce name.

#next_token ⇒ String

A token to resume pagination.

Returns:

  • (String) —

    A token to resume pagination.

#sort_by ⇒ String

Sort workforces using the workforce name or creation date.

Possible values:

  • Name
  • CreateDate

Returns:

  • (String) —

    Sort workforces using the workforce name or creation date.

#sort_order ⇒ String

Sort workforces in ascending or descending order.

Possible values:

  • Ascending
  • Descending

Returns:

  • (String) —

    Sort workforces in ascending or descending order.