« blib/lib/Paws/SageMaker/CreateEndpoint.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateEndpointConfigOutput.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateEndpointConfig; | ||
| 3 | use Moose; | ||
| 4 | has DataCaptureConfig => (is => 'ro', isa => 'Paws::SageMaker::DataCaptureConfig'); | ||
| 5 | has EndpointConfigName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | has ProductionVariants => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::ProductionVariant]', required => 1); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEndpointConfig'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateEndpointConfigOutput'); | ||
| 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::CreateEndpointConfig - Arguments for method CreateEndpointConfig on L<Paws::SageMaker> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateEndpointConfig on the | ||
| 26 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateEndpointConfig. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEndpointConfig. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 34 | my $CreateEndpointConfigOutput = $api . sagemaker->CreateEndpointConfig( | ||
| 35 | EndpointConfigName => 'MyEndpointConfigName', | ||
| 36 | ProductionVariants => [ | ||
| 37 | { | ||
| 38 | InitialInstanceCount => 1, # min: 1 | ||
| 39 | InstanceType => 'ml.t2.medium' | ||
| 40 | , # values: ml.t2.medium, ml.t2.large, ml.t2.xlarge, ml.t2.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.12xlarge, ml.m5d.24xlarge, ml.c4.large, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5d.large, ml.c5d.xlarge, ml.c5d.2xlarge, ml.c5d.4xlarge, ml.c5d.9xlarge, ml.c5d.18xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.12xlarge, ml.r5.24xlarge, ml.r5d.large, ml.r5d.xlarge, ml.r5d.2xlarge, ml.r5d.4xlarge, ml.r5d.12xlarge, ml.r5d.24xlarge, ml.inf1.xlarge, ml.inf1.2xlarge, ml.inf1.6xlarge, ml.inf1.24xlarge | ||
| 41 | ModelName => 'MyModelName', # max: 63 | ||
| 42 | VariantName => 'MyVariantName', # max: 63 | ||
| 43 | AcceleratorType => 'ml.eia1.medium' | ||
| 44 | , # values: ml.eia1.medium, ml.eia1.large, ml.eia1.xlarge, ml.eia2.medium, ml.eia2.large, ml.eia2.xlarge; OPTIONAL | ||
| 45 | CoreDumpConfig => { | ||
| 46 | DestinationS3Uri => 'MyDestinationS3Uri', # max: 512 | ||
| 47 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | InitialVariantWeight => 1.0, # OPTIONAL | ||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], | ||
| 53 | DataCaptureConfig => { | ||
| 54 | CaptureOptions => [ | ||
| 55 | { | ||
| 56 | CaptureMode => 'Input', # values: Input, Output | ||
| 57 | |||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # min: 1, max: 2 | ||
| 61 | DestinationS3Uri => 'MyDestinationS3Uri', # max: 512 | ||
| 62 | InitialSamplingPercentage => 1, # max: 100 | ||
| 63 | CaptureContentTypeHeader => { | ||
| 64 | CsvContentTypes => [ | ||
| 65 | 'MyCsvContentType', ... # min: 1, max: 256 | ||
| 66 | ], # min: 1, max: 10; OPTIONAL | ||
| 67 | JsonContentTypes => [ | ||
| 68 | 'MyJsonContentType', ... # min: 1, max: 256 | ||
| 69 | ], # min: 1, max: 10; OPTIONAL | ||
| 70 | }, # OPTIONAL | ||
| 71 | EnableCapture => 1, # OPTIONAL | ||
| 72 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 73 | }, # OPTIONAL | ||
| 74 | KmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 75 | Tags => [ | ||
| 76 | { | ||
| 77 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 78 | Value => 'MyTagValue', # max: 256 | ||
| 79 | |||
| 80 | }, | ||
| 81 | ... | ||
| 82 | ], # OPTIONAL | ||
| 83 | ); | ||
| 84 | |||
| 85 | # Results: | ||
| 86 | my $EndpointConfigArn = $CreateEndpointConfigOutput->EndpointConfigArn; | ||
| 87 | |||
| 88 | # Returns a L<Paws::SageMaker::CreateEndpointConfigOutput> object. | ||
| 89 | |||
| 90 | 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. | ||
| 91 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateEndpointConfig> | ||
| 92 | |||
| 93 | =head1 ATTRIBUTES | ||
| 94 | |||
| 95 | |||
| 96 | =head2 DataCaptureConfig => L<Paws::SageMaker::DataCaptureConfig> | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> EndpointConfigName => Str | ||
| 103 | |||
| 104 | The name of the endpoint configuration. You specify this name in a | ||
| 105 | CreateEndpoint request. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 KmsKeyId => Str | ||
| 110 | |||
| 111 | The Amazon Resource Name (ARN) of a Amazon Web Services Key Management | ||
| 112 | Service key that Amazon SageMaker uses to encrypt data on the storage | ||
| 113 | volume attached to the ML compute instance that hosts the endpoint. | ||
| 114 | |||
| 115 | The KmsKeyId can be any of the following formats: | ||
| 116 | |||
| 117 | =over | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | Key ARN: | ||
| 126 | C<arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | Alias name: C<alias/ExampleAlias> | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Alias name ARN: | ||
| 135 | C<arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias> | ||
| 136 | |||
| 137 | =back | ||
| 138 | |||
| 139 | The KMS key policy must grant permission to the IAM role that you | ||
| 140 | specify in your C<CreateEndpoint>, C<UpdateEndpoint> requests. For more | ||
| 141 | information, refer to the Amazon Web Services Key Management Service | ||
| 142 | section Using Key Policies in Amazon Web Services KMS | ||
| 143 | (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) | ||
| 144 | |||
| 145 | Certain Nitro-based instances include local storage, dependent on the | ||
| 146 | instance type. Local storage volumes are encrypted using a hardware | ||
| 147 | module on the instance. You can't request a C<KmsKeyId> when using an | ||
| 148 | instance type with local storage. If any of the models that you specify | ||
| 149 | in the C<ProductionVariants> parameter use nitro-based instances with | ||
| 150 | local storage, do not specify a value for the C<KmsKeyId> parameter. If | ||
| 151 | you specify a value for C<KmsKeyId> when using any nitro-based | ||
| 152 | instances with local storage, the call to C<CreateEndpointConfig> | ||
| 153 | fails. | ||
| 154 | |||
| 155 | For a list of instance types that support local instance storage, see | ||
| 156 | Instance Store Volumes | ||
| 157 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). | ||
| 158 | |||
| 159 | For more information about local instance storage encryption, see SSD | ||
| 160 | Instance Store Volumes | ||
| 161 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 B<REQUIRED> ProductionVariants => ArrayRef[L<Paws::SageMaker::ProductionVariant>] | ||
| 166 | |||
| 167 | An list of C<ProductionVariant> objects, one for each model that you | ||
| 168 | want to host at this endpoint. | ||
| 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 | |||
| 183 | =head1 SEE ALSO | ||
| 184 | |||
| 185 | This class forms part of L<Paws>, documenting arguments for method CreateEndpointConfig in L<Paws::SageMaker> | ||
| 186 | |||
| 187 | =head1 BUGS and CONTRIBUTIONS | ||
| 188 | |||
| 189 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 190 | |||
| 191 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 192 | |||
| 193 | =cut | ||
| 194 |