« blib/lib/Paws/SageMaker/CreateTransformJobResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateTrialComponent.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateTrial; | ||
| 3 | use Moose; | ||
| 4 | has DisplayName => (is => 'ro', isa => 'Str'); | ||
| 5 | has ExperimentName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has MetadataProperties => (is => 'ro', isa => 'Paws::SageMaker::MetadataProperties'); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 8 | has TrialName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTrial'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateTrialResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::SageMaker::CreateTrial - Arguments for method CreateTrial on L<Paws::SageMaker> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateTrial on the | ||
| 26 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateTrial. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTrial. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 34 | my $CreateTrialResponse = $api . sagemaker->CreateTrial( | ||
| 35 | ExperimentName => 'MyExperimentEntityName', | ||
| 36 | TrialName => 'MyExperimentEntityName', | ||
| 37 | DisplayName => 'MyExperimentEntityName', # OPTIONAL | ||
| 38 | MetadataProperties => { | ||
| 39 | CommitId => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL | ||
| 40 | GeneratedBy => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL | ||
| 41 | ProjectId => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL | ||
| 42 | Repository => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL | ||
| 43 | }, # OPTIONAL | ||
| 44 | Tags => [ | ||
| 45 | { | ||
| 46 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 47 | Value => 'MyTagValue', # max: 256 | ||
| 48 | |||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $TrialArn = $CreateTrialResponse->TrialArn; | ||
| 56 | |||
| 57 | # Returns a L<Paws::SageMaker::CreateTrialResponse> 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/CreateTrial> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DisplayName => Str | ||
| 66 | |||
| 67 | The name of the trial as displayed. The name doesn't need to be unique. | ||
| 68 | If C<DisplayName> isn't specified, C<TrialName> is displayed. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> ExperimentName => Str | ||
| 73 | |||
| 74 | The name of the experiment to associate the trial with. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 MetadataProperties => L<Paws::SageMaker::MetadataProperties> | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 85 | |||
| 86 | A list of tags to associate with the trial. You can use Search API to | ||
| 87 | search on the tags. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> TrialName => Str | ||
| 92 | |||
| 93 | The name of the trial. The name must be unique in your Amazon Web | ||
| 94 | Services account and is not case-sensitive. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method CreateTrial in L<Paws::SageMaker> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |