« blib/lib/Paws/SageMaker/CreateTrial.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateTrialComponentResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateTrialComponent; | ||
| 3 | use Moose; | ||
| 4 | has DisplayName => (is => 'ro', isa => 'Str'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has InputArtifacts => (is => 'ro', isa => 'Paws::SageMaker::TrialComponentArtifacts'); | ||
| 7 | has MetadataProperties => (is => 'ro', isa => 'Paws::SageMaker::MetadataProperties'); | ||
| 8 | has OutputArtifacts => (is => 'ro', isa => 'Paws::SageMaker::TrialComponentArtifacts'); | ||
| 9 | has Parameters => (is => 'ro', isa => 'Paws::SageMaker::TrialComponentParameters'); | ||
| 10 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has Status => (is => 'ro', isa => 'Paws::SageMaker::TrialComponentStatus'); | ||
| 12 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 13 | has TrialComponentName => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTrialComponent'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateTrialComponentResponse'); | ||
| 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::CreateTrialComponent - Arguments for method CreateTrialComponent on L<Paws::SageMaker> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateTrialComponent on the | ||
| 31 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateTrialComponent. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTrialComponent. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 39 | my $CreateTrialComponentResponse = $api . sagemaker->CreateTrialComponent( | ||
| 40 | TrialComponentName => 'MyExperimentEntityName', | ||
| 41 | DisplayName => 'MyExperimentEntityName', # OPTIONAL | ||
| 42 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | InputArtifacts => { | ||
| 44 | 'MyTrialComponentKey64' => { | ||
| 45 | Value => 'MyTrialComponentArtifactValue', # max: 2048 | ||
| 46 | MediaType => 'MyMediaType', # max: 64; OPTIONAL | ||
| 47 | }, # key: max: 64 | ||
| 48 | }, # OPTIONAL | ||
| 49 | MetadataProperties => { | ||
| 50 | CommitId => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL | ||
| 51 | GeneratedBy => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL | ||
| 52 | ProjectId => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL | ||
| 53 | Repository => 'MyMetadataPropertyValue', # max: 1024; OPTIONAL | ||
| 54 | }, # OPTIONAL | ||
| 55 | OutputArtifacts => { | ||
| 56 | 'MyTrialComponentKey64' => { | ||
| 57 | Value => 'MyTrialComponentArtifactValue', # max: 2048 | ||
| 58 | MediaType => 'MyMediaType', # max: 64; OPTIONAL | ||
| 59 | }, # key: max: 64 | ||
| 60 | }, # OPTIONAL | ||
| 61 | Parameters => { | ||
| 62 | 'MyTrialComponentKey256' => { | ||
| 63 | NumberValue => 1, # OPTIONAL | ||
| 64 | StringValue => 'MyStringParameterValue', # max: 256; OPTIONAL | ||
| 65 | }, # key: max: 256 | ||
| 66 | }, # OPTIONAL | ||
| 67 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 68 | Status => { | ||
| 69 | Message => 'MyTrialComponentStatusMessage', # max: 1024; OPTIONAL | ||
| 70 | PrimaryStatus => 'InProgress' | ||
| 71 | , # values: InProgress, Completed, Failed, Stopping, Stopped; OPTIONAL | ||
| 72 | }, # OPTIONAL | ||
| 73 | Tags => [ | ||
| 74 | { | ||
| 75 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 76 | Value => 'MyTagValue', # max: 256 | ||
| 77 | |||
| 78 | }, | ||
| 79 | ... | ||
| 80 | ], # OPTIONAL | ||
| 81 | ); | ||
| 82 | |||
| 83 | # Results: | ||
| 84 | my $TrialComponentArn = $CreateTrialComponentResponse->TrialComponentArn; | ||
| 85 | |||
| 86 | # Returns a L<Paws::SageMaker::CreateTrialComponentResponse> object. | ||
| 87 | |||
| 88 | 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. | ||
| 89 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateTrialComponent> | ||
| 90 | |||
| 91 | =head1 ATTRIBUTES | ||
| 92 | |||
| 93 | |||
| 94 | =head2 DisplayName => Str | ||
| 95 | |||
| 96 | The name of the component as displayed. The name doesn't need to be | ||
| 97 | unique. If C<DisplayName> isn't specified, C<TrialComponentName> is | ||
| 98 | displayed. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 EndTime => Str | ||
| 103 | |||
| 104 | When the component ended. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 InputArtifacts => L<Paws::SageMaker::TrialComponentArtifacts> | ||
| 109 | |||
| 110 | The input artifacts for the component. Examples of input artifacts are | ||
| 111 | datasets, algorithms, hyperparameters, source code, and instance types. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 MetadataProperties => L<Paws::SageMaker::MetadataProperties> | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 OutputArtifacts => L<Paws::SageMaker::TrialComponentArtifacts> | ||
| 122 | |||
| 123 | The output artifacts for the component. Examples of output artifacts | ||
| 124 | are metrics, snapshots, logs, and images. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 Parameters => L<Paws::SageMaker::TrialComponentParameters> | ||
| 129 | |||
| 130 | The hyperparameters for the component. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 StartTime => Str | ||
| 135 | |||
| 136 | When the component started. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 Status => L<Paws::SageMaker::TrialComponentStatus> | ||
| 141 | |||
| 142 | The status of the component. States include: | ||
| 143 | |||
| 144 | =over | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | InProgress | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | Completed | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | Failed | ||
| 157 | |||
| 158 | =back | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 164 | |||
| 165 | A list of tags to associate with the component. You can use Search API | ||
| 166 | to search on the tags. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 B<REQUIRED> TrialComponentName => Str | ||
| 171 | |||
| 172 | The name of the component. The name must be unique in your Amazon Web | ||
| 173 | Services account and is not case-sensitive. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head1 SEE ALSO | ||
| 179 | |||
| 180 | This class forms part of L<Paws>, documenting arguments for method CreateTrialComponent in L<Paws::SageMaker> | ||
| 181 | |||
| 182 | =head1 BUGS and CONTRIBUTIONS | ||
| 183 | |||
| 184 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 185 | |||
| 186 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 187 | |||
| 188 | =cut | ||
| 189 |