« blib/lib/Paws/Support/TrustedAdvisorResourceDetail.pm
↑ Summary
blib/lib/Paws/Synthetics/Canary.pm »
| 1 | package Paws::Synthetics; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'synthetics' } | ||
| 4 | sub signing_name { 'synthetics' } | ||
| 5 | sub version { '2017-10-11' } | ||
| 6 | sub flattened_arrays { 0 } | ||
| 7 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 8 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 9 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 10 | }); | ||
| 11 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 12 | ] }); | ||
| 13 | |||
| 14 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller'; | ||
| 15 | |||
| 16 | |||
| 17 | sub CreateCanary { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::Synthetics::CreateCanary', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub DeleteCanary { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::Synthetics::DeleteCanary', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | sub DescribeCanaries { | ||
| 28 | my $self = shift; | ||
| 29 | my $call_object = $self->new_with_coercions('Paws::Synthetics::DescribeCanaries', @_); | ||
| 30 | return $self->caller->do_call($self, $call_object); | ||
| 31 | } | ||
| 32 | sub DescribeCanariesLastRun { | ||
| 33 | my $self = shift; | ||
| 34 | my $call_object = $self->new_with_coercions('Paws::Synthetics::DescribeCanariesLastRun', @_); | ||
| 35 | return $self->caller->do_call($self, $call_object); | ||
| 36 | } | ||
| 37 | sub DescribeRuntimeVersions { | ||
| 38 | my $self = shift; | ||
| 39 | my $call_object = $self->new_with_coercions('Paws::Synthetics::DescribeRuntimeVersions', @_); | ||
| 40 | return $self->caller->do_call($self, $call_object); | ||
| 41 | } | ||
| 42 | sub GetCanary { | ||
| 43 | my $self = shift; | ||
| 44 | my $call_object = $self->new_with_coercions('Paws::Synthetics::GetCanary', @_); | ||
| 45 | return $self->caller->do_call($self, $call_object); | ||
| 46 | } | ||
| 47 | sub GetCanaryRuns { | ||
| 48 | my $self = shift; | ||
| 49 | my $call_object = $self->new_with_coercions('Paws::Synthetics::GetCanaryRuns', @_); | ||
| 50 | return $self->caller->do_call($self, $call_object); | ||
| 51 | } | ||
| 52 | sub ListTagsForResource { | ||
| 53 | my $self = shift; | ||
| 54 | my $call_object = $self->new_with_coercions('Paws::Synthetics::ListTagsForResource', @_); | ||
| 55 | return $self->caller->do_call($self, $call_object); | ||
| 56 | } | ||
| 57 | sub StartCanary { | ||
| 58 | my $self = shift; | ||
| 59 | my $call_object = $self->new_with_coercions('Paws::Synthetics::StartCanary', @_); | ||
| 60 | return $self->caller->do_call($self, $call_object); | ||
| 61 | } | ||
| 62 | sub StopCanary { | ||
| 63 | my $self = shift; | ||
| 64 | my $call_object = $self->new_with_coercions('Paws::Synthetics::StopCanary', @_); | ||
| 65 | return $self->caller->do_call($self, $call_object); | ||
| 66 | } | ||
| 67 | sub TagResource { | ||
| 68 | my $self = shift; | ||
| 69 | my $call_object = $self->new_with_coercions('Paws::Synthetics::TagResource', @_); | ||
| 70 | return $self->caller->do_call($self, $call_object); | ||
| 71 | } | ||
| 72 | sub UntagResource { | ||
| 73 | my $self = shift; | ||
| 74 | my $call_object = $self->new_with_coercions('Paws::Synthetics::UntagResource', @_); | ||
| 75 | return $self->caller->do_call($self, $call_object); | ||
| 76 | } | ||
| 77 | sub UpdateCanary { | ||
| 78 | my $self = shift; | ||
| 79 | my $call_object = $self->new_with_coercions('Paws::Synthetics::UpdateCanary', @_); | ||
| 80 | return $self->caller->do_call($self, $call_object); | ||
| 81 | } | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | sub operations { qw/CreateCanary DeleteCanary DescribeCanaries DescribeCanariesLastRun DescribeRuntimeVersions GetCanary GetCanaryRuns ListTagsForResource StartCanary StopCanary TagResource UntagResource UpdateCanary / } | ||
| 86 | |||
| 87 | 1; | ||
| 88 | |||
| 89 | ### main pod documentation begin ### | ||
| 90 | |||
| 91 | =head1 NAME | ||
| 92 | |||
| 93 | Paws::Synthetics - Perl Interface to AWS Synthetics | ||
| 94 | |||
| 95 | =head1 SYNOPSIS | ||
| 96 | |||
| 97 | use Paws; | ||
| 98 | |||
| 99 | my $obj = Paws->service('Synthetics'); | ||
| 100 | my $res = $obj->Method( | ||
| 101 | Arg1 => $val1, | ||
| 102 | Arg2 => [ 'V1', 'V2' ], | ||
| 103 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 104 | # of the arguments type | ||
| 105 | Arg3 => { Att1 => 'Val1' }, | ||
| 106 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 107 | # the constructor of the arguments type | ||
| 108 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 109 | ); | ||
| 110 | |||
| 111 | =head1 DESCRIPTION | ||
| 112 | |||
| 113 | Amazon CloudWatch Synthetics | ||
| 114 | |||
| 115 | You can use Amazon CloudWatch Synthetics to continually monitor your | ||
| 116 | services. You can create and manage I<canaries>, which are modular, | ||
| 117 | lightweight scripts that monitor your endpoints and APIs from the | ||
| 118 | outside-in. You can set up your canaries to run 24 hours a day, once | ||
| 119 | per minute. The canaries help you check the availability and latency of | ||
| 120 | your web services and troubleshoot anomalies by investigating load time | ||
| 121 | data, screenshots of the UI, logs, and metrics. The canaries seamlessly | ||
| 122 | integrate with CloudWatch ServiceLens to help you trace the causes of | ||
| 123 | impacted nodes in your applications. For more information, see Using | ||
| 124 | ServiceLens to Monitor the Health of Your Applications | ||
| 125 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ServiceLens.html) | ||
| 126 | in the I<Amazon CloudWatch User Guide>. | ||
| 127 | |||
| 128 | Before you create and manage canaries, be aware of the security | ||
| 129 | considerations. For more information, see Security Considerations for | ||
| 130 | Synthetics Canaries | ||
| 131 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html). | ||
| 132 | |||
| 133 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11> | ||
| 134 | |||
| 135 | |||
| 136 | =head1 METHODS | ||
| 137 | |||
| 138 | =head2 CreateCanary | ||
| 139 | |||
| 140 | =over | ||
| 141 | |||
| 142 | =item ArtifactS3Location => Str | ||
| 143 | |||
| 144 | =item Code => L<Paws::Synthetics::CanaryCodeInput> | ||
| 145 | |||
| 146 | =item ExecutionRoleArn => Str | ||
| 147 | |||
| 148 | =item Name => Str | ||
| 149 | |||
| 150 | =item RuntimeVersion => Str | ||
| 151 | |||
| 152 | =item Schedule => L<Paws::Synthetics::CanaryScheduleInput> | ||
| 153 | |||
| 154 | =item [FailureRetentionPeriodInDays => Int] | ||
| 155 | |||
| 156 | =item [RunConfig => L<Paws::Synthetics::CanaryRunConfigInput>] | ||
| 157 | |||
| 158 | =item [SuccessRetentionPeriodInDays => Int] | ||
| 159 | |||
| 160 | =item [Tags => L<Paws::Synthetics::TagMap>] | ||
| 161 | |||
| 162 | =item [VpcConfig => L<Paws::Synthetics::VpcConfigInput>] | ||
| 163 | |||
| 164 | |||
| 165 | =back | ||
| 166 | |||
| 167 | Each argument is described in detail in: L<Paws::Synthetics::CreateCanary> | ||
| 168 | |||
| 169 | Returns: a L<Paws::Synthetics::CreateCanaryResponse> instance | ||
| 170 | |||
| 171 | Creates a canary. Canaries are scripts that monitor your endpoints and | ||
| 172 | APIs from the outside-in. Canaries help you check the availability and | ||
| 173 | latency of your web services and troubleshoot anomalies by | ||
| 174 | investigating load time data, screenshots of the UI, logs, and metrics. | ||
| 175 | You can set up a canary to run continuously or just once. | ||
| 176 | |||
| 177 | Do not use C<CreateCanary> to modify an existing canary. Use | ||
| 178 | UpdateCanary | ||
| 179 | (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html) | ||
| 180 | instead. | ||
| 181 | |||
| 182 | To create canaries, you must have the C<CloudWatchSyntheticsFullAccess> | ||
| 183 | policy. If you are creating a new IAM role for the canary, you also | ||
| 184 | need the the C<iam:CreateRole>, C<iam:CreatePolicy> and | ||
| 185 | C<iam:AttachRolePolicy> permissions. For more information, see | ||
| 186 | Necessary Roles and Permissions | ||
| 187 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles). | ||
| 188 | |||
| 189 | Do not include secrets or proprietary information in your canary names. | ||
| 190 | The canary name makes up part of the Amazon Resource Name (ARN) for the | ||
| 191 | canary, and the ARN is included in outbound calls over the internet. | ||
| 192 | For more information, see Security Considerations for Synthetics | ||
| 193 | Canaries | ||
| 194 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html). | ||
| 195 | |||
| 196 | |||
| 197 | =head2 DeleteCanary | ||
| 198 | |||
| 199 | =over | ||
| 200 | |||
| 201 | =item Name => Str | ||
| 202 | |||
| 203 | |||
| 204 | =back | ||
| 205 | |||
| 206 | Each argument is described in detail in: L<Paws::Synthetics::DeleteCanary> | ||
| 207 | |||
| 208 | Returns: a L<Paws::Synthetics::DeleteCanaryResponse> instance | ||
| 209 | |||
| 210 | Permanently deletes the specified canary. | ||
| 211 | |||
| 212 | When you delete a canary, resources used and created by the canary are | ||
| 213 | not automatically deleted. After you delete a canary that you do not | ||
| 214 | intend to use again, you should also delete the following: | ||
| 215 | |||
| 216 | =over | ||
| 217 | |||
| 218 | =item * | ||
| 219 | |||
| 220 | The Lambda functions and layers used by this canary. These have the | ||
| 221 | prefix C<cwsyn-I<MyCanaryName> >. | ||
| 222 | |||
| 223 | =item * | ||
| 224 | |||
| 225 | The CloudWatch alarms created for this canary. These alarms have a name | ||
| 226 | of C<Synthetics-SharpDrop-Alarm-I<MyCanaryName> >. | ||
| 227 | |||
| 228 | =item * | ||
| 229 | |||
| 230 | Amazon S3 objects and buckets, such as the canary's artifact location. | ||
| 231 | |||
| 232 | =item * | ||
| 233 | |||
| 234 | IAM roles created for the canary. If they were created in the console, | ||
| 235 | these roles have the name C< | ||
| 236 | role/service-role/CloudWatchSyntheticsRole-I<MyCanaryName> >. | ||
| 237 | |||
| 238 | =item * | ||
| 239 | |||
| 240 | CloudWatch Logs log groups created for the canary. These logs groups | ||
| 241 | have the name C</aws/lambda/cwsyn-I<MyCanaryName> >. | ||
| 242 | |||
| 243 | =back | ||
| 244 | |||
| 245 | Before you delete a canary, you might want to use C<GetCanary> to | ||
| 246 | display the information about this canary. Make note of the information | ||
| 247 | returned by this operation so that you can delete these resources after | ||
| 248 | you delete the canary. | ||
| 249 | |||
| 250 | |||
| 251 | =head2 DescribeCanaries | ||
| 252 | |||
| 253 | =over | ||
| 254 | |||
| 255 | =item [MaxResults => Int] | ||
| 256 | |||
| 257 | =item [NextToken => Str] | ||
| 258 | |||
| 259 | |||
| 260 | =back | ||
| 261 | |||
| 262 | Each argument is described in detail in: L<Paws::Synthetics::DescribeCanaries> | ||
| 263 | |||
| 264 | Returns: a L<Paws::Synthetics::DescribeCanariesResponse> instance | ||
| 265 | |||
| 266 | This operation returns a list of the canaries in your account, along | ||
| 267 | with full details about each canary. | ||
| 268 | |||
| 269 | This operation does not have resource-level authorization, so if a user | ||
| 270 | is able to use C<DescribeCanaries>, the user can see all of the | ||
| 271 | canaries in the account. A deny policy can only be used to restrict | ||
| 272 | access to all canaries. It cannot be used on specific resources. | ||
| 273 | |||
| 274 | |||
| 275 | =head2 DescribeCanariesLastRun | ||
| 276 | |||
| 277 | =over | ||
| 278 | |||
| 279 | =item [MaxResults => Int] | ||
| 280 | |||
| 281 | =item [NextToken => Str] | ||
| 282 | |||
| 283 | |||
| 284 | =back | ||
| 285 | |||
| 286 | Each argument is described in detail in: L<Paws::Synthetics::DescribeCanariesLastRun> | ||
| 287 | |||
| 288 | Returns: a L<Paws::Synthetics::DescribeCanariesLastRunResponse> instance | ||
| 289 | |||
| 290 | Use this operation to see information from the most recent run of each | ||
| 291 | canary that you have created. | ||
| 292 | |||
| 293 | |||
| 294 | =head2 DescribeRuntimeVersions | ||
| 295 | |||
| 296 | =over | ||
| 297 | |||
| 298 | =item [MaxResults => Int] | ||
| 299 | |||
| 300 | =item [NextToken => Str] | ||
| 301 | |||
| 302 | |||
| 303 | =back | ||
| 304 | |||
| 305 | Each argument is described in detail in: L<Paws::Synthetics::DescribeRuntimeVersions> | ||
| 306 | |||
| 307 | Returns: a L<Paws::Synthetics::DescribeRuntimeVersionsResponse> instance | ||
| 308 | |||
| 309 | Returns a list of Synthetics canary runtime versions. For more | ||
| 310 | information, see Canary Runtime Versions | ||
| 311 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). | ||
| 312 | |||
| 313 | |||
| 314 | =head2 GetCanary | ||
| 315 | |||
| 316 | =over | ||
| 317 | |||
| 318 | =item Name => Str | ||
| 319 | |||
| 320 | |||
| 321 | =back | ||
| 322 | |||
| 323 | Each argument is described in detail in: L<Paws::Synthetics::GetCanary> | ||
| 324 | |||
| 325 | Returns: a L<Paws::Synthetics::GetCanaryResponse> instance | ||
| 326 | |||
| 327 | Retrieves complete information about one canary. You must specify the | ||
| 328 | name of the canary that you want. To get a list of canaries and their | ||
| 329 | names, use DescribeCanaries | ||
| 330 | (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html). | ||
| 331 | |||
| 332 | |||
| 333 | =head2 GetCanaryRuns | ||
| 334 | |||
| 335 | =over | ||
| 336 | |||
| 337 | =item Name => Str | ||
| 338 | |||
| 339 | =item [MaxResults => Int] | ||
| 340 | |||
| 341 | =item [NextToken => Str] | ||
| 342 | |||
| 343 | |||
| 344 | =back | ||
| 345 | |||
| 346 | Each argument is described in detail in: L<Paws::Synthetics::GetCanaryRuns> | ||
| 347 | |||
| 348 | Returns: a L<Paws::Synthetics::GetCanaryRunsResponse> instance | ||
| 349 | |||
| 350 | Retrieves a list of runs for a specified canary. | ||
| 351 | |||
| 352 | |||
| 353 | =head2 ListTagsForResource | ||
| 354 | |||
| 355 | =over | ||
| 356 | |||
| 357 | =item ResourceArn => Str | ||
| 358 | |||
| 359 | |||
| 360 | =back | ||
| 361 | |||
| 362 | Each argument is described in detail in: L<Paws::Synthetics::ListTagsForResource> | ||
| 363 | |||
| 364 | Returns: a L<Paws::Synthetics::ListTagsForResourceResponse> instance | ||
| 365 | |||
| 366 | Displays the tags associated with a canary. | ||
| 367 | |||
| 368 | |||
| 369 | =head2 StartCanary | ||
| 370 | |||
| 371 | =over | ||
| 372 | |||
| 373 | =item Name => Str | ||
| 374 | |||
| 375 | |||
| 376 | =back | ||
| 377 | |||
| 378 | Each argument is described in detail in: L<Paws::Synthetics::StartCanary> | ||
| 379 | |||
| 380 | Returns: a L<Paws::Synthetics::StartCanaryResponse> instance | ||
| 381 | |||
| 382 | Use this operation to run a canary that has already been created. The | ||
| 383 | frequency of the canary runs is determined by the value of the canary's | ||
| 384 | C<Schedule>. To see a canary's schedule, use GetCanary | ||
| 385 | (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanary.html). | ||
| 386 | |||
| 387 | |||
| 388 | =head2 StopCanary | ||
| 389 | |||
| 390 | =over | ||
| 391 | |||
| 392 | =item Name => Str | ||
| 393 | |||
| 394 | |||
| 395 | =back | ||
| 396 | |||
| 397 | Each argument is described in detail in: L<Paws::Synthetics::StopCanary> | ||
| 398 | |||
| 399 | Returns: a L<Paws::Synthetics::StopCanaryResponse> instance | ||
| 400 | |||
| 401 | Stops the canary to prevent all future runs. If the canary is currently | ||
| 402 | running, Synthetics stops waiting for the current run of the specified | ||
| 403 | canary to complete. The run that is in progress completes on its own, | ||
| 404 | publishes metrics, and uploads artifacts, but it is not recorded in | ||
| 405 | Synthetics as a completed run. | ||
| 406 | |||
| 407 | You can use C<StartCanary> to start it running again with the | ||
| 408 | canaryE<rsquo>s current schedule at any point in the future. | ||
| 409 | |||
| 410 | |||
| 411 | =head2 TagResource | ||
| 412 | |||
| 413 | =over | ||
| 414 | |||
| 415 | =item ResourceArn => Str | ||
| 416 | |||
| 417 | =item Tags => L<Paws::Synthetics::TagMap> | ||
| 418 | |||
| 419 | |||
| 420 | =back | ||
| 421 | |||
| 422 | Each argument is described in detail in: L<Paws::Synthetics::TagResource> | ||
| 423 | |||
| 424 | Returns: a L<Paws::Synthetics::TagResourceResponse> instance | ||
| 425 | |||
| 426 | Assigns one or more tags (key-value pairs) to the specified canary. | ||
| 427 | |||
| 428 | Tags can help you organize and categorize your resources. You can also | ||
| 429 | use them to scope user permissions, by granting a user permission to | ||
| 430 | access or change only resources with certain tag values. | ||
| 431 | |||
| 432 | Tags don't have any semantic meaning to AWS and are interpreted | ||
| 433 | strictly as strings of characters. | ||
| 434 | |||
| 435 | You can use the C<TagResource> action with a canary that already has | ||
| 436 | tags. If you specify a new tag key for the alarm, this tag is appended | ||
| 437 | to the list of tags associated with the alarm. If you specify a tag key | ||
| 438 | that is already associated with the alarm, the new tag value that you | ||
| 439 | specify replaces the previous value for that tag. | ||
| 440 | |||
| 441 | You can associate as many as 50 tags with a canary. | ||
| 442 | |||
| 443 | |||
| 444 | =head2 UntagResource | ||
| 445 | |||
| 446 | =over | ||
| 447 | |||
| 448 | =item ResourceArn => Str | ||
| 449 | |||
| 450 | =item TagKeys => ArrayRef[Str|Undef] | ||
| 451 | |||
| 452 | |||
| 453 | =back | ||
| 454 | |||
| 455 | Each argument is described in detail in: L<Paws::Synthetics::UntagResource> | ||
| 456 | |||
| 457 | Returns: a L<Paws::Synthetics::UntagResourceResponse> instance | ||
| 458 | |||
| 459 | Removes one or more tags from the specified canary. | ||
| 460 | |||
| 461 | |||
| 462 | =head2 UpdateCanary | ||
| 463 | |||
| 464 | =over | ||
| 465 | |||
| 466 | =item Name => Str | ||
| 467 | |||
| 468 | =item [Code => L<Paws::Synthetics::CanaryCodeInput>] | ||
| 469 | |||
| 470 | =item [ExecutionRoleArn => Str] | ||
| 471 | |||
| 472 | =item [FailureRetentionPeriodInDays => Int] | ||
| 473 | |||
| 474 | =item [RunConfig => L<Paws::Synthetics::CanaryRunConfigInput>] | ||
| 475 | |||
| 476 | =item [RuntimeVersion => Str] | ||
| 477 | |||
| 478 | =item [Schedule => L<Paws::Synthetics::CanaryScheduleInput>] | ||
| 479 | |||
| 480 | =item [SuccessRetentionPeriodInDays => Int] | ||
| 481 | |||
| 482 | =item [VpcConfig => L<Paws::Synthetics::VpcConfigInput>] | ||
| 483 | |||
| 484 | |||
| 485 | =back | ||
| 486 | |||
| 487 | Each argument is described in detail in: L<Paws::Synthetics::UpdateCanary> | ||
| 488 | |||
| 489 | Returns: a L<Paws::Synthetics::UpdateCanaryResponse> instance | ||
| 490 | |||
| 491 | Use this operation to change the settings of a canary that has already | ||
| 492 | been created. | ||
| 493 | |||
| 494 | You can't use this operation to update the tags of an existing canary. | ||
| 495 | To change the tags of an existing canary, use TagResource | ||
| 496 | (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html). | ||
| 497 | |||
| 498 | |||
| 499 | |||
| 500 | |||
| 501 | =head1 PAGINATORS | ||
| 502 | |||
| 503 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 504 | |||
| 505 | |||
| 506 | |||
| 507 | |||
| 508 | =head1 SEE ALSO | ||
| 509 | |||
| 510 | This service class forms part of L<Paws> | ||
| 511 | |||
| 512 | =head1 BUGS and CONTRIBUTIONS | ||
| 513 | |||
| 514 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 515 | |||
| 516 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 517 | |||
| 518 | =cut | ||
| 519 |