Interface ListClustersRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListClustersRequest.Builder,ListClustersRequest>, SageMakerRequest.Builder, SdkBuilder<ListClustersRequest.Builder,ListClustersRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListClustersRequest
@Mutable @NotThreadSafe public static interface ListClustersRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<ListClustersRequest.Builder,ListClustersRequest>

  • Method Details

    • creationTimeAfter

      ListClustersRequest.Builder creationTimeAfter(Instant creationTimeAfter)

      Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

      Acceptable formats include:

      • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

      • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

      • YYYY-MM-DD, for example, 2014-10-01

      • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

      For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

      Parameters:
      creationTimeAfter - Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

      Acceptable formats include:

      • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

      • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

      • YYYY-MM-DD, for example, 2014-10-01

      • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

      For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTimeBefore

      ListClustersRequest.Builder creationTimeBefore(Instant creationTimeBefore)

      Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

      Parameters:
      creationTimeBefore - Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListClustersRequest.Builder maxResults(Integer maxResults)

      Specifies the maximum number of clusters to evaluate for the operation (not necessarily the number of matching items). After SageMaker processes the number of clusters up to MaxResults, it stops the operation and returns the matching clusters up to that point. If all the matching clusters are desired, SageMaker will go through all the clusters until NextToken is empty.

      Parameters:
      maxResults - Specifies the maximum number of clusters to evaluate for the operation (not necessarily the number of matching items). After SageMaker processes the number of clusters up to MaxResults, it stops the operation and returns the matching clusters up to that point. If all the matching clusters are desired, SageMaker will go through all the clusters until NextToken is empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nameContains

      ListClustersRequest.Builder nameContains(String nameContains)

      Set the maximum number of instances to print in the list.

      Parameters:
      nameContains - Set the maximum number of instances to print in the list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListClustersRequest.Builder nextToken(String nextToken)

      Set the next token to retrieve the list of SageMaker HyperPod clusters.

      Parameters:
      nextToken - Set the next token to retrieve the list of SageMaker HyperPod clusters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      ListClustersRequest.Builder sortBy(String sortBy)

      The field by which to sort results. The default value is CREATION_TIME.

      Parameters:
      sortBy - The field by which to sort results. The default value is CREATION_TIME.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      ListClustersRequest.Builder sortBy(ClusterSortBy sortBy)

      The field by which to sort results. The default value is CREATION_TIME.

      Parameters:
      sortBy - The field by which to sort results. The default value is CREATION_TIME.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListClustersRequest.Builder sortOrder(String sortOrder)

      The sort order for results. The default value is Ascending.

      Parameters:
      sortOrder - The sort order for results. The default value is Ascending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListClustersRequest.Builder sortOrder(SortOrder sortOrder)

      The sort order for results. The default value is Ascending.

      Parameters:
      sortOrder - The sort order for results. The default value is Ascending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingPlanArn

      ListClustersRequest.Builder trainingPlanArn(String trainingPlanArn)

      The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

      Parameters:
      trainingPlanArn - The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListClustersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListClustersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.