/** * 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 #include namespace Aws { namespace SageMaker { namespace Model { /** */ class ListModelPackagesRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API ListModelPackagesRequest(); // 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 "ListModelPackages"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

A filter that returns only model packages created after the specified time * (timestamp).

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

A filter that returns only model packages created after the specified time * (timestamp).

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

A filter that returns only model packages 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 model packages 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 model packages created after the specified time * (timestamp).

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

A filter that returns only model packages created after the specified time * (timestamp).

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

A filter that returns only model packages created before the specified time * (timestamp).

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

A filter that returns only model packages created before the specified time * (timestamp).

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

A filter that returns only model packages 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 model packages 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 model packages created before the specified time * (timestamp).

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

A filter that returns only model packages created before the specified time * (timestamp).

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

The maximum number of model packages to return in the response.

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

The maximum number of model packages to return in the response.

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

The maximum number of model packages to return in the response.

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

The maximum number of model packages to return in the response.

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

A string in the model package name. This filter returns only model packages * whose name contains the specified string.

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

A string in the model package name. This filter returns only model packages * whose name contains the specified string.

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

A string in the model package name. This filter returns only model packages * whose name contains the specified string.

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

A string in the model package name. This filter returns only model packages * whose name contains the specified string.

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

A string in the model package name. This filter returns only model packages * whose name contains the specified string.

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

A string in the model package name. This filter returns only model packages * whose name contains the specified string.

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

A string in the model package name. This filter returns only model packages * whose name contains the specified string.

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

A string in the model package name. This filter returns only model packages * whose name contains the specified string.

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

A filter that returns only the model packages with the specified approval * status.

*/ inline const ModelApprovalStatus& GetModelApprovalStatus() const{ return m_modelApprovalStatus; } /** *

A filter that returns only the model packages with the specified approval * status.

*/ inline bool ModelApprovalStatusHasBeenSet() const { return m_modelApprovalStatusHasBeenSet; } /** *

A filter that returns only the model packages with the specified approval * status.

*/ inline void SetModelApprovalStatus(const ModelApprovalStatus& value) { m_modelApprovalStatusHasBeenSet = true; m_modelApprovalStatus = value; } /** *

A filter that returns only the model packages with the specified approval * status.

*/ inline void SetModelApprovalStatus(ModelApprovalStatus&& value) { m_modelApprovalStatusHasBeenSet = true; m_modelApprovalStatus = std::move(value); } /** *

A filter that returns only the model packages with the specified approval * status.

*/ inline ListModelPackagesRequest& WithModelApprovalStatus(const ModelApprovalStatus& value) { SetModelApprovalStatus(value); return *this;} /** *

A filter that returns only the model packages with the specified approval * status.

*/ inline ListModelPackagesRequest& WithModelApprovalStatus(ModelApprovalStatus&& value) { SetModelApprovalStatus(std::move(value)); return *this;} /** *

A filter that returns only model versions that belong to the specified model * group.

*/ inline const Aws::String& GetModelPackageGroupName() const{ return m_modelPackageGroupName; } /** *

A filter that returns only model versions that belong to the specified model * group.

*/ inline bool ModelPackageGroupNameHasBeenSet() const { return m_modelPackageGroupNameHasBeenSet; } /** *

A filter that returns only model versions that belong to the specified model * group.

*/ inline void SetModelPackageGroupName(const Aws::String& value) { m_modelPackageGroupNameHasBeenSet = true; m_modelPackageGroupName = value; } /** *

A filter that returns only model versions that belong to the specified model * group.

*/ inline void SetModelPackageGroupName(Aws::String&& value) { m_modelPackageGroupNameHasBeenSet = true; m_modelPackageGroupName = std::move(value); } /** *

A filter that returns only model versions that belong to the specified model * group.

*/ inline void SetModelPackageGroupName(const char* value) { m_modelPackageGroupNameHasBeenSet = true; m_modelPackageGroupName.assign(value); } /** *

A filter that returns only model versions that belong to the specified model * group.

*/ inline ListModelPackagesRequest& WithModelPackageGroupName(const Aws::String& value) { SetModelPackageGroupName(value); return *this;} /** *

A filter that returns only model versions that belong to the specified model * group.

*/ inline ListModelPackagesRequest& WithModelPackageGroupName(Aws::String&& value) { SetModelPackageGroupName(std::move(value)); return *this;} /** *

A filter that returns only model versions that belong to the specified model * group.

*/ inline ListModelPackagesRequest& WithModelPackageGroupName(const char* value) { SetModelPackageGroupName(value); return *this;} /** *

A filter that returns only the model packages of the specified type. This can * be one of the following values.

  • UNVERSIONED - * List only unversioined models. This is the default value if no * ModelPackageType is specified.

  • * VERSIONED - List only versioned models.

  • * BOTH - List both versioned and unversioned models.

*/ inline const ModelPackageType& GetModelPackageType() const{ return m_modelPackageType; } /** *

A filter that returns only the model packages of the specified type. This can * be one of the following values.

  • UNVERSIONED - * List only unversioined models. This is the default value if no * ModelPackageType is specified.

  • * VERSIONED - List only versioned models.

  • * BOTH - List both versioned and unversioned models.

*/ inline bool ModelPackageTypeHasBeenSet() const { return m_modelPackageTypeHasBeenSet; } /** *

A filter that returns only the model packages of the specified type. This can * be one of the following values.

  • UNVERSIONED - * List only unversioined models. This is the default value if no * ModelPackageType is specified.

  • * VERSIONED - List only versioned models.

  • * BOTH - List both versioned and unversioned models.

*/ inline void SetModelPackageType(const ModelPackageType& value) { m_modelPackageTypeHasBeenSet = true; m_modelPackageType = value; } /** *

A filter that returns only the model packages of the specified type. This can * be one of the following values.

  • UNVERSIONED - * List only unversioined models. This is the default value if no * ModelPackageType is specified.

  • * VERSIONED - List only versioned models.

  • * BOTH - List both versioned and unversioned models.

*/ inline void SetModelPackageType(ModelPackageType&& value) { m_modelPackageTypeHasBeenSet = true; m_modelPackageType = std::move(value); } /** *

A filter that returns only the model packages of the specified type. This can * be one of the following values.

  • UNVERSIONED - * List only unversioined models. This is the default value if no * ModelPackageType is specified.

  • * VERSIONED - List only versioned models.

  • * BOTH - List both versioned and unversioned models.

*/ inline ListModelPackagesRequest& WithModelPackageType(const ModelPackageType& value) { SetModelPackageType(value); return *this;} /** *

A filter that returns only the model packages of the specified type. This can * be one of the following values.

  • UNVERSIONED - * List only unversioined models. This is the default value if no * ModelPackageType is specified.

  • * VERSIONED - List only versioned models.

  • * BOTH - List both versioned and unversioned models.

*/ inline ListModelPackagesRequest& WithModelPackageType(ModelPackageType&& value) { SetModelPackageType(std::move(value)); return *this;} /** *

If the response to a previous ListModelPackages request was * truncated, the response includes a NextToken. To retrieve the next * set of model packages, use the token in the next request.

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

If the response to a previous ListModelPackages request was * truncated, the response includes a NextToken. To retrieve the next * set of model packages, use the token in the next request.

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

If the response to a previous ListModelPackages request was * truncated, the response includes a NextToken. To retrieve the next * set of model packages, use the token in the next request.

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

If the response to a previous ListModelPackages request was * truncated, the response includes a NextToken. To retrieve the next * set of model packages, use the token in the next request.

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

If the response to a previous ListModelPackages request was * truncated, the response includes a NextToken. To retrieve the next * set of model packages, use the token in the next request.

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

If the response to a previous ListModelPackages request was * truncated, the response includes a NextToken. To retrieve the next * set of model packages, use the token in the next request.

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

If the response to a previous ListModelPackages request was * truncated, the response includes a NextToken. To retrieve the next * set of model packages, use the token in the next request.

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

If the response to a previous ListModelPackages request was * truncated, the response includes a NextToken. To retrieve the next * set of model packages, use the token in the next request.

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

The parameter by which to sort the results. The default is * CreationTime.

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

The parameter by which to sort the results. The default is * CreationTime.

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

The parameter by which to sort the results. The default is * CreationTime.

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

The parameter by which to sort the results. The default is * CreationTime.

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

The parameter by which to sort the results. The default is * CreationTime.

*/ inline ListModelPackagesRequest& WithSortBy(const ModelPackageSortBy& value) { SetSortBy(value); return *this;} /** *

The parameter by which to sort the results. The default is * CreationTime.

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

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

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

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

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

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

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

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

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

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

*/ inline ListModelPackagesRequest& WithSortOrder(const SortOrder& value) { SetSortOrder(value); return *this;} /** *

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

*/ inline ListModelPackagesRequest& WithSortOrder(SortOrder&& value) { SetSortOrder(std::move(value)); return *this;} private: Aws::Utils::DateTime m_creationTimeAfter; bool m_creationTimeAfterHasBeenSet = false; Aws::Utils::DateTime m_creationTimeBefore; bool m_creationTimeBeforeHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nameContains; bool m_nameContainsHasBeenSet = false; ModelApprovalStatus m_modelApprovalStatus; bool m_modelApprovalStatusHasBeenSet = false; Aws::String m_modelPackageGroupName; bool m_modelPackageGroupNameHasBeenSet = false; ModelPackageType m_modelPackageType; bool m_modelPackageTypeHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; ModelPackageSortBy m_sortBy; bool m_sortByHasBeenSet = false; SortOrder m_sortOrder; bool m_sortOrderHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws