« blib/lib/Paws/SageMaker/CreateLabelingJobResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateModelBiasJobDefinition.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateModel; | ||
| 3 | use Moose; | ||
| 4 | has Containers => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::ContainerDefinition]'); | ||
| 5 | has EnableNetworkIsolation => (is => 'ro', isa => 'Bool'); | ||
| 6 | has ExecutionRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has InferenceExecutionConfig => (is => 'ro', isa => 'Paws::SageMaker::InferenceExecutionConfig'); | ||
| 8 | has ModelName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has PrimaryContainer => (is => 'ro', isa => 'Paws::SageMaker::ContainerDefinition'); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 11 | has VpcConfig => (is => 'ro', isa => 'Paws::SageMaker::VpcConfig'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateModel'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateModelOutput'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::SageMaker::CreateModel - Arguments for method CreateModel on L<Paws::SageMaker> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateModel on the | ||
| 29 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateModel. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateModel. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 37 | my $CreateModelOutput = $api . sagemaker->CreateModel( | ||
| 38 | ExecutionRoleArn => 'MyRoleArn', | ||
| 39 | ModelName => 'MyModelName', | ||
| 40 | Containers => [ | ||
| 41 | { | ||
| 42 | ContainerHostname => 'MyContainerHostname', # max: 63; OPTIONAL | ||
| 43 | Environment => { | ||
| 44 | 'MyEnvironmentKey' => | ||
| 45 | 'MyEnvironmentValue', # key: max: 1024, value: max: 1024 | ||
| 46 | }, # max: 16; OPTIONAL | ||
| 47 | Image => 'MyContainerImage', # max: 255; OPTIONAL | ||
| 48 | ImageConfig => { | ||
| 49 | RepositoryAccessMode => 'Platform', # values: Platform, Vpc | ||
| 50 | RepositoryAuthConfig => { | ||
| 51 | RepositoryCredentialsProviderArn => | ||
| 52 | 'MyRepositoryCredentialsProviderArn', # min: 1, max: 2048 | ||
| 53 | |||
| 54 | }, # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | Mode => 'SingleModel', # values: SingleModel, MultiModel; OPTIONAL | ||
| 57 | ModelDataUrl => 'MyUrl', # max: 1024; OPTIONAL | ||
| 58 | ModelPackageName => | ||
| 59 | 'MyVersionedArnOrName', # min: 1, max: 176; OPTIONAL | ||
| 60 | MultiModelConfig => { | ||
| 61 | ModelCacheSetting => | ||
| 62 | 'Enabled', # values: Enabled, Disabled; OPTIONAL | ||
| 63 | }, # OPTIONAL | ||
| 64 | }, | ||
| 65 | ... | ||
| 66 | ], # OPTIONAL | ||
| 67 | EnableNetworkIsolation => 1, # OPTIONAL | ||
| 68 | InferenceExecutionConfig => { | ||
| 69 | Mode => 'Serial', # values: Serial, Direct | ||
| 70 | |||
| 71 | }, # OPTIONAL | ||
| 72 | PrimaryContainer => { | ||
| 73 | ContainerHostname => 'MyContainerHostname', # max: 63; OPTIONAL | ||
| 74 | Environment => { | ||
| 75 | 'MyEnvironmentKey' => | ||
| 76 | 'MyEnvironmentValue', # key: max: 1024, value: max: 1024 | ||
| 77 | }, # max: 16; OPTIONAL | ||
| 78 | Image => 'MyContainerImage', # max: 255; OPTIONAL | ||
| 79 | ImageConfig => { | ||
| 80 | RepositoryAccessMode => 'Platform', # values: Platform, Vpc | ||
| 81 | RepositoryAuthConfig => { | ||
| 82 | RepositoryCredentialsProviderArn => | ||
| 83 | 'MyRepositoryCredentialsProviderArn', # min: 1, max: 2048 | ||
| 84 | |||
| 85 | }, # OPTIONAL | ||
| 86 | }, # OPTIONAL | ||
| 87 | Mode => 'SingleModel', # values: SingleModel, MultiModel; OPTIONAL | ||
| 88 | ModelDataUrl => 'MyUrl', # max: 1024; OPTIONAL | ||
| 89 | ModelPackageName => 'MyVersionedArnOrName', # min: 1, max: 176; OPTIONAL | ||
| 90 | MultiModelConfig => { | ||
| 91 | ModelCacheSetting => 'Enabled', # values: Enabled, Disabled; OPTIONAL | ||
| 92 | }, # OPTIONAL | ||
| 93 | }, # OPTIONAL | ||
| 94 | Tags => [ | ||
| 95 | { | ||
| 96 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 97 | Value => 'MyTagValue', # max: 256 | ||
| 98 | |||
| 99 | }, | ||
| 100 | ... | ||
| 101 | ], # OPTIONAL | ||
| 102 | VpcConfig => { | ||
| 103 | SecurityGroupIds => [ | ||
| 104 | 'MySecurityGroupId', ... # max: 32 | ||
| 105 | ], # min: 1, max: 5 | ||
| 106 | Subnets => [ | ||
| 107 | 'MySubnetId', ... # max: 32 | ||
| 108 | ], # min: 1, max: 16 | ||
| 109 | |||
| 110 | }, # OPTIONAL | ||
| 111 | ); | ||
| 112 | |||
| 113 | # Results: | ||
| 114 | my $ModelArn = $CreateModelOutput->ModelArn; | ||
| 115 | |||
| 116 | # Returns a L<Paws::SageMaker::CreateModelOutput> object. | ||
| 117 | |||
| 118 | 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. | ||
| 119 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateModel> | ||
| 120 | |||
| 121 | =head1 ATTRIBUTES | ||
| 122 | |||
| 123 | |||
| 124 | =head2 Containers => ArrayRef[L<Paws::SageMaker::ContainerDefinition>] | ||
| 125 | |||
| 126 | Specifies the containers in the inference pipeline. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 EnableNetworkIsolation => Bool | ||
| 131 | |||
| 132 | Isolates the model container. No inbound or outbound network calls can | ||
| 133 | be made to or from the model container. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 B<REQUIRED> ExecutionRoleArn => Str | ||
| 138 | |||
| 139 | The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker | ||
| 140 | can assume to access model artifacts and docker image for deployment on | ||
| 141 | ML compute instances or for batch transform jobs. Deploying on ML | ||
| 142 | compute instances is part of model hosting. For more information, see | ||
| 143 | Amazon SageMaker Roles | ||
| 144 | (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). | ||
| 145 | |||
| 146 | To be able to pass this role to Amazon SageMaker, the caller of this | ||
| 147 | API must have the C<iam:PassRole> permission. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 InferenceExecutionConfig => L<Paws::SageMaker::InferenceExecutionConfig> | ||
| 152 | |||
| 153 | Specifies details of how containers in a multi-container endpoint are | ||
| 154 | called. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> ModelName => Str | ||
| 159 | |||
| 160 | The name of the new model. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 PrimaryContainer => L<Paws::SageMaker::ContainerDefinition> | ||
| 165 | |||
| 166 | The location of the primary docker image containing inference code, | ||
| 167 | associated artifacts, and custom environment map that the inference | ||
| 168 | code uses when the model is deployed for predictions. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 173 | |||
| 174 | An array of key-value pairs. You can use tags to categorize your Amazon | ||
| 175 | Web Services resources in different ways, for example, by purpose, | ||
| 176 | owner, or environment. For more information, see Tagging Amazon Web | ||
| 177 | Services Resources | ||
| 178 | (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head2 VpcConfig => L<Paws::SageMaker::VpcConfig> | ||
| 183 | |||
| 184 | A VpcConfig object that specifies the VPC that you want your model to | ||
| 185 | connect to. Control access to and from your model container by | ||
| 186 | configuring the VPC. C<VpcConfig> is used in hosting services and in | ||
| 187 | batch transform. For more information, see Protect Endpoints by Using | ||
| 188 | an Amazon Virtual Private Cloud | ||
| 189 | (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and | ||
| 190 | Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private | ||
| 191 | Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html). | ||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head1 SEE ALSO | ||
| 197 | |||
| 198 | This class forms part of L<Paws>, documenting arguments for method CreateModel in L<Paws::SageMaker> | ||
| 199 | |||
| 200 | =head1 BUGS and CONTRIBUTIONS | ||
| 201 | |||
| 202 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 203 | |||
| 204 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 205 | |||
| 206 | =cut | ||
| 207 |