« blib/lib/Paws/SageMaker/ListModelsOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/ListMonitoringExecutionsResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::ListMonitoringExecutions; | ||
| 3 | use Moose; | ||
| 4 | has CreationTimeAfter => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreationTimeBefore => (is => 'ro', isa => 'Str'); | ||
| 6 | has EndpointName => (is => 'ro', isa => 'Str'); | ||
| 7 | has LastModifiedTimeAfter => (is => 'ro', isa => 'Str'); | ||
| 8 | has LastModifiedTimeBefore => (is => 'ro', isa => 'Str'); | ||
| 9 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 10 | has MonitoringJobDefinitionName => (is => 'ro', isa => 'Str'); | ||
| 11 | has MonitoringScheduleName => (is => 'ro', isa => 'Str'); | ||
| 12 | has MonitoringTypeEquals => (is => 'ro', isa => 'Str'); | ||
| 13 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 14 | has ScheduledTimeAfter => (is => 'ro', isa => 'Str'); | ||
| 15 | has ScheduledTimeBefore => (is => 'ro', isa => 'Str'); | ||
| 16 | has SortBy => (is => 'ro', isa => 'Str'); | ||
| 17 | has SortOrder => (is => 'ro', isa => 'Str'); | ||
| 18 | has StatusEquals => (is => 'ro', isa => 'Str'); | ||
| 19 | |||
| 20 | use MooseX::ClassAttribute; | ||
| 21 | |||
| 22 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListMonitoringExecutions'); | ||
| 23 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::ListMonitoringExecutionsResponse'); | ||
| 24 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::SageMaker::ListMonitoringExecutions - Arguments for method ListMonitoringExecutions on L<Paws::SageMaker> | ||
| 32 | |||
| 33 | =head1 DESCRIPTION | ||
| 34 | |||
| 35 | This class represents the parameters used for calling the method ListMonitoringExecutions on the | ||
| 36 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 37 | as arguments to method ListMonitoringExecutions. | ||
| 38 | |||
| 39 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListMonitoringExecutions. | ||
| 40 | |||
| 41 | =head1 SYNOPSIS | ||
| 42 | |||
| 43 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 44 | my $ListMonitoringExecutionsResponse = | ||
| 45 | $api . sagemaker->ListMonitoringExecutions( | ||
| 46 | CreationTimeAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 47 | CreationTimeBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 48 | EndpointName => 'MyEndpointName', # OPTIONAL | ||
| 49 | LastModifiedTimeAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 50 | LastModifiedTimeBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 51 | MaxResults => 1, # OPTIONAL | ||
| 52 | MonitoringJobDefinitionName => 'MyMonitoringJobDefinitionName', # OPTIONAL | ||
| 53 | MonitoringScheduleName => 'MyMonitoringScheduleName', # OPTIONAL | ||
| 54 | MonitoringTypeEquals => 'DataQuality', # OPTIONAL | ||
| 55 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 56 | ScheduledTimeAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 57 | ScheduledTimeBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 58 | SortBy => 'CreationTime', # OPTIONAL | ||
| 59 | SortOrder => 'Ascending', # OPTIONAL | ||
| 60 | StatusEquals => 'Pending', # OPTIONAL | ||
| 61 | ); | ||
| 62 | |||
| 63 | # Results: | ||
| 64 | my $MonitoringExecutionSummaries = | ||
| 65 | $ListMonitoringExecutionsResponse->MonitoringExecutionSummaries; | ||
| 66 | my $NextToken = $ListMonitoringExecutionsResponse->NextToken; | ||
| 67 | |||
| 68 | # Returns a L<Paws::SageMaker::ListMonitoringExecutionsResponse> object. | ||
| 69 | |||
| 70 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/ListMonitoringExecutions> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 CreationTimeAfter => Str | ||
| 77 | |||
| 78 | A filter that returns only jobs created after a specified time. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 CreationTimeBefore => Str | ||
| 83 | |||
| 84 | A filter that returns only jobs created before a specified time. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 EndpointName => Str | ||
| 89 | |||
| 90 | Name of a specific endpoint to fetch jobs for. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 LastModifiedTimeAfter => Str | ||
| 95 | |||
| 96 | A filter that returns only jobs modified before a specified time. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 LastModifiedTimeBefore => Str | ||
| 101 | |||
| 102 | A filter that returns only jobs modified after a specified time. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 MaxResults => Int | ||
| 107 | |||
| 108 | The maximum number of jobs to return in the response. The default value | ||
| 109 | is 10. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 MonitoringJobDefinitionName => Str | ||
| 114 | |||
| 115 | Gets a list of the monitoring job runs of the specified monitoring job | ||
| 116 | definitions. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 MonitoringScheduleName => Str | ||
| 121 | |||
| 122 | Name of a specific schedule to fetch jobs for. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 MonitoringTypeEquals => Str | ||
| 127 | |||
| 128 | A filter that returns only the monitoring job runs of the specified | ||
| 129 | monitoring type. | ||
| 130 | |||
| 131 | Valid values are: C<"DataQuality">, C<"ModelQuality">, C<"ModelBias">, C<"ModelExplainability"> | ||
| 132 | |||
| 133 | =head2 NextToken => Str | ||
| 134 | |||
| 135 | The token returned if the response is truncated. To retrieve the next | ||
| 136 | set of job executions, use it in the next request. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 ScheduledTimeAfter => Str | ||
| 141 | |||
| 142 | Filter for jobs scheduled after a specified time. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 ScheduledTimeBefore => Str | ||
| 147 | |||
| 148 | Filter for jobs scheduled before a specified time. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 SortBy => Str | ||
| 153 | |||
| 154 | Whether to sort results by C<Status>, C<CreationTime>, C<ScheduledTime> | ||
| 155 | field. The default is C<CreationTime>. | ||
| 156 | |||
| 157 | Valid values are: C<"CreationTime">, C<"ScheduledTime">, C<"Status"> | ||
| 158 | |||
| 159 | =head2 SortOrder => Str | ||
| 160 | |||
| 161 | Whether to sort the results in C<Ascending> or C<Descending> order. The | ||
| 162 | default is C<Descending>. | ||
| 163 | |||
| 164 | Valid values are: C<"Ascending">, C<"Descending"> | ||
| 165 | |||
| 166 | =head2 StatusEquals => Str | ||
| 167 | |||
| 168 | A filter that retrieves only jobs with a specific status. | ||
| 169 | |||
| 170 | Valid values are: C<"Pending">, C<"Completed">, C<"CompletedWithViolations">, C<"InProgress">, C<"Failed">, C<"Stopping">, C<"Stopped"> | ||
| 171 | |||
| 172 | |||
| 173 | =head1 SEE ALSO | ||
| 174 | |||
| 175 | This class forms part of L<Paws>, documenting arguments for method ListMonitoringExecutions in L<Paws::SageMaker> | ||
| 176 | |||
| 177 | =head1 BUGS and CONTRIBUTIONS | ||
| 178 | |||
| 179 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 180 | |||
| 181 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 182 | |||
| 183 | =cut | ||
| 184 |