« blib/lib/Paws/SageMaker/CreateAlgorithmOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateAppImageConfig.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateApp; | ||
| 3 | use Moose; | ||
| 4 | has AppName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AppType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DomainId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ResourceSpec => (is => 'ro', isa => 'Paws::SageMaker::ResourceSpec'); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 9 | has UserProfileName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateApp'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateAppResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::SageMaker::CreateApp - Arguments for method CreateApp on L<Paws::SageMaker> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateApp on the | ||
| 27 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateApp. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateApp. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 35 | my $CreateAppResponse = $api . sagemaker->CreateApp( | ||
| 36 | AppName => 'MyAppName', | ||
| 37 | AppType => 'JupyterServer', | ||
| 38 | DomainId => 'MyDomainId', | ||
| 39 | UserProfileName => 'MyUserProfileName', | ||
| 40 | ResourceSpec => { | ||
| 41 | InstanceType => 'system' | ||
| 42 | , # values: system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL | ||
| 43 | SageMakerImageArn => 'MyImageArn', # max: 256; OPTIONAL | ||
| 44 | SageMakerImageVersionArn => 'MyImageVersionArn', # max: 256; OPTIONAL | ||
| 45 | }, # OPTIONAL | ||
| 46 | Tags => [ | ||
| 47 | { | ||
| 48 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 49 | Value => 'MyTagValue', # max: 256 | ||
| 50 | |||
| 51 | }, | ||
| 52 | ... | ||
| 53 | ], # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $AppArn = $CreateAppResponse->AppArn; | ||
| 58 | |||
| 59 | # Returns a L<Paws::SageMaker::CreateAppResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateApp> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> AppName => Str | ||
| 68 | |||
| 69 | The name of the app. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> AppType => Str | ||
| 74 | |||
| 75 | The type of app. Supported apps are C<JupyterServer> and | ||
| 76 | C<KernelGateway>. C<TensorBoard> is not supported. | ||
| 77 | |||
| 78 | Valid values are: C<"JupyterServer">, C<"KernelGateway">, C<"TensorBoard"> | ||
| 79 | |||
| 80 | =head2 B<REQUIRED> DomainId => Str | ||
| 81 | |||
| 82 | The domain ID. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 ResourceSpec => L<Paws::SageMaker::ResourceSpec> | ||
| 87 | |||
| 88 | The instance type and the Amazon Resource Name (ARN) of the SageMaker | ||
| 89 | image created on the instance. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 94 | |||
| 95 | Each tag consists of a key and an optional value. Tag keys must be | ||
| 96 | unique per resource. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> UserProfileName => Str | ||
| 101 | |||
| 102 | The user profile name. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, documenting arguments for method CreateApp in L<Paws::SageMaker> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |