Class: Aws::SageMaker::Types::ListMonitoringExecutionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass ListMonitoringExecutionsRequest data as a hash:

{
  monitoring_schedule_name: "MonitoringScheduleName",
  endpoint_name: "EndpointName",
  sort_by: "CreationTime", # accepts CreationTime, ScheduledTime, Status
  sort_order: "Ascending", # accepts Ascending, Descending
  next_token: "NextToken",
  max_results: 1,
  scheduled_time_before: Time.now,
  scheduled_time_after: Time.now,
  creation_time_before: Time.now,
  creation_time_after: Time.now,
  last_modified_time_before: Time.now,
  last_modified_time_after: Time.now,
  status_equals: "Pending", # accepts Pending, Completed, CompletedWithViolations, InProgress, Failed, Stopping, Stopped
  monitoring_job_definition_name: "MonitoringJobDefinitionName",
  monitoring_type_equals: "DataQuality", # accepts DataQuality, ModelQuality, ModelBias, ModelExplainability
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time_afterTime

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

Returns:

  • (Time)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time_beforeTime

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

Returns:

  • (Time)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_nameString

Name of a specific endpoint to fetch jobs for.

Returns:

  • (String)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time_afterTime

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

Returns:

  • (Time)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time_beforeTime

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

Returns:

  • (Time)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_job_definition_nameString

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

Returns:

  • (String)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_schedule_nameString

Name of a specific schedule to fetch jobs for.

Returns:

  • (String)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_type_equalsString

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

Returns:

  • (String)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_time_afterTime

Filter for jobs scheduled after a specified time.

Returns:

  • (Time)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_time_beforeTime

Filter for jobs scheduled before a specified time.

Returns:

  • (Time)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#sort_byString

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

Returns:

  • (String)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#sort_orderString

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

Returns:

  • (String)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end

#status_equalsString

A filter that retrieves only jobs with a specific status.

Returns:

  • (String)


27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27920

class ListMonitoringExecutionsRequest < Struct.new(
  :monitoring_schedule_name,
  :endpoint_name,
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :scheduled_time_before,
  :scheduled_time_after,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :monitoring_job_definition_name,
  :monitoring_type_equals)
  SENSITIVE = []
  include Aws::Structure
end