« blib/lib/Paws/ApiGateway/UpdateDocumentationPart.pm
↑ Summary
blib/lib/Paws/ApiGateway/UpdateDomainName.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::UpdateDocumentationVersion; | ||
| 3 | use Moose; | ||
| 4 | has DocumentationVersion => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'doc_version', required => 1); | ||
| 5 | has PatchOperations => (is => 'ro', isa => 'ArrayRef[Paws::ApiGateway::PatchOperation]', traits => ['NameInRequest'], request_name => 'patchOperations'); | ||
| 6 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDocumentationVersion'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/documentation/versions/{doc_version}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::DocumentationVersion'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ApiGateway::UpdateDocumentationVersion - Arguments for method UpdateDocumentationVersion on L<Paws::ApiGateway> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdateDocumentationVersion on the | ||
| 25 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdateDocumentationVersion. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDocumentationVersion. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $apigateway = Paws->service('ApiGateway'); | ||
| 33 | my $DocumentationVersion = $apigateway->UpdateDocumentationVersion( | ||
| 34 | DocumentationVersion => 'MyString', | ||
| 35 | RestApiId => 'MyString', | ||
| 36 | PatchOperations => [ | ||
| 37 | { | ||
| 38 | From => 'MyString', | ||
| 39 | Op => | ||
| 40 | 'add', # values: add, remove, replace, move, copy, test; OPTIONAL | ||
| 41 | Path => 'MyString', | ||
| 42 | Value => 'MyString', | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $CreatedDate = $DocumentationVersion->CreatedDate; | ||
| 50 | my $Description = $DocumentationVersion->Description; | ||
| 51 | my $Version = $DocumentationVersion->Version; | ||
| 52 | |||
| 53 | # Returns a L<Paws::ApiGateway::DocumentationVersion> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/UpdateDocumentationVersion> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> DocumentationVersion => Str | ||
| 62 | |||
| 63 | [Required] The version identifier of the to-be-updated documentation | ||
| 64 | version. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 PatchOperations => ArrayRef[L<Paws::ApiGateway::PatchOperation>] | ||
| 69 | |||
| 70 | A list of update operations to be applied to the specified resource and | ||
| 71 | in the order specified in this list. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> RestApiId => Str | ||
| 76 | |||
| 77 | [Required] The string identifier of the associated RestApi.. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, documenting arguments for method UpdateDocumentationVersion in L<Paws::ApiGateway> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |