« blib/lib/Paws/CloudWatchLogs/PutMetricFilter.pm
↑ Summary
blib/lib/Paws/CloudWatchLogs/PutQueryDefinitionResponse.pm »
| 1 | |||
| 2 | package Paws::CloudWatchLogs::PutQueryDefinition; | ||
| 3 | use Moose; | ||
| 4 | has LogGroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'logGroupNames' ); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' , required => 1); | ||
| 6 | has QueryDefinitionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'queryDefinitionId' ); | ||
| 7 | has QueryString => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'queryString' , required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutQueryDefinition'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchLogs::PutQueryDefinitionResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudWatchLogs::PutQueryDefinition - Arguments for method PutQueryDefinition on L<Paws::CloudWatchLogs> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutQueryDefinition on the | ||
| 25 | L<Amazon CloudWatch Logs|Paws::CloudWatchLogs> service. Use the attributes of this class | ||
| 26 | as arguments to method PutQueryDefinition. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutQueryDefinition. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $logs = Paws->service('CloudWatchLogs'); | ||
| 33 | my $PutQueryDefinitionResponse = $logs->PutQueryDefinition( | ||
| 34 | Name => 'MyQueryDefinitionName', | ||
| 35 | QueryString => 'MyQueryDefinitionString', | ||
| 36 | LogGroupNames => [ | ||
| 37 | 'MyLogGroupName', ... # min: 1, max: 512 | ||
| 38 | ], # OPTIONAL | ||
| 39 | QueryDefinitionId => 'MyQueryId', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $QueryDefinitionId = $PutQueryDefinitionResponse->QueryDefinitionId; | ||
| 44 | |||
| 45 | # Returns a L<Paws::CloudWatchLogs::PutQueryDefinitionResponse> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/logs/PutQueryDefinition> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 LogGroupNames => ArrayRef[Str|Undef] | ||
| 54 | |||
| 55 | Use this parameter to include specific log groups as part of your query | ||
| 56 | definition. | ||
| 57 | |||
| 58 | If you are updating a query definition and you omit this parameter, | ||
| 59 | then the updated definition will contain no log groups. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Name => Str | ||
| 64 | |||
| 65 | A name for the query definition. If you are saving a lot of query | ||
| 66 | definitions, we recommend that you name them so that you can easily | ||
| 67 | find the ones you want by using the first part of the name as a filter | ||
| 68 | in the C<queryDefinitionNamePrefix> parameter of | ||
| 69 | DescribeQueryDefinitions | ||
| 70 | (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html). | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 QueryDefinitionId => Str | ||
| 75 | |||
| 76 | If you are updating a query definition, use this parameter to specify | ||
| 77 | the ID of the query definition that you want to update. You can use | ||
| 78 | DescribeQueryDefinitions | ||
| 79 | (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html) | ||
| 80 | to retrieve the IDs of your saved query definitions. | ||
| 81 | |||
| 82 | If you are creating a query definition, do not specify this parameter. | ||
| 83 | CloudWatch generates a unique ID for the new query definition and | ||
| 84 | include it in the response to this operation. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> QueryString => Str | ||
| 89 | |||
| 90 | The query string to use for this definition. For more information, see | ||
| 91 | CloudWatch Logs Insights Query Syntax | ||
| 92 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method PutQueryDefinition in L<Paws::CloudWatchLogs> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |