/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace SageMaker { namespace Model { /** */ class ListNotebookInstancesRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API ListNotebookInstancesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListNotebookInstances"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

If the previous call to the ListNotebookInstances is truncated, * the response includes a NextToken. You can use this token in your * subsequent ListNotebookInstances request to fetch the next set of * notebook instances.

You might specify a filter or a sort order in * your request. When response is truncated, you must use the same values for the * filer and sort order in the next request.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

If the previous call to the ListNotebookInstances is truncated, * the response includes a NextToken. You can use this token in your * subsequent ListNotebookInstances request to fetch the next set of * notebook instances.

You might specify a filter or a sort order in * your request. When response is truncated, you must use the same values for the * filer and sort order in the next request.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

If the previous call to the ListNotebookInstances is truncated, * the response includes a NextToken. You can use this token in your * subsequent ListNotebookInstances request to fetch the next set of * notebook instances.

You might specify a filter or a sort order in * your request. When response is truncated, you must use the same values for the * filer and sort order in the next request.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

If the previous call to the ListNotebookInstances is truncated, * the response includes a NextToken. You can use this token in your * subsequent ListNotebookInstances request to fetch the next set of * notebook instances.

You might specify a filter or a sort order in * your request. When response is truncated, you must use the same values for the * filer and sort order in the next request.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

If the previous call to the ListNotebookInstances is truncated, * the response includes a NextToken. You can use this token in your * subsequent ListNotebookInstances request to fetch the next set of * notebook instances.

You might specify a filter or a sort order in * your request. When response is truncated, you must use the same values for the * filer and sort order in the next request.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

If the previous call to the ListNotebookInstances is truncated, * the response includes a NextToken. You can use this token in your * subsequent ListNotebookInstances request to fetch the next set of * notebook instances.

You might specify a filter or a sort order in * your request. When response is truncated, you must use the same values for the * filer and sort order in the next request.

*/ inline ListNotebookInstancesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

If the previous call to the ListNotebookInstances is truncated, * the response includes a NextToken. You can use this token in your * subsequent ListNotebookInstances request to fetch the next set of * notebook instances.

You might specify a filter or a sort order in * your request. When response is truncated, you must use the same values for the * filer and sort order in the next request.

*/ inline ListNotebookInstancesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

If the previous call to the ListNotebookInstances is truncated, * the response includes a NextToken. You can use this token in your * subsequent ListNotebookInstances request to fetch the next set of * notebook instances.

You might specify a filter or a sort order in * your request. When response is truncated, you must use the same values for the * filer and sort order in the next request.

*/ inline ListNotebookInstancesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of notebook instances to return.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of notebook instances to return.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of notebook instances to return.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of notebook instances to return.

*/ inline ListNotebookInstancesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

The field to sort results by. The default is Name.

*/ inline const NotebookInstanceSortKey& GetSortBy() const{ return m_sortBy; } /** *

The field to sort results by. The default is Name.

*/ inline bool SortByHasBeenSet() const { return m_sortByHasBeenSet; } /** *

The field to sort results by. The default is Name.

*/ inline void SetSortBy(const NotebookInstanceSortKey& value) { m_sortByHasBeenSet = true; m_sortBy = value; } /** *

The field to sort results by. The default is Name.

*/ inline void SetSortBy(NotebookInstanceSortKey&& value) { m_sortByHasBeenSet = true; m_sortBy = std::move(value); } /** *

The field to sort results by. The default is Name.

*/ inline ListNotebookInstancesRequest& WithSortBy(const NotebookInstanceSortKey& value) { SetSortBy(value); return *this;} /** *

The field to sort results by. The default is Name.

*/ inline ListNotebookInstancesRequest& WithSortBy(NotebookInstanceSortKey&& value) { SetSortBy(std::move(value)); return *this;} /** *

The sort order for results.

*/ inline const NotebookInstanceSortOrder& GetSortOrder() const{ return m_sortOrder; } /** *

The sort order for results.

*/ inline bool SortOrderHasBeenSet() const { return m_sortOrderHasBeenSet; } /** *

The sort order for results.

*/ inline void SetSortOrder(const NotebookInstanceSortOrder& value) { m_sortOrderHasBeenSet = true; m_sortOrder = value; } /** *

The sort order for results.

*/ inline void SetSortOrder(NotebookInstanceSortOrder&& value) { m_sortOrderHasBeenSet = true; m_sortOrder = std::move(value); } /** *

The sort order for results.

*/ inline ListNotebookInstancesRequest& WithSortOrder(const NotebookInstanceSortOrder& value) { SetSortOrder(value); return *this;} /** *

The sort order for results.

*/ inline ListNotebookInstancesRequest& WithSortOrder(NotebookInstanceSortOrder&& value) { SetSortOrder(std::move(value)); return *this;} /** *

A string in the notebook instances' name. This filter returns only notebook * instances whose name contains the specified string.

*/ inline const Aws::String& GetNameContains() const{ return m_nameContains; } /** *

A string in the notebook instances' name. This filter returns only notebook * instances whose name contains the specified string.

*/ inline bool NameContainsHasBeenSet() const { return m_nameContainsHasBeenSet; } /** *

A string in the notebook instances' name. This filter returns only notebook * instances whose name contains the specified string.

*/ inline void SetNameContains(const Aws::String& value) { m_nameContainsHasBeenSet = true; m_nameContains = value; } /** *

A string in the notebook instances' name. This filter returns only notebook * instances whose name contains the specified string.

*/ inline void SetNameContains(Aws::String&& value) { m_nameContainsHasBeenSet = true; m_nameContains = std::move(value); } /** *

A string in the notebook instances' name. This filter returns only notebook * instances whose name contains the specified string.

*/ inline void SetNameContains(const char* value) { m_nameContainsHasBeenSet = true; m_nameContains.assign(value); } /** *

A string in the notebook instances' name. This filter returns only notebook * instances whose name contains the specified string.

*/ inline ListNotebookInstancesRequest& WithNameContains(const Aws::String& value) { SetNameContains(value); return *this;} /** *

A string in the notebook instances' name. This filter returns only notebook * instances whose name contains the specified string.

*/ inline ListNotebookInstancesRequest& WithNameContains(Aws::String&& value) { SetNameContains(std::move(value)); return *this;} /** *

A string in the notebook instances' name. This filter returns only notebook * instances whose name contains the specified string.

*/ inline ListNotebookInstancesRequest& WithNameContains(const char* value) { SetNameContains(value); return *this;} /** *

A filter that returns only notebook instances that were created before the * specified time (timestamp).

*/ inline const Aws::Utils::DateTime& GetCreationTimeBefore() const{ return m_creationTimeBefore; } /** *

A filter that returns only notebook instances that were created before the * specified time (timestamp).

*/ inline bool CreationTimeBeforeHasBeenSet() const { return m_creationTimeBeforeHasBeenSet; } /** *

A filter that returns only notebook instances that were created before the * specified time (timestamp).

*/ inline void SetCreationTimeBefore(const Aws::Utils::DateTime& value) { m_creationTimeBeforeHasBeenSet = true; m_creationTimeBefore = value; } /** *

A filter that returns only notebook instances that were created before the * specified time (timestamp).

*/ inline void SetCreationTimeBefore(Aws::Utils::DateTime&& value) { m_creationTimeBeforeHasBeenSet = true; m_creationTimeBefore = std::move(value); } /** *

A filter that returns only notebook instances that were created before the * specified time (timestamp).

*/ inline ListNotebookInstancesRequest& WithCreationTimeBefore(const Aws::Utils::DateTime& value) { SetCreationTimeBefore(value); return *this;} /** *

A filter that returns only notebook instances that were created before the * specified time (timestamp).

*/ inline ListNotebookInstancesRequest& WithCreationTimeBefore(Aws::Utils::DateTime&& value) { SetCreationTimeBefore(std::move(value)); return *this;} /** *

A filter that returns only notebook instances that were created after the * specified time (timestamp).

*/ inline const Aws::Utils::DateTime& GetCreationTimeAfter() const{ return m_creationTimeAfter; } /** *

A filter that returns only notebook instances that were created after the * specified time (timestamp).

*/ inline bool CreationTimeAfterHasBeenSet() const { return m_creationTimeAfterHasBeenSet; } /** *

A filter that returns only notebook instances that were created after the * specified time (timestamp).

*/ inline void SetCreationTimeAfter(const Aws::Utils::DateTime& value) { m_creationTimeAfterHasBeenSet = true; m_creationTimeAfter = value; } /** *

A filter that returns only notebook instances that were created after the * specified time (timestamp).

*/ inline void SetCreationTimeAfter(Aws::Utils::DateTime&& value) { m_creationTimeAfterHasBeenSet = true; m_creationTimeAfter = std::move(value); } /** *

A filter that returns only notebook instances that were created after the * specified time (timestamp).

*/ inline ListNotebookInstancesRequest& WithCreationTimeAfter(const Aws::Utils::DateTime& value) { SetCreationTimeAfter(value); return *this;} /** *

A filter that returns only notebook instances that were created after the * specified time (timestamp).

*/ inline ListNotebookInstancesRequest& WithCreationTimeAfter(Aws::Utils::DateTime&& value) { SetCreationTimeAfter(std::move(value)); return *this;} /** *

A filter that returns only notebook instances that were modified before the * specified time (timestamp).

*/ inline const Aws::Utils::DateTime& GetLastModifiedTimeBefore() const{ return m_lastModifiedTimeBefore; } /** *

A filter that returns only notebook instances that were modified before the * specified time (timestamp).

*/ inline bool LastModifiedTimeBeforeHasBeenSet() const { return m_lastModifiedTimeBeforeHasBeenSet; } /** *

A filter that returns only notebook instances that were modified before the * specified time (timestamp).

*/ inline void SetLastModifiedTimeBefore(const Aws::Utils::DateTime& value) { m_lastModifiedTimeBeforeHasBeenSet = true; m_lastModifiedTimeBefore = value; } /** *

A filter that returns only notebook instances that were modified before the * specified time (timestamp).

*/ inline void SetLastModifiedTimeBefore(Aws::Utils::DateTime&& value) { m_lastModifiedTimeBeforeHasBeenSet = true; m_lastModifiedTimeBefore = std::move(value); } /** *

A filter that returns only notebook instances that were modified before the * specified time (timestamp).

*/ inline ListNotebookInstancesRequest& WithLastModifiedTimeBefore(const Aws::Utils::DateTime& value) { SetLastModifiedTimeBefore(value); return *this;} /** *

A filter that returns only notebook instances that were modified before the * specified time (timestamp).

*/ inline ListNotebookInstancesRequest& WithLastModifiedTimeBefore(Aws::Utils::DateTime&& value) { SetLastModifiedTimeBefore(std::move(value)); return *this;} /** *

A filter that returns only notebook instances that were modified after the * specified time (timestamp).

*/ inline const Aws::Utils::DateTime& GetLastModifiedTimeAfter() const{ return m_lastModifiedTimeAfter; } /** *

A filter that returns only notebook instances that were modified after the * specified time (timestamp).

*/ inline bool LastModifiedTimeAfterHasBeenSet() const { return m_lastModifiedTimeAfterHasBeenSet; } /** *

A filter that returns only notebook instances that were modified after the * specified time (timestamp).

*/ inline void SetLastModifiedTimeAfter(const Aws::Utils::DateTime& value) { m_lastModifiedTimeAfterHasBeenSet = true; m_lastModifiedTimeAfter = value; } /** *

A filter that returns only notebook instances that were modified after the * specified time (timestamp).

*/ inline void SetLastModifiedTimeAfter(Aws::Utils::DateTime&& value) { m_lastModifiedTimeAfterHasBeenSet = true; m_lastModifiedTimeAfter = std::move(value); } /** *

A filter that returns only notebook instances that were modified after the * specified time (timestamp).

*/ inline ListNotebookInstancesRequest& WithLastModifiedTimeAfter(const Aws::Utils::DateTime& value) { SetLastModifiedTimeAfter(value); return *this;} /** *

A filter that returns only notebook instances that were modified after the * specified time (timestamp).

*/ inline ListNotebookInstancesRequest& WithLastModifiedTimeAfter(Aws::Utils::DateTime&& value) { SetLastModifiedTimeAfter(std::move(value)); return *this;} /** *

A filter that returns only notebook instances with the specified status.

*/ inline const NotebookInstanceStatus& GetStatusEquals() const{ return m_statusEquals; } /** *

A filter that returns only notebook instances with the specified status.

*/ inline bool StatusEqualsHasBeenSet() const { return m_statusEqualsHasBeenSet; } /** *

A filter that returns only notebook instances with the specified status.

*/ inline void SetStatusEquals(const NotebookInstanceStatus& value) { m_statusEqualsHasBeenSet = true; m_statusEquals = value; } /** *

A filter that returns only notebook instances with the specified status.

*/ inline void SetStatusEquals(NotebookInstanceStatus&& value) { m_statusEqualsHasBeenSet = true; m_statusEquals = std::move(value); } /** *

A filter that returns only notebook instances with the specified status.

*/ inline ListNotebookInstancesRequest& WithStatusEquals(const NotebookInstanceStatus& value) { SetStatusEquals(value); return *this;} /** *

A filter that returns only notebook instances with the specified status.

*/ inline ListNotebookInstancesRequest& WithStatusEquals(NotebookInstanceStatus&& value) { SetStatusEquals(std::move(value)); return *this;} /** *

A string in the name of a notebook instances lifecycle configuration * associated with this notebook instance. This filter returns only notebook * instances associated with a lifecycle configuration with a name that contains * the specified string.

*/ inline const Aws::String& GetNotebookInstanceLifecycleConfigNameContains() const{ return m_notebookInstanceLifecycleConfigNameContains; } /** *

A string in the name of a notebook instances lifecycle configuration * associated with this notebook instance. This filter returns only notebook * instances associated with a lifecycle configuration with a name that contains * the specified string.

*/ inline bool NotebookInstanceLifecycleConfigNameContainsHasBeenSet() const { return m_notebookInstanceLifecycleConfigNameContainsHasBeenSet; } /** *

A string in the name of a notebook instances lifecycle configuration * associated with this notebook instance. This filter returns only notebook * instances associated with a lifecycle configuration with a name that contains * the specified string.

*/ inline void SetNotebookInstanceLifecycleConfigNameContains(const Aws::String& value) { m_notebookInstanceLifecycleConfigNameContainsHasBeenSet = true; m_notebookInstanceLifecycleConfigNameContains = value; } /** *

A string in the name of a notebook instances lifecycle configuration * associated with this notebook instance. This filter returns only notebook * instances associated with a lifecycle configuration with a name that contains * the specified string.

*/ inline void SetNotebookInstanceLifecycleConfigNameContains(Aws::String&& value) { m_notebookInstanceLifecycleConfigNameContainsHasBeenSet = true; m_notebookInstanceLifecycleConfigNameContains = std::move(value); } /** *

A string in the name of a notebook instances lifecycle configuration * associated with this notebook instance. This filter returns only notebook * instances associated with a lifecycle configuration with a name that contains * the specified string.

*/ inline void SetNotebookInstanceLifecycleConfigNameContains(const char* value) { m_notebookInstanceLifecycleConfigNameContainsHasBeenSet = true; m_notebookInstanceLifecycleConfigNameContains.assign(value); } /** *

A string in the name of a notebook instances lifecycle configuration * associated with this notebook instance. This filter returns only notebook * instances associated with a lifecycle configuration with a name that contains * the specified string.

*/ inline ListNotebookInstancesRequest& WithNotebookInstanceLifecycleConfigNameContains(const Aws::String& value) { SetNotebookInstanceLifecycleConfigNameContains(value); return *this;} /** *

A string in the name of a notebook instances lifecycle configuration * associated with this notebook instance. This filter returns only notebook * instances associated with a lifecycle configuration with a name that contains * the specified string.

*/ inline ListNotebookInstancesRequest& WithNotebookInstanceLifecycleConfigNameContains(Aws::String&& value) { SetNotebookInstanceLifecycleConfigNameContains(std::move(value)); return *this;} /** *

A string in the name of a notebook instances lifecycle configuration * associated with this notebook instance. This filter returns only notebook * instances associated with a lifecycle configuration with a name that contains * the specified string.

*/ inline ListNotebookInstancesRequest& WithNotebookInstanceLifecycleConfigNameContains(const char* value) { SetNotebookInstanceLifecycleConfigNameContains(value); return *this;} /** *

A string in the name or URL of a Git repository associated with this notebook * instance. This filter returns only notebook instances associated with a git * repository with a name that contains the specified string.

*/ inline const Aws::String& GetDefaultCodeRepositoryContains() const{ return m_defaultCodeRepositoryContains; } /** *

A string in the name or URL of a Git repository associated with this notebook * instance. This filter returns only notebook instances associated with a git * repository with a name that contains the specified string.

*/ inline bool DefaultCodeRepositoryContainsHasBeenSet() const { return m_defaultCodeRepositoryContainsHasBeenSet; } /** *

A string in the name or URL of a Git repository associated with this notebook * instance. This filter returns only notebook instances associated with a git * repository with a name that contains the specified string.

*/ inline void SetDefaultCodeRepositoryContains(const Aws::String& value) { m_defaultCodeRepositoryContainsHasBeenSet = true; m_defaultCodeRepositoryContains = value; } /** *

A string in the name or URL of a Git repository associated with this notebook * instance. This filter returns only notebook instances associated with a git * repository with a name that contains the specified string.

*/ inline void SetDefaultCodeRepositoryContains(Aws::String&& value) { m_defaultCodeRepositoryContainsHasBeenSet = true; m_defaultCodeRepositoryContains = std::move(value); } /** *

A string in the name or URL of a Git repository associated with this notebook * instance. This filter returns only notebook instances associated with a git * repository with a name that contains the specified string.

*/ inline void SetDefaultCodeRepositoryContains(const char* value) { m_defaultCodeRepositoryContainsHasBeenSet = true; m_defaultCodeRepositoryContains.assign(value); } /** *

A string in the name or URL of a Git repository associated with this notebook * instance. This filter returns only notebook instances associated with a git * repository with a name that contains the specified string.

*/ inline ListNotebookInstancesRequest& WithDefaultCodeRepositoryContains(const Aws::String& value) { SetDefaultCodeRepositoryContains(value); return *this;} /** *

A string in the name or URL of a Git repository associated with this notebook * instance. This filter returns only notebook instances associated with a git * repository with a name that contains the specified string.

*/ inline ListNotebookInstancesRequest& WithDefaultCodeRepositoryContains(Aws::String&& value) { SetDefaultCodeRepositoryContains(std::move(value)); return *this;} /** *

A string in the name or URL of a Git repository associated with this notebook * instance. This filter returns only notebook instances associated with a git * repository with a name that contains the specified string.

*/ inline ListNotebookInstancesRequest& WithDefaultCodeRepositoryContains(const char* value) { SetDefaultCodeRepositoryContains(value); return *this;} /** *

A filter that returns only notebook instances with associated with the * specified git repository.

*/ inline const Aws::String& GetAdditionalCodeRepositoryEquals() const{ return m_additionalCodeRepositoryEquals; } /** *

A filter that returns only notebook instances with associated with the * specified git repository.

*/ inline bool AdditionalCodeRepositoryEqualsHasBeenSet() const { return m_additionalCodeRepositoryEqualsHasBeenSet; } /** *

A filter that returns only notebook instances with associated with the * specified git repository.

*/ inline void SetAdditionalCodeRepositoryEquals(const Aws::String& value) { m_additionalCodeRepositoryEqualsHasBeenSet = true; m_additionalCodeRepositoryEquals = value; } /** *

A filter that returns only notebook instances with associated with the * specified git repository.

*/ inline void SetAdditionalCodeRepositoryEquals(Aws::String&& value) { m_additionalCodeRepositoryEqualsHasBeenSet = true; m_additionalCodeRepositoryEquals = std::move(value); } /** *

A filter that returns only notebook instances with associated with the * specified git repository.

*/ inline void SetAdditionalCodeRepositoryEquals(const char* value) { m_additionalCodeRepositoryEqualsHasBeenSet = true; m_additionalCodeRepositoryEquals.assign(value); } /** *

A filter that returns only notebook instances with associated with the * specified git repository.

*/ inline ListNotebookInstancesRequest& WithAdditionalCodeRepositoryEquals(const Aws::String& value) { SetAdditionalCodeRepositoryEquals(value); return *this;} /** *

A filter that returns only notebook instances with associated with the * specified git repository.

*/ inline ListNotebookInstancesRequest& WithAdditionalCodeRepositoryEquals(Aws::String&& value) { SetAdditionalCodeRepositoryEquals(std::move(value)); return *this;} /** *

A filter that returns only notebook instances with associated with the * specified git repository.

*/ inline ListNotebookInstancesRequest& WithAdditionalCodeRepositoryEquals(const char* value) { SetAdditionalCodeRepositoryEquals(value); return *this;} private: Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; NotebookInstanceSortKey m_sortBy; bool m_sortByHasBeenSet = false; NotebookInstanceSortOrder m_sortOrder; bool m_sortOrderHasBeenSet = false; Aws::String m_nameContains; bool m_nameContainsHasBeenSet = false; Aws::Utils::DateTime m_creationTimeBefore; bool m_creationTimeBeforeHasBeenSet = false; Aws::Utils::DateTime m_creationTimeAfter; bool m_creationTimeAfterHasBeenSet = false; Aws::Utils::DateTime m_lastModifiedTimeBefore; bool m_lastModifiedTimeBeforeHasBeenSet = false; Aws::Utils::DateTime m_lastModifiedTimeAfter; bool m_lastModifiedTimeAfterHasBeenSet = false; NotebookInstanceStatus m_statusEquals; bool m_statusEqualsHasBeenSet = false; Aws::String m_notebookInstanceLifecycleConfigNameContains; bool m_notebookInstanceLifecycleConfigNameContainsHasBeenSet = false; Aws::String m_defaultCodeRepositoryContains; bool m_defaultCodeRepositoryContainsHasBeenSet = false; Aws::String m_additionalCodeRepositoryEquals; bool m_additionalCodeRepositoryEqualsHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws