Paws::ApiGateway::GetDocumentationParts - Arguments for method GetDocumentationParts on Paws::ApiGateway
This class represents the parameters used for calling the method GetDocumentationParts on the Amazon API Gateway service. Use the attributes of this class as arguments to method GetDocumentationParts.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDocumentationParts.
my $apigateway = Paws->service('ApiGateway'); my $DocumentationParts = $apigateway->GetDocumentationParts( RestApiId => 'MyString', Limit => 1, # OPTIONAL LocationStatus => 'DOCUMENTED', # OPTIONAL NameQuery => 'MyString', # OPTIONAL Path => 'MyString', # OPTIONAL Position => 'MyString', # OPTIONAL Type => 'API', # OPTIONAL ); # Results: my $Items = $DocumentationParts->Items; my $Position = $DocumentationParts->Position; # Returns a L<Paws::ApiGateway::DocumentationParts> object.
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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetDocumentationParts
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
DOCUMENTED
UNDOCUMENTED
Valid values are: "DOCUMENTED", "UNDOCUMENTED"
"DOCUMENTED"
"UNDOCUMENTED"
The name of API entities of the to-be-retrieved documentation parts.
The path of API entities of the to-be-retrieved documentation parts.
The current pagination position in the paged result set.
[Required] The string identifier of the associated RestApi.
The type of API entities of the to-be-retrieved documentation parts.
Valid values are: "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
"API"
"AUTHORIZER"
"MODEL"
"RESOURCE"
"METHOD"
"PATH_PARAMETER"
"QUERY_PARAMETER"
"REQUEST_HEADER"
"REQUEST_BODY"
"RESPONSE"
"RESPONSE_HEADER"
"RESPONSE_BODY"
This class forms part of Paws, documenting arguments for method GetDocumentationParts in Paws::ApiGateway
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.