« blib/lib/Paws/SageMaker/UpdateDomainResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/UpdateEndpointOutput.pm »
| 1 | |||
| 2 | package Paws::SageMaker::UpdateEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has DeploymentConfig => (is => 'ro', isa => 'Paws::SageMaker::DeploymentConfig'); | ||
| 5 | has EndpointConfigName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has EndpointName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ExcludeRetainedVariantProperties => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::VariantProperty]'); | ||
| 8 | has RetainAllVariantProperties => (is => 'ro', isa => 'Bool'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateEndpoint'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::UpdateEndpointOutput'); | ||
| 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::UpdateEndpoint - Arguments for method UpdateEndpoint on L<Paws::SageMaker> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateEndpoint on the | ||
| 26 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateEndpoint. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEndpoint. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 34 | my $UpdateEndpointOutput = $api . sagemaker->UpdateEndpoint( | ||
| 35 | EndpointConfigName => 'MyEndpointConfigName', | ||
| 36 | EndpointName => 'MyEndpointName', | ||
| 37 | DeploymentConfig => { | ||
| 38 | BlueGreenUpdatePolicy => { | ||
| 39 | TrafficRoutingConfiguration => { | ||
| 40 | Type => 'ALL_AT_ONCE', # values: ALL_AT_ONCE, CANARY | ||
| 41 | WaitIntervalInSeconds => 1, # max: 3600 | ||
| 42 | CanarySize => { | ||
| 43 | Type => | ||
| 44 | 'INSTANCE_COUNT', # values: INSTANCE_COUNT, CAPACITY_PERCENT | ||
| 45 | Value => 1, # min: 1 | ||
| 46 | |||
| 47 | }, # OPTIONAL | ||
| 48 | }, | ||
| 49 | MaximumExecutionTimeoutInSeconds => | ||
| 50 | 1, # min: 600, max: 14400; OPTIONAL | ||
| 51 | TerminationWaitInSeconds => 1, # max: 3600; OPTIONAL | ||
| 52 | }, | ||
| 53 | AutoRollbackConfiguration => { | ||
| 54 | Alarms => [ | ||
| 55 | { | ||
| 56 | AlarmName => 'MyAlarmName', # min: 1, max: 255; OPTIONAL | ||
| 57 | }, | ||
| 58 | ... | ||
| 59 | ], # min: 1, max: 10; OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | ExcludeRetainedVariantProperties => [ | ||
| 63 | { | ||
| 64 | VariantPropertyType => 'DesiredInstanceCount' | ||
| 65 | , # values: DesiredInstanceCount, DesiredWeight, DataCaptureConfig | ||
| 66 | |||
| 67 | }, | ||
| 68 | ... | ||
| 69 | ], # OPTIONAL | ||
| 70 | RetainAllVariantProperties => 1, # OPTIONAL | ||
| 71 | ); | ||
| 72 | |||
| 73 | # Results: | ||
| 74 | my $EndpointArn = $UpdateEndpointOutput->EndpointArn; | ||
| 75 | |||
| 76 | # Returns a L<Paws::SageMaker::UpdateEndpointOutput> object. | ||
| 77 | |||
| 78 | 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. | ||
| 79 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/UpdateEndpoint> | ||
| 80 | |||
| 81 | =head1 ATTRIBUTES | ||
| 82 | |||
| 83 | |||
| 84 | =head2 DeploymentConfig => L<Paws::SageMaker::DeploymentConfig> | ||
| 85 | |||
| 86 | The deployment configuration for the endpoint to be updated. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> EndpointConfigName => Str | ||
| 91 | |||
| 92 | The name of the new endpoint configuration. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> EndpointName => Str | ||
| 97 | |||
| 98 | The name of the endpoint whose configuration you want to update. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 ExcludeRetainedVariantProperties => ArrayRef[L<Paws::SageMaker::VariantProperty>] | ||
| 103 | |||
| 104 | When you are updating endpoint resources with | ||
| 105 | UpdateEndpointInput$RetainAllVariantProperties, whose value is set to | ||
| 106 | C<true>, C<ExcludeRetainedVariantProperties> specifies the list of type | ||
| 107 | VariantProperty to override with the values provided by | ||
| 108 | C<EndpointConfig>. If you don't specify a value for | ||
| 109 | C<ExcludeAllVariantProperties>, no variant properties are overridden. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 RetainAllVariantProperties => Bool | ||
| 114 | |||
| 115 | When updating endpoint resources, enables or disables the retention of | ||
| 116 | variant properties | ||
| 117 | (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html), | ||
| 118 | such as the instance count or the variant weight. To retain the variant | ||
| 119 | properties of an endpoint when updating it, set | ||
| 120 | C<RetainAllVariantProperties> to C<true>. To use the variant properties | ||
| 121 | specified in a new C<EndpointConfig> call when updating an endpoint, | ||
| 122 | set C<RetainAllVariantProperties> to C<false>. The default is C<false>. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head1 SEE ALSO | ||
| 128 | |||
| 129 | This class forms part of L<Paws>, documenting arguments for method UpdateEndpoint in L<Paws::SageMaker> | ||
| 130 | |||
| 131 | =head1 BUGS and CONTRIBUTIONS | ||
| 132 | |||
| 133 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 134 | |||
| 135 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 136 | |||
| 137 | =cut | ||
| 138 |