« blib/lib/Paws/SageMaker/StartNotebookInstance.pm
↑ Summary
blib/lib/Paws/SageMaker/StartPipelineExecutionResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::StartPipelineExecution; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has PipelineExecutionDescription => (is => 'ro', isa => 'Str'); | ||
| 6 | has PipelineExecutionDisplayName => (is => 'ro', isa => 'Str'); | ||
| 7 | has PipelineName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has PipelineParameters => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Parameter]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartPipelineExecution'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::StartPipelineExecutionResponse'); | ||
| 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::StartPipelineExecution - Arguments for method StartPipelineExecution on L<Paws::SageMaker> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method StartPipelineExecution on the | ||
| 26 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 27 | as arguments to method StartPipelineExecution. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartPipelineExecution. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 34 | my $StartPipelineExecutionResponse = | ||
| 35 | $api . sagemaker->StartPipelineExecution( | ||
| 36 | ClientRequestToken => 'MyIdempotencyToken', | ||
| 37 | PipelineName => 'MyPipelineName', | ||
| 38 | PipelineExecutionDescription => | ||
| 39 | 'MyPipelineExecutionDescription', # OPTIONAL | ||
| 40 | PipelineExecutionDisplayName => 'MyPipelineExecutionName', # OPTIONAL | ||
| 41 | PipelineParameters => [ | ||
| 42 | { | ||
| 43 | Name => 'MyPipelineParameterName', # min: 1, max: 256 | ||
| 44 | Value => 'MyString1024', # max: 1024 | ||
| 45 | |||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $PipelineExecutionArn = | ||
| 53 | $StartPipelineExecutionResponse->PipelineExecutionArn; | ||
| 54 | |||
| 55 | # Returns a L<Paws::SageMaker::StartPipelineExecutionResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/StartPipelineExecution> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> ClientRequestToken => Str | ||
| 64 | |||
| 65 | A unique, case-sensitive identifier that you provide to ensure the | ||
| 66 | idempotency of the operation. An idempotent operation completes no more | ||
| 67 | than one time. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 PipelineExecutionDescription => Str | ||
| 72 | |||
| 73 | The description of the pipeline execution. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 PipelineExecutionDisplayName => Str | ||
| 78 | |||
| 79 | The display name of the pipeline execution. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> PipelineName => Str | ||
| 84 | |||
| 85 | The name of the pipeline. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 PipelineParameters => ArrayRef[L<Paws::SageMaker::Parameter>] | ||
| 90 | |||
| 91 | Contains a list of pipeline parameters. This list can be empty. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method StartPipelineExecution in L<Paws::SageMaker> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |