« blib/lib/Paws/SageMaker/UpdateTrial.pm
↑ Summary
blib/lib/Paws/SageMaker/UpdateTrialComponentResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::UpdateTrialComponent; | ||
| 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 InputArtifactsToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has OutputArtifacts => (is => 'ro', isa => 'Paws::SageMaker::TrialComponentArtifacts'); | ||
| 9 | has OutputArtifactsToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has Parameters => (is => 'ro', isa => 'Paws::SageMaker::TrialComponentParameters'); | ||
| 11 | has ParametersToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 12 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 13 | has Status => (is => 'ro', isa => 'Paws::SageMaker::TrialComponentStatus'); | ||
| 14 | has TrialComponentName => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateTrialComponent'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::UpdateTrialComponentResponse'); | ||
| 20 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::SageMaker::UpdateTrialComponent - Arguments for method UpdateTrialComponent on L<Paws::SageMaker> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method UpdateTrialComponent on the | ||
| 32 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 33 | as arguments to method UpdateTrialComponent. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateTrialComponent. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 40 | my $UpdateTrialComponentResponse = $api . sagemaker->UpdateTrialComponent( | ||
| 41 | TrialComponentName => 'MyExperimentEntityName', | ||
| 42 | DisplayName => 'MyExperimentEntityName', # OPTIONAL | ||
| 43 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 44 | InputArtifacts => { | ||
| 45 | 'MyTrialComponentKey64' => { | ||
| 46 | Value => 'MyTrialComponentArtifactValue', # max: 2048 | ||
| 47 | MediaType => 'MyMediaType', # max: 64; OPTIONAL | ||
| 48 | }, # key: max: 64 | ||
| 49 | }, # OPTIONAL | ||
| 50 | InputArtifactsToRemove => [ | ||
| 51 | 'MyTrialComponentKey256', ... # max: 256 | ||
| 52 | ], # OPTIONAL | ||
| 53 | OutputArtifacts => { | ||
| 54 | 'MyTrialComponentKey64' => { | ||
| 55 | Value => 'MyTrialComponentArtifactValue', # max: 2048 | ||
| 56 | MediaType => 'MyMediaType', # max: 64; OPTIONAL | ||
| 57 | }, # key: max: 64 | ||
| 58 | }, # OPTIONAL | ||
| 59 | OutputArtifactsToRemove => [ | ||
| 60 | 'MyTrialComponentKey256', ... # max: 256 | ||
| 61 | ], # OPTIONAL | ||
| 62 | Parameters => { | ||
| 63 | 'MyTrialComponentKey256' => { | ||
| 64 | NumberValue => 1, # OPTIONAL | ||
| 65 | StringValue => 'MyStringParameterValue', # max: 256; OPTIONAL | ||
| 66 | }, # key: max: 256 | ||
| 67 | }, # OPTIONAL | ||
| 68 | ParametersToRemove => [ | ||
| 69 | 'MyTrialComponentKey256', ... # max: 256 | ||
| 70 | ], # OPTIONAL | ||
| 71 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 72 | Status => { | ||
| 73 | Message => 'MyTrialComponentStatusMessage', # max: 1024; OPTIONAL | ||
| 74 | PrimaryStatus => 'InProgress' | ||
| 75 | , # values: InProgress, Completed, Failed, Stopping, Stopped; OPTIONAL | ||
| 76 | }, # OPTIONAL | ||
| 77 | ); | ||
| 78 | |||
| 79 | # Results: | ||
| 80 | my $TrialComponentArn = $UpdateTrialComponentResponse->TrialComponentArn; | ||
| 81 | |||
| 82 | # Returns a L<Paws::SageMaker::UpdateTrialComponentResponse> object. | ||
| 83 | |||
| 84 | 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. | ||
| 85 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/UpdateTrialComponent> | ||
| 86 | |||
| 87 | =head1 ATTRIBUTES | ||
| 88 | |||
| 89 | |||
| 90 | =head2 DisplayName => Str | ||
| 91 | |||
| 92 | The name of the component as displayed. The name doesn't need to be | ||
| 93 | unique. If C<DisplayName> isn't specified, C<TrialComponentName> is | ||
| 94 | displayed. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 EndTime => Str | ||
| 99 | |||
| 100 | When the component ended. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 InputArtifacts => L<Paws::SageMaker::TrialComponentArtifacts> | ||
| 105 | |||
| 106 | Replaces all of the component's input artifacts with the specified | ||
| 107 | artifacts. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 InputArtifactsToRemove => ArrayRef[Str|Undef] | ||
| 112 | |||
| 113 | The input artifacts to remove from the component. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 OutputArtifacts => L<Paws::SageMaker::TrialComponentArtifacts> | ||
| 118 | |||
| 119 | Replaces all of the component's output artifacts with the specified | ||
| 120 | artifacts. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 OutputArtifactsToRemove => ArrayRef[Str|Undef] | ||
| 125 | |||
| 126 | The output artifacts to remove from the component. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 Parameters => L<Paws::SageMaker::TrialComponentParameters> | ||
| 131 | |||
| 132 | Replaces all of the component's hyperparameters with the specified | ||
| 133 | hyperparameters. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 ParametersToRemove => ArrayRef[Str|Undef] | ||
| 138 | |||
| 139 | The hyperparameters to remove from the component. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 StartTime => Str | ||
| 144 | |||
| 145 | When the component started. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 Status => L<Paws::SageMaker::TrialComponentStatus> | ||
| 150 | |||
| 151 | The new status of the component. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 B<REQUIRED> TrialComponentName => Str | ||
| 156 | |||
| 157 | The name of the component to update. | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head1 SEE ALSO | ||
| 163 | |||
| 164 | This class forms part of L<Paws>, documenting arguments for method UpdateTrialComponent in L<Paws::SageMaker> | ||
| 165 | |||
| 166 | =head1 BUGS and CONTRIBUTIONS | ||
| 167 | |||
| 168 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 169 | |||
| 170 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 171 | |||
| 172 | =cut | ||
| 173 |