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