// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ListClustersInput {
/// <p>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.</p>
/// <p>Acceptable formats include:</p>
/// <ul>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example, <code>2014-10-01T20:30:00.000Z</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example, <code>2014-10-01T12:30:00.000-08:00</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code></p></li>
/// <li>
/// <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</p></li>
/// </ul>
/// <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub creation_time_after: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>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 <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub creation_time_before: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>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 <code>MaxResults</code>, 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 <code>NextToken</code> is empty.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>Set the maximum number of instances to print in the list.</p>
pub name_contains: ::std::option::Option<::std::string::String>,
/// <p>Set the next token to retrieve the list of SageMaker HyperPod clusters.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The field by which to sort results. The default value is <code>CREATION_TIME</code>.</p>
pub sort_by: ::std::option::Option<crate::types::ClusterSortBy>,
/// <p>The sort order for results. The default value is <code>Ascending</code>.</p>
pub sort_order: ::std::option::Option<crate::types::SortOrder>,
/// <p>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 <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>
pub training_plan_arn: ::std::option::Option<::std::string::String>,
}
impl ListClustersInput {
/// <p>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.</p>
/// <p>Acceptable formats include:</p>
/// <ul>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example, <code>2014-10-01T20:30:00.000Z</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example, <code>2014-10-01T12:30:00.000-08:00</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code></p></li>
/// <li>
/// <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</p></li>
/// </ul>
/// <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub fn creation_time_after(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.creation_time_after.as_ref()
}
/// <p>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 <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub fn creation_time_before(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.creation_time_before.as_ref()
}
/// <p>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 <code>MaxResults</code>, 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 <code>NextToken</code> is empty.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>Set the maximum number of instances to print in the list.</p>
pub fn name_contains(&self) -> ::std::option::Option<&str> {
self.name_contains.as_deref()
}
/// <p>Set the next token to retrieve the list of SageMaker HyperPod clusters.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The field by which to sort results. The default value is <code>CREATION_TIME</code>.</p>
pub fn sort_by(&self) -> ::std::option::Option<&crate::types::ClusterSortBy> {
self.sort_by.as_ref()
}
/// <p>The sort order for results. The default value is <code>Ascending</code>.</p>
pub fn sort_order(&self) -> ::std::option::Option<&crate::types::SortOrder> {
self.sort_order.as_ref()
}
/// <p>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 <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>
pub fn training_plan_arn(&self) -> ::std::option::Option<&str> {
self.training_plan_arn.as_deref()
}
}
impl ListClustersInput {
/// Creates a new builder-style object to manufacture [`ListClustersInput`](crate::operation::list_clusters::ListClustersInput).
pub fn builder() -> crate::operation::list_clusters::builders::ListClustersInputBuilder {
crate::operation::list_clusters::builders::ListClustersInputBuilder::default()
}
}
/// A builder for [`ListClustersInput`](crate::operation::list_clusters::ListClustersInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListClustersInputBuilder {
pub(crate) creation_time_after: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) creation_time_before: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) name_contains: ::std::option::Option<::std::string::String>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) sort_by: ::std::option::Option<crate::types::ClusterSortBy>,
pub(crate) sort_order: ::std::option::Option<crate::types::SortOrder>,
pub(crate) training_plan_arn: ::std::option::Option<::std::string::String>,
}
impl ListClustersInputBuilder {
/// <p>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.</p>
/// <p>Acceptable formats include:</p>
/// <ul>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example, <code>2014-10-01T20:30:00.000Z</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example, <code>2014-10-01T12:30:00.000-08:00</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code></p></li>
/// <li>
/// <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</p></li>
/// </ul>
/// <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub fn creation_time_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.creation_time_after = ::std::option::Option::Some(input);
self
}
/// <p>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.</p>
/// <p>Acceptable formats include:</p>
/// <ul>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example, <code>2014-10-01T20:30:00.000Z</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example, <code>2014-10-01T12:30:00.000-08:00</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code></p></li>
/// <li>
/// <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</p></li>
/// </ul>
/// <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub fn set_creation_time_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.creation_time_after = input;
self
}
/// <p>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.</p>
/// <p>Acceptable formats include:</p>
/// <ul>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (UTC), for example, <code>2014-10-01T20:30:00.000Z</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DDThh:mm:ss.sssTZD</code> (with offset), for example, <code>2014-10-01T12:30:00.000-08:00</code></p></li>
/// <li>
/// <p><code>YYYY-MM-DD</code>, for example, <code>2014-10-01</code></p></li>
/// <li>
/// <p>Unix time in seconds, for example, <code>1412195400</code>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</p></li>
/// </ul>
/// <p>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub fn get_creation_time_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.creation_time_after
}
/// <p>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 <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub fn creation_time_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.creation_time_before = ::std::option::Option::Some(input);
self
}
/// <p>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 <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub fn set_creation_time_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.creation_time_before = input;
self
}
/// <p>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 <code>CreationTimeAfter</code>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
pub fn get_creation_time_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.creation_time_before
}
/// <p>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 <code>MaxResults</code>, 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 <code>NextToken</code> is empty.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>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 <code>MaxResults</code>, 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 <code>NextToken</code> is empty.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>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 <code>MaxResults</code>, 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 <code>NextToken</code> is empty.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>Set the maximum number of instances to print in the list.</p>
pub fn name_contains(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name_contains = ::std::option::Option::Some(input.into());
self
}
/// <p>Set the maximum number of instances to print in the list.</p>
pub fn set_name_contains(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name_contains = input;
self
}
/// <p>Set the maximum number of instances to print in the list.</p>
pub fn get_name_contains(&self) -> &::std::option::Option<::std::string::String> {
&self.name_contains
}
/// <p>Set the next token to retrieve the list of SageMaker HyperPod clusters.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.next_token = ::std::option::Option::Some(input.into());
self
}
/// <p>Set the next token to retrieve the list of SageMaker HyperPod clusters.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>Set the next token to retrieve the list of SageMaker HyperPod clusters.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The field by which to sort results. The default value is <code>CREATION_TIME</code>.</p>
pub fn sort_by(mut self, input: crate::types::ClusterSortBy) -> Self {
self.sort_by = ::std::option::Option::Some(input);
self
}
/// <p>The field by which to sort results. The default value is <code>CREATION_TIME</code>.</p>
pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::ClusterSortBy>) -> Self {
self.sort_by = input;
self
}
/// <p>The field by which to sort results. The default value is <code>CREATION_TIME</code>.</p>
pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::ClusterSortBy> {
&self.sort_by
}
/// <p>The sort order for results. The default value is <code>Ascending</code>.</p>
pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
self.sort_order = ::std::option::Option::Some(input);
self
}
/// <p>The sort order for results. The default value is <code>Ascending</code>.</p>
pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
self.sort_order = input;
self
}
/// <p>The sort order for results. The default value is <code>Ascending</code>.</p>
pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
&self.sort_order
}
/// <p>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 <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>
pub fn training_plan_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.training_plan_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>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 <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>
pub fn set_training_plan_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.training_plan_arn = input;
self
}
/// <p>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 <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>
pub fn get_training_plan_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.training_plan_arn
}
/// Consumes the builder and constructs a [`ListClustersInput`](crate::operation::list_clusters::ListClustersInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::list_clusters::ListClustersInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::list_clusters::ListClustersInput {
creation_time_after: self.creation_time_after,
creation_time_before: self.creation_time_before,
max_results: self.max_results,
name_contains: self.name_contains,
next_token: self.next_token,
sort_by: self.sort_by,
sort_order: self.sort_order,
training_plan_arn: self.training_plan_arn,
})
}
}