« blib/lib/Paws/KinesisVideo/DeleteSignalingChannelOutput.pm
↑ Summary
blib/lib/Paws/KinesisVideo/DeleteStreamOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideo::DeleteStream; | ||
| 3 | use Moose; | ||
| 4 | has CurrentVersion => (is => 'ro', isa => 'Str'); | ||
| 5 | has StreamARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteStream'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/deleteStream'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideo::DeleteStreamOutput'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::KinesisVideo::DeleteStream - Arguments for method DeleteStream on L<Paws::KinesisVideo> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DeleteStream on the | ||
| 24 | L<Amazon Kinesis Video Streams|Paws::KinesisVideo> service. Use the attributes of this class | ||
| 25 | as arguments to method DeleteStream. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteStream. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kinesisvideo = Paws->service('KinesisVideo'); | ||
| 32 | my $DeleteStreamOutput = $kinesisvideo->DeleteStream( | ||
| 33 | StreamARN => 'MyResourceARN', | ||
| 34 | CurrentVersion => 'MyVersion', # OPTIONAL | ||
| 35 | ); | ||
| 36 | |||
| 37 | 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. | ||
| 38 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/DeleteStream> | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 CurrentVersion => Str | ||
| 44 | |||
| 45 | Optional: The version of the stream that you want to delete. | ||
| 46 | |||
| 47 | Specify the version as a safeguard to ensure that your are deleting the | ||
| 48 | correct stream. To get the stream version, use the C<DescribeStream> | ||
| 49 | API. | ||
| 50 | |||
| 51 | If not specified, only the C<CreationTime> is checked before deleting | ||
| 52 | the stream. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> StreamARN => Str | ||
| 57 | |||
| 58 | The Amazon Resource Name (ARN) of the stream that you want to delete. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, documenting arguments for method DeleteStream in L<Paws::KinesisVideo> | ||
| 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 |