« blib/lib/Paws/CloudWatchEvents/DescribeApiDestinationResponse.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/DescribeArchiveResponse.pm »
| 1 | |||
| 2 | package Paws::CloudWatchEvents::DescribeArchive; | ||
| 3 | use Moose; | ||
| 4 | has ArchiveName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | |||
| 8 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeArchive'); | ||
| 9 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchEvents::DescribeArchiveResponse'); | ||
| 10 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CloudWatchEvents::DescribeArchive - Arguments for method DescribeArchive on L<Paws::CloudWatchEvents> | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | This class represents the parameters used for calling the method DescribeArchive on the | ||
| 22 | L<Amazon EventBridge|Paws::CloudWatchEvents> service. Use the attributes of this class | ||
| 23 | as arguments to method DescribeArchive. | ||
| 24 | |||
| 25 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeArchive. | ||
| 26 | |||
| 27 | =head1 SYNOPSIS | ||
| 28 | |||
| 29 | my $events = Paws->service('CloudWatchEvents'); | ||
| 30 | my $DescribeArchiveResponse = $events->DescribeArchive( | ||
| 31 | ArchiveName => 'MyArchiveName', | ||
| 32 | |||
| 33 | ); | ||
| 34 | |||
| 35 | # Results: | ||
| 36 | my $ArchiveArn = $DescribeArchiveResponse->ArchiveArn; | ||
| 37 | my $ArchiveName = $DescribeArchiveResponse->ArchiveName; | ||
| 38 | my $CreationTime = $DescribeArchiveResponse->CreationTime; | ||
| 39 | my $Description = $DescribeArchiveResponse->Description; | ||
| 40 | my $EventCount = $DescribeArchiveResponse->EventCount; | ||
| 41 | my $EventPattern = $DescribeArchiveResponse->EventPattern; | ||
| 42 | my $EventSourceArn = $DescribeArchiveResponse->EventSourceArn; | ||
| 43 | my $RetentionDays = $DescribeArchiveResponse->RetentionDays; | ||
| 44 | my $SizeBytes = $DescribeArchiveResponse->SizeBytes; | ||
| 45 | my $State = $DescribeArchiveResponse->State; | ||
| 46 | my $StateReason = $DescribeArchiveResponse->StateReason; | ||
| 47 | |||
| 48 | # Returns a L<Paws::CloudWatchEvents::DescribeArchiveResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/events/DescribeArchive> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> ArchiveName => Str | ||
| 57 | |||
| 58 | The name of the archive to retrieve. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, documenting arguments for method DescribeArchive in L<Paws::CloudWatchEvents> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |