« blib/lib/Paws/SageMaker/ListModelPackageGroupsOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/ListModelPackagesOutput.pm »
| 1 | |||
| 2 | package Paws::SageMaker::ListModelPackages; | ||
| 3 | use Moose; | ||
| 4 | has CreationTimeAfter => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreationTimeBefore => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has ModelApprovalStatus => (is => 'ro', isa => 'Str'); | ||
| 8 | has ModelPackageGroupName => (is => 'ro', isa => 'Str'); | ||
| 9 | has ModelPackageType => (is => 'ro', isa => 'Str'); | ||
| 10 | has NameContains => (is => 'ro', isa => 'Str'); | ||
| 11 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 12 | has SortBy => (is => 'ro', isa => 'Str'); | ||
| 13 | has SortOrder => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListModelPackages'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::ListModelPackagesOutput'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::SageMaker::ListModelPackages - Arguments for method ListModelPackages on L<Paws::SageMaker> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method ListModelPackages on the | ||
| 31 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 32 | as arguments to method ListModelPackages. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListModelPackages. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 39 | my $ListModelPackagesOutput = $api . sagemaker->ListModelPackages( | ||
| 40 | CreationTimeAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 41 | CreationTimeBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 42 | MaxResults => 1, # OPTIONAL | ||
| 43 | ModelApprovalStatus => 'Approved', # OPTIONAL | ||
| 44 | ModelPackageGroupName => 'MyArnOrName', # OPTIONAL | ||
| 45 | ModelPackageType => 'Versioned', # OPTIONAL | ||
| 46 | NameContains => 'MyNameContains', # OPTIONAL | ||
| 47 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 48 | SortBy => 'Name', # OPTIONAL | ||
| 49 | SortOrder => 'Ascending', # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $ModelPackageSummaryList = | ||
| 54 | $ListModelPackagesOutput->ModelPackageSummaryList; | ||
| 55 | my $NextToken = $ListModelPackagesOutput->NextToken; | ||
| 56 | |||
| 57 | # Returns a L<Paws::SageMaker::ListModelPackagesOutput> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/ListModelPackages> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 CreationTimeAfter => Str | ||
| 66 | |||
| 67 | A filter that returns only model packages created after the specified | ||
| 68 | time (timestamp). | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 CreationTimeBefore => Str | ||
| 73 | |||
| 74 | A filter that returns only model packages created before the specified | ||
| 75 | time (timestamp). | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 MaxResults => Int | ||
| 80 | |||
| 81 | The maximum number of model packages to return in the response. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 ModelApprovalStatus => Str | ||
| 86 | |||
| 87 | A filter that returns only the model packages with the specified | ||
| 88 | approval status. | ||
| 89 | |||
| 90 | Valid values are: C<"Approved">, C<"Rejected">, C<"PendingManualApproval"> | ||
| 91 | |||
| 92 | =head2 ModelPackageGroupName => Str | ||
| 93 | |||
| 94 | A filter that returns only model versions that belong to the specified | ||
| 95 | model group. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 ModelPackageType => Str | ||
| 100 | |||
| 101 | A filter that returns onlyl the model packages of the specified type. | ||
| 102 | This can be one of the following values. | ||
| 103 | |||
| 104 | =over | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<VERSIONED> - List only versioned models. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<UNVERSIONED> - List only unversioined models. | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<BOTH> - List both versioned and unversioned models. | ||
| 117 | |||
| 118 | =back | ||
| 119 | |||
| 120 | |||
| 121 | Valid values are: C<"Versioned">, C<"Unversioned">, C<"Both"> | ||
| 122 | |||
| 123 | =head2 NameContains => Str | ||
| 124 | |||
| 125 | A string in the model package name. This filter returns only model | ||
| 126 | packages whose name contains the specified string. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 NextToken => Str | ||
| 131 | |||
| 132 | If the response to a previous C<ListModelPackages> request was | ||
| 133 | truncated, the response includes a C<NextToken>. To retrieve the next | ||
| 134 | set of model packages, use the token in the next request. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 SortBy => Str | ||
| 139 | |||
| 140 | The parameter by which to sort the results. The default is | ||
| 141 | C<CreationTime>. | ||
| 142 | |||
| 143 | Valid values are: C<"Name">, C<"CreationTime"> | ||
| 144 | |||
| 145 | =head2 SortOrder => Str | ||
| 146 | |||
| 147 | The sort order for the results. The default is C<Ascending>. | ||
| 148 | |||
| 149 | Valid values are: C<"Ascending">, C<"Descending"> | ||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, documenting arguments for method ListModelPackages in L<Paws::SageMaker> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |