« blib/lib/Paws/QLDB/DeleteLedger.pm
↑ Summary
blib/lib/Paws/QLDB/DescribeJournalKinesisStreamResponse.pm »
| 1 | |||
| 2 | package Paws::QLDB::DescribeJournalKinesisStream; | ||
| 3 | use Moose; | ||
| 4 | has LedgerName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 5 | has StreamId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'streamId', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeJournalKinesisStream'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ledgers/{name}/journal-kinesis-streams/{streamId}'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::QLDB::DescribeJournalKinesisStreamResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::QLDB::DescribeJournalKinesisStream - Arguments for method DescribeJournalKinesisStream on L<Paws::QLDB> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeJournalKinesisStream on the | ||
| 24 | L<Amazon QLDB|Paws::QLDB> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeJournalKinesisStream. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeJournalKinesisStream. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $qldb = Paws->service('QLDB'); | ||
| 32 | my $DescribeJournalKinesisStreamResponse = | ||
| 33 | $qldb->DescribeJournalKinesisStream( | ||
| 34 | LedgerName => 'MyLedgerName', | ||
| 35 | StreamId => 'MyUniqueId', | ||
| 36 | |||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $Stream = $DescribeJournalKinesisStreamResponse->Stream; | ||
| 41 | |||
| 42 | # Returns a L<Paws::QLDB::DescribeJournalKinesisStreamResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/qldb/DescribeJournalKinesisStream> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> LedgerName => Str | ||
| 51 | |||
| 52 | The name of the ledger. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> StreamId => Str | ||
| 57 | |||
| 58 | The UUID (represented in Base62-encoded text) of the QLDB journal | ||
| 59 | stream to describe. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head1 SEE ALSO | ||
| 65 | |||
| 66 | This class forms part of L<Paws>, documenting arguments for method DescribeJournalKinesisStream in L<Paws::QLDB> | ||
| 67 | |||
| 68 | =head1 BUGS and CONTRIBUTIONS | ||
| 69 | |||
| 70 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 71 | |||
| 72 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 73 | |||
| 74 | =cut | ||
| 75 |