| 1 | |||
| 2 | package Paws::Kinesis::DeregisterStreamConsumer; | ||
| 3 | use Moose; | ||
| 4 | has ConsumerARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has ConsumerName => (is => 'ro', isa => 'Str'); | ||
| 6 | has StreamARN => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeregisterStreamConsumer'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Kinesis::DeregisterStreamConsumer - Arguments for method DeregisterStreamConsumer on L<Paws::Kinesis> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DeregisterStreamConsumer on the | ||
| 24 | L<Amazon Kinesis|Paws::Kinesis> service. Use the attributes of this class | ||
| 25 | as arguments to method DeregisterStreamConsumer. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeregisterStreamConsumer. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kinesis = Paws->service('Kinesis'); | ||
| 32 | $kinesis->DeregisterStreamConsumer( | ||
| 33 | ConsumerARN => 'MyConsumerARN', # OPTIONAL | ||
| 34 | ConsumerName => 'MyConsumerName', # OPTIONAL | ||
| 35 | StreamARN => 'MyStreamARN', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | 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. | ||
| 39 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesis/DeregisterStreamConsumer> | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 ConsumerARN => Str | ||
| 45 | |||
| 46 | The ARN returned by Kinesis Data Streams when you registered the | ||
| 47 | consumer. If you don't know the ARN of the consumer that you want to | ||
| 48 | deregister, you can use the ListStreamConsumers operation to get a list | ||
| 49 | of the descriptions of all the consumers that are currently registered | ||
| 50 | with a given data stream. The description of a consumer contains its | ||
| 51 | ARN. | ||
| 52 | |||
| 53 | |||
| 54 | |||
| 55 | =head2 ConsumerName => Str | ||
| 56 | |||
| 57 | The name that you gave to the consumer. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 StreamARN => Str | ||
| 62 | |||
| 63 | The ARN of the Kinesis data stream that the consumer is registered | ||
| 64 | with. For more information, see Amazon Resource Names (ARNs) and AWS | ||
| 65 | Service Namespaces | ||
| 66 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method DeregisterStreamConsumer in L<Paws::Kinesis> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |