| 1 | |||
| 2 | package Paws::SageMakerEdge::SendHeartbeat; | ||
| 3 | use Moose; | ||
| 4 | has AgentMetrics => (is => 'ro', isa => 'ArrayRef[Paws::SageMakerEdge::EdgeMetric]'); | ||
| 5 | has AgentVersion => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DeviceFleetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has DeviceName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Models => (is => 'ro', isa => 'ArrayRef[Paws::SageMakerEdge::Model]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendHeartbeat'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/SendHeartbeat'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::SageMakerEdge::SendHeartbeat - Arguments for method SendHeartbeat on L<Paws::SageMakerEdge> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method SendHeartbeat on the | ||
| 27 | L<Amazon Sagemaker Edge Manager|Paws::SageMakerEdge> service. Use the attributes of this class | ||
| 28 | as arguments to method SendHeartbeat. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendHeartbeat. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $edge.sagemaker = Paws->service('SageMakerEdge'); | ||
| 35 | $edge . sagemaker->SendHeartbeat( | ||
| 36 | AgentVersion => 'MyVersion', | ||
| 37 | DeviceFleetName => 'MyDeviceFleetName', | ||
| 38 | DeviceName => 'MyDeviceName', | ||
| 39 | AgentMetrics => [ | ||
| 40 | { | ||
| 41 | Dimension => 'MyDimension', # min: 1, max: 1000; OPTIONAL | ||
| 42 | MetricName => 'MyMetric', # min: 4, max: 100; OPTIONAL | ||
| 43 | Timestamp => '1970-01-01T01:00:00', # OPTIONAL | ||
| 44 | Value => 1, # OPTIONAL | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | Models => [ | ||
| 49 | { | ||
| 50 | LatestInference => '1970-01-01T01:00:00', # OPTIONAL | ||
| 51 | LatestSampleTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 52 | ModelMetrics => [ | ||
| 53 | { | ||
| 54 | Dimension => 'MyDimension', # min: 1, max: 1000; OPTIONAL | ||
| 55 | MetricName => 'MyMetric', # min: 4, max: 100; OPTIONAL | ||
| 56 | Timestamp => '1970-01-01T01:00:00', # OPTIONAL | ||
| 57 | Value => 1, # OPTIONAL | ||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], | ||
| 61 | ModelName => 'MyModelName', # min: 4, max: 255; OPTIONAL | ||
| 62 | ModelVersion => 'MyVersion', # min: 1, max: 64 | ||
| 63 | }, | ||
| 64 | ... | ||
| 65 | ], # OPTIONAL | ||
| 66 | ); | ||
| 67 | |||
| 68 | 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. | ||
| 69 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/edge.sagemaker/SendHeartbeat> | ||
| 70 | |||
| 71 | =head1 ATTRIBUTES | ||
| 72 | |||
| 73 | |||
| 74 | =head2 AgentMetrics => ArrayRef[L<Paws::SageMakerEdge::EdgeMetric>] | ||
| 75 | |||
| 76 | For internal use. Returns a list of SageMaker Edge Manager agent | ||
| 77 | operating metrics. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> AgentVersion => Str | ||
| 82 | |||
| 83 | Returns the version of the agent. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> DeviceFleetName => Str | ||
| 88 | |||
| 89 | The name of the fleet that the device belongs to. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> DeviceName => Str | ||
| 94 | |||
| 95 | The unique name of the device. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 Models => ArrayRef[L<Paws::SageMakerEdge::Model>] | ||
| 100 | |||
| 101 | Returns a list of models deployed on the the device. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, documenting arguments for method SendHeartbeat in L<Paws::SageMakerEdge> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |