« blib/lib/Paws/Support/DescribeAttachmentResponse.pm
↑ Summary
blib/lib/Paws/Support/DescribeCasesResponse.pm »
| 1 | |||
| 2 | package Paws::Support::DescribeCases; | ||
| 3 | use Moose; | ||
| 4 | has AfterTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'afterTime' ); | ||
| 5 | has BeforeTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'beforeTime' ); | ||
| 6 | has CaseIdList => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'caseIdList' ); | ||
| 7 | has DisplayId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'displayId' ); | ||
| 8 | has IncludeCommunications => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeCommunications' ); | ||
| 9 | has IncludeResolvedCases => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeResolvedCases' ); | ||
| 10 | has Language => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'language' ); | ||
| 11 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 12 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCases'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Support::DescribeCasesResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Support::DescribeCases - Arguments for method DescribeCases on L<Paws::Support> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method DescribeCases on the | ||
| 30 | L<AWS Support|Paws::Support> service. Use the attributes of this class | ||
| 31 | as arguments to method DescribeCases. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCases. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $support = Paws->service('Support'); | ||
| 38 | my $DescribeCasesResponse = $support->DescribeCases( | ||
| 39 | AfterTime => 'MyAfterTime', # OPTIONAL | ||
| 40 | BeforeTime => 'MyBeforeTime', # OPTIONAL | ||
| 41 | CaseIdList => [ 'MyCaseId', ... ], # OPTIONAL | ||
| 42 | DisplayId => 'MyDisplayId', # OPTIONAL | ||
| 43 | IncludeCommunications => 1, # OPTIONAL | ||
| 44 | IncludeResolvedCases => 1, # OPTIONAL | ||
| 45 | Language => 'MyLanguage', # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Cases = $DescribeCasesResponse->Cases; | ||
| 52 | my $NextToken = $DescribeCasesResponse->NextToken; | ||
| 53 | |||
| 54 | # Returns a L<Paws::Support::DescribeCasesResponse> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/support/DescribeCases> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 AfterTime => Str | ||
| 63 | |||
| 64 | The start date for a filtered date search on support case | ||
| 65 | communications. Case communications are available for 12 months after | ||
| 66 | creation. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 BeforeTime => Str | ||
| 71 | |||
| 72 | The end date for a filtered date search on support case communications. | ||
| 73 | Case communications are available for 12 months after creation. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 CaseIdList => ArrayRef[Str|Undef] | ||
| 78 | |||
| 79 | A list of ID numbers of the support cases you want returned. The | ||
| 80 | maximum number of cases is 100. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 DisplayId => Str | ||
| 85 | |||
| 86 | The ID displayed for a case in the AWS Support Center user interface. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 IncludeCommunications => Bool | ||
| 91 | |||
| 92 | Specifies whether to include communications in the C<DescribeCases> | ||
| 93 | response. By default, communications are included. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 IncludeResolvedCases => Bool | ||
| 98 | |||
| 99 | Specifies whether to include resolved support cases in the | ||
| 100 | C<DescribeCases> response. By default, resolved cases aren't included. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 Language => Str | ||
| 105 | |||
| 106 | The ISO 639-1 code for the language in which AWS provides support. AWS | ||
| 107 | Support currently supports English ("en") and Japanese ("ja"). Language | ||
| 108 | parameters must be passed explicitly for operations that take them. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 MaxResults => Int | ||
| 113 | |||
| 114 | The maximum number of results to return before paginating. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 NextToken => Str | ||
| 119 | |||
| 120 | A resumption point for pagination. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, documenting arguments for method DescribeCases in L<Paws::Support> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |