« blib/lib/Paws/ApiGateway/GetDeployments.pm
↑ Summary
blib/lib/Paws/ApiGateway/GetDocumentationParts.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::GetDocumentationPart; | ||
| 3 | use Moose; | ||
| 4 | has DocumentationPartId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'part_id', required => 1); | ||
| 5 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDocumentationPart'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/documentation/parts/{part_id}'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::DocumentationPart'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ApiGateway::GetDocumentationPart - Arguments for method GetDocumentationPart on L<Paws::ApiGateway> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetDocumentationPart on the | ||
| 24 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 25 | as arguments to method GetDocumentationPart. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDocumentationPart. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $apigateway = Paws->service('ApiGateway'); | ||
| 32 | my $DocumentationPart = $apigateway->GetDocumentationPart( | ||
| 33 | DocumentationPartId => 'MyString', | ||
| 34 | RestApiId => 'MyString', | ||
| 35 | |||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $Id = $DocumentationPart->Id; | ||
| 40 | my $Location = $DocumentationPart->Location; | ||
| 41 | my $Properties = $DocumentationPart->Properties; | ||
| 42 | |||
| 43 | # Returns a L<Paws::ApiGateway::DocumentationPart> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetDocumentationPart> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> DocumentationPartId => Str | ||
| 52 | |||
| 53 | [Required] The string identifier of the associated RestApi. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> RestApiId => Str | ||
| 58 | |||
| 59 | [Required] The string identifier of the associated RestApi. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head1 SEE ALSO | ||
| 65 | |||
| 66 | This class forms part of L<Paws>, documenting arguments for method GetDocumentationPart in L<Paws::ApiGateway> | ||
| 67 | |||
| 68 | =head1 BUGS and CONTRIBUTIONS | ||
| 69 | |||
| 70 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 71 | |||
| 72 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 73 | |||
| 74 | =cut | ||
| 75 |