/** * 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 ListMonitoringExecutionsRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API ListMonitoringExecutionsRequest(); // 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 "ListMonitoringExecutions"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

Name of a specific schedule to fetch jobs for.

*/ inline const Aws::String& GetMonitoringScheduleName() const{ return m_monitoringScheduleName; } /** *

Name of a specific schedule to fetch jobs for.

*/ inline bool MonitoringScheduleNameHasBeenSet() const { return m_monitoringScheduleNameHasBeenSet; } /** *

Name of a specific schedule to fetch jobs for.

*/ inline void SetMonitoringScheduleName(const Aws::String& value) { m_monitoringScheduleNameHasBeenSet = true; m_monitoringScheduleName = value; } /** *

Name of a specific schedule to fetch jobs for.

*/ inline void SetMonitoringScheduleName(Aws::String&& value) { m_monitoringScheduleNameHasBeenSet = true; m_monitoringScheduleName = std::move(value); } /** *

Name of a specific schedule to fetch jobs for.

*/ inline void SetMonitoringScheduleName(const char* value) { m_monitoringScheduleNameHasBeenSet = true; m_monitoringScheduleName.assign(value); } /** *

Name of a specific schedule to fetch jobs for.

*/ inline ListMonitoringExecutionsRequest& WithMonitoringScheduleName(const Aws::String& value) { SetMonitoringScheduleName(value); return *this;} /** *

Name of a specific schedule to fetch jobs for.

*/ inline ListMonitoringExecutionsRequest& WithMonitoringScheduleName(Aws::String&& value) { SetMonitoringScheduleName(std::move(value)); return *this;} /** *

Name of a specific schedule to fetch jobs for.

*/ inline ListMonitoringExecutionsRequest& WithMonitoringScheduleName(const char* value) { SetMonitoringScheduleName(value); return *this;} /** *

Name of a specific endpoint to fetch jobs for.

*/ inline const Aws::String& GetEndpointName() const{ return m_endpointName; } /** *

Name of a specific endpoint to fetch jobs for.

*/ inline bool EndpointNameHasBeenSet() const { return m_endpointNameHasBeenSet; } /** *

Name of a specific endpoint to fetch jobs for.

*/ inline void SetEndpointName(const Aws::String& value) { m_endpointNameHasBeenSet = true; m_endpointName = value; } /** *

Name of a specific endpoint to fetch jobs for.

*/ inline void SetEndpointName(Aws::String&& value) { m_endpointNameHasBeenSet = true; m_endpointName = std::move(value); } /** *

Name of a specific endpoint to fetch jobs for.

*/ inline void SetEndpointName(const char* value) { m_endpointNameHasBeenSet = true; m_endpointName.assign(value); } /** *

Name of a specific endpoint to fetch jobs for.

*/ inline ListMonitoringExecutionsRequest& WithEndpointName(const Aws::String& value) { SetEndpointName(value); return *this;} /** *

Name of a specific endpoint to fetch jobs for.

*/ inline ListMonitoringExecutionsRequest& WithEndpointName(Aws::String&& value) { SetEndpointName(std::move(value)); return *this;} /** *

Name of a specific endpoint to fetch jobs for.

*/ inline ListMonitoringExecutionsRequest& WithEndpointName(const char* value) { SetEndpointName(value); return *this;} /** *

Whether to sort results by Status, CreationTime, * ScheduledTime field. The default is CreationTime.

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

Whether to sort results by Status, CreationTime, * ScheduledTime field. The default is CreationTime.

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

Whether to sort results by Status, CreationTime, * ScheduledTime field. The default is CreationTime.

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

Whether to sort results by Status, CreationTime, * ScheduledTime field. The default is CreationTime.

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

Whether to sort results by Status, CreationTime, * ScheduledTime field. The default is CreationTime.

*/ inline ListMonitoringExecutionsRequest& WithSortBy(const MonitoringExecutionSortKey& value) { SetSortBy(value); return *this;} /** *

Whether to sort results by Status, CreationTime, * ScheduledTime field. The default is CreationTime.

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

Whether to sort the results in Ascending or * Descending order. The default is Descending.

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

Whether to sort the results in Ascending or * Descending order. The default is Descending.

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

Whether to sort the results in Ascending or * Descending order. The default is Descending.

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

Whether to sort the results in Ascending or * Descending order. The default is Descending.

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

Whether to sort the results in Ascending or * Descending order. The default is Descending.

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

Whether to sort the results in Ascending or * Descending order. The default is Descending.

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

The token returned if the response is truncated. To retrieve the next set of * job executions, use it in the next request.

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

The token returned if the response is truncated. To retrieve the next set of * job executions, use it in the next request.

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

The token returned if the response is truncated. To retrieve the next set of * job executions, use it in the next request.

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

The token returned if the response is truncated. To retrieve the next set of * job executions, use it in the next request.

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

The token returned if the response is truncated. To retrieve the next set of * job executions, use it in the next request.

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

The token returned if the response is truncated. To retrieve the next set of * job executions, use it in the next request.

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

The token returned if the response is truncated. To retrieve the next set of * job executions, use it in the next request.

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

The token returned if the response is truncated. To retrieve the next set of * job executions, use it in the next request.

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

The maximum number of jobs to return in the response. The default value is * 10.

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

The maximum number of jobs to return in the response. The default value is * 10.

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

The maximum number of jobs to return in the response. The default value is * 10.

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

The maximum number of jobs to return in the response. The default value is * 10.

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

Filter for jobs scheduled before a specified time.

*/ inline const Aws::Utils::DateTime& GetScheduledTimeBefore() const{ return m_scheduledTimeBefore; } /** *

Filter for jobs scheduled before a specified time.

*/ inline bool ScheduledTimeBeforeHasBeenSet() const { return m_scheduledTimeBeforeHasBeenSet; } /** *

Filter for jobs scheduled before a specified time.

*/ inline void SetScheduledTimeBefore(const Aws::Utils::DateTime& value) { m_scheduledTimeBeforeHasBeenSet = true; m_scheduledTimeBefore = value; } /** *

Filter for jobs scheduled before a specified time.

*/ inline void SetScheduledTimeBefore(Aws::Utils::DateTime&& value) { m_scheduledTimeBeforeHasBeenSet = true; m_scheduledTimeBefore = std::move(value); } /** *

Filter for jobs scheduled before a specified time.

*/ inline ListMonitoringExecutionsRequest& WithScheduledTimeBefore(const Aws::Utils::DateTime& value) { SetScheduledTimeBefore(value); return *this;} /** *

Filter for jobs scheduled before a specified time.

*/ inline ListMonitoringExecutionsRequest& WithScheduledTimeBefore(Aws::Utils::DateTime&& value) { SetScheduledTimeBefore(std::move(value)); return *this;} /** *

Filter for jobs scheduled after a specified time.

*/ inline const Aws::Utils::DateTime& GetScheduledTimeAfter() const{ return m_scheduledTimeAfter; } /** *

Filter for jobs scheduled after a specified time.

*/ inline bool ScheduledTimeAfterHasBeenSet() const { return m_scheduledTimeAfterHasBeenSet; } /** *

Filter for jobs scheduled after a specified time.

*/ inline void SetScheduledTimeAfter(const Aws::Utils::DateTime& value) { m_scheduledTimeAfterHasBeenSet = true; m_scheduledTimeAfter = value; } /** *

Filter for jobs scheduled after a specified time.

*/ inline void SetScheduledTimeAfter(Aws::Utils::DateTime&& value) { m_scheduledTimeAfterHasBeenSet = true; m_scheduledTimeAfter = std::move(value); } /** *

Filter for jobs scheduled after a specified time.

*/ inline ListMonitoringExecutionsRequest& WithScheduledTimeAfter(const Aws::Utils::DateTime& value) { SetScheduledTimeAfter(value); return *this;} /** *

Filter for jobs scheduled after a specified time.

*/ inline ListMonitoringExecutionsRequest& WithScheduledTimeAfter(Aws::Utils::DateTime&& value) { SetScheduledTimeAfter(std::move(value)); return *this;} /** *

A filter that returns only jobs created before a specified time.

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

A filter that returns only jobs created before a specified time.

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

A filter that returns only jobs created before a specified time.

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

A filter that returns only jobs created before a specified time.

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

A filter that returns only jobs created before a specified time.

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

A filter that returns only jobs created before a specified time.

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

A filter that returns only jobs created after a specified time.

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

A filter that returns only jobs created after a specified time.

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

A filter that returns only jobs created after a specified time.

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

A filter that returns only jobs created after a specified time.

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

A filter that returns only jobs created after a specified time.

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

A filter that returns only jobs created after a specified time.

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

A filter that returns only jobs modified after a specified time.

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

A filter that returns only jobs modified after a specified time.

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

A filter that returns only jobs modified after a specified time.

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

A filter that returns only jobs modified after a specified time.

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

A filter that returns only jobs modified after a specified time.

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

A filter that returns only jobs modified after a specified time.

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

A filter that returns only jobs modified before a specified time.

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

A filter that returns only jobs modified before a specified time.

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

A filter that returns only jobs modified before a specified time.

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

A filter that returns only jobs modified before a specified time.

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

A filter that returns only jobs modified before a specified time.

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

A filter that returns only jobs modified before a specified time.

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

A filter that retrieves only jobs with a specific status.

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

A filter that retrieves only jobs with a specific status.

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

A filter that retrieves only jobs with a specific status.

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

A filter that retrieves only jobs with a specific status.

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

A filter that retrieves only jobs with a specific status.

*/ inline ListMonitoringExecutionsRequest& WithStatusEquals(const ExecutionStatus& value) { SetStatusEquals(value); return *this;} /** *

A filter that retrieves only jobs with a specific status.

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

Gets a list of the monitoring job runs of the specified monitoring job * definitions.

*/ inline const Aws::String& GetMonitoringJobDefinitionName() const{ return m_monitoringJobDefinitionName; } /** *

Gets a list of the monitoring job runs of the specified monitoring job * definitions.

*/ inline bool MonitoringJobDefinitionNameHasBeenSet() const { return m_monitoringJobDefinitionNameHasBeenSet; } /** *

Gets a list of the monitoring job runs of the specified monitoring job * definitions.

*/ inline void SetMonitoringJobDefinitionName(const Aws::String& value) { m_monitoringJobDefinitionNameHasBeenSet = true; m_monitoringJobDefinitionName = value; } /** *

Gets a list of the monitoring job runs of the specified monitoring job * definitions.

*/ inline void SetMonitoringJobDefinitionName(Aws::String&& value) { m_monitoringJobDefinitionNameHasBeenSet = true; m_monitoringJobDefinitionName = std::move(value); } /** *

Gets a list of the monitoring job runs of the specified monitoring job * definitions.

*/ inline void SetMonitoringJobDefinitionName(const char* value) { m_monitoringJobDefinitionNameHasBeenSet = true; m_monitoringJobDefinitionName.assign(value); } /** *

Gets a list of the monitoring job runs of the specified monitoring job * definitions.

*/ inline ListMonitoringExecutionsRequest& WithMonitoringJobDefinitionName(const Aws::String& value) { SetMonitoringJobDefinitionName(value); return *this;} /** *

Gets a list of the monitoring job runs of the specified monitoring job * definitions.

*/ inline ListMonitoringExecutionsRequest& WithMonitoringJobDefinitionName(Aws::String&& value) { SetMonitoringJobDefinitionName(std::move(value)); return *this;} /** *

Gets a list of the monitoring job runs of the specified monitoring job * definitions.

*/ inline ListMonitoringExecutionsRequest& WithMonitoringJobDefinitionName(const char* value) { SetMonitoringJobDefinitionName(value); return *this;} /** *

A filter that returns only the monitoring job runs of the specified * monitoring type.

*/ inline const MonitoringType& GetMonitoringTypeEquals() const{ return m_monitoringTypeEquals; } /** *

A filter that returns only the monitoring job runs of the specified * monitoring type.

*/ inline bool MonitoringTypeEqualsHasBeenSet() const { return m_monitoringTypeEqualsHasBeenSet; } /** *

A filter that returns only the monitoring job runs of the specified * monitoring type.

*/ inline void SetMonitoringTypeEquals(const MonitoringType& value) { m_monitoringTypeEqualsHasBeenSet = true; m_monitoringTypeEquals = value; } /** *

A filter that returns only the monitoring job runs of the specified * monitoring type.

*/ inline void SetMonitoringTypeEquals(MonitoringType&& value) { m_monitoringTypeEqualsHasBeenSet = true; m_monitoringTypeEquals = std::move(value); } /** *

A filter that returns only the monitoring job runs of the specified * monitoring type.

*/ inline ListMonitoringExecutionsRequest& WithMonitoringTypeEquals(const MonitoringType& value) { SetMonitoringTypeEquals(value); return *this;} /** *

A filter that returns only the monitoring job runs of the specified * monitoring type.

*/ inline ListMonitoringExecutionsRequest& WithMonitoringTypeEquals(MonitoringType&& value) { SetMonitoringTypeEquals(std::move(value)); return *this;} private: Aws::String m_monitoringScheduleName; bool m_monitoringScheduleNameHasBeenSet = false; Aws::String m_endpointName; bool m_endpointNameHasBeenSet = false; MonitoringExecutionSortKey m_sortBy; bool m_sortByHasBeenSet = false; SortOrder m_sortOrder; bool m_sortOrderHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::Utils::DateTime m_scheduledTimeBefore; bool m_scheduledTimeBeforeHasBeenSet = false; Aws::Utils::DateTime m_scheduledTimeAfter; bool m_scheduledTimeAfterHasBeenSet = 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; ExecutionStatus m_statusEquals; bool m_statusEqualsHasBeenSet = false; Aws::String m_monitoringJobDefinitionName; bool m_monitoringJobDefinitionNameHasBeenSet = false; MonitoringType m_monitoringTypeEquals; bool m_monitoringTypeEqualsHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws