| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::EndpointSummary; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has EndpointArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has EndpointName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has EndpointStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has LastModifiedTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::SageMaker::EndpointSummary | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::SageMaker::EndpointSummary object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CreationTime => $value, ..., LastModifiedTime => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::EndpointSummary object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CreationTime | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Provides summary information for an endpoint. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> CreationTime => Str | ||
| 46 | |||
| 47 | A timestamp that shows when the endpoint was created. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> EndpointArn => Str | ||
| 51 | |||
| 52 | The Amazon Resource Name (ARN) of the endpoint. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> EndpointName => Str | ||
| 56 | |||
| 57 | The name of the endpoint. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> EndpointStatus => Str | ||
| 61 | |||
| 62 | The status of the endpoint. | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<OutOfService>: Endpoint is not available to take incoming requests. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<Creating>: CreateEndpoint is executing. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<Updating>: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is | ||
| 77 | executing. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<SystemUpdating>: Endpoint is undergoing maintenance and cannot be | ||
| 82 | updated or deleted or re-scaled until it has completed. This | ||
| 83 | maintenance operation does not change any customer-specified values | ||
| 84 | such as VPC config, KMS encryption, model, instance type, or instance | ||
| 85 | count. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<RollingBack>: Endpoint fails to scale up or down or change its | ||
| 90 | variant weight and is in the process of rolling back to its previous | ||
| 91 | configuration. Once the rollback completes, endpoint returns to an | ||
| 92 | C<InService> status. This transitional status only applies to an | ||
| 93 | endpoint that has autoscaling enabled and is undergoing variant weight | ||
| 94 | or capacity changes as part of an UpdateEndpointWeightsAndCapacities | ||
| 95 | call or when the UpdateEndpointWeightsAndCapacities operation is called | ||
| 96 | explicitly. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<InService>: Endpoint is available to process incoming requests. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<Deleting>: DeleteEndpoint is executing. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<Failed>: Endpoint could not be created, updated, or re-scaled. Use | ||
| 109 | DescribeEndpointOutput$FailureReason for information about the failure. | ||
| 110 | DeleteEndpoint is the only operation that can be performed on a failed | ||
| 111 | endpoint. | ||
| 112 | |||
| 113 | =back | ||
| 114 | |||
| 115 | To get a list of endpoints with a specified status, use the | ||
| 116 | ListEndpointsInput$StatusEquals filter. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 B<REQUIRED> LastModifiedTime => Str | ||
| 120 | |||
| 121 | A timestamp that shows when the endpoint was last modified. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |