Paws::ApiGateway::DocumentationPartLocation
This class represents one of two things:
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::ApiGateway::DocumentationPartLocation object:
$service_obj->Method(Att1 => { Method => $value, ..., Type => $value });
Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGateway::DocumentationPartLocation object:
$result = $service_obj->Method(...); $result->Att1->Method
Specifies the target API entity to which the documentation applies.
The HTTP verb of a method. It is a valid field for the API entity types of C<METHOD>, C<PATH_PARAMETER>, C<QUERY_PARAMETER>, C<REQUEST_HEADER>, C<REQUEST_BODY>, C<RESPONSE>, C<RESPONSE_HEADER>, and C<RESPONSE_BODY>. The default value is C<*> for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other C<location> attributes, the child entity's C<method> attribute must match that of the parent entity exactly.
The name of the targeted API entity. It is a valid and required field for the API entity types of C<AUTHORIZER>, C<MODEL>, C<PATH_PARAMETER>, C<QUERY_PARAMETER>, C<REQUEST_HEADER>, C<REQUEST_BODY> and C<RESPONSE_HEADER>. It is an invalid field for any other entity type.
The URL path of the target. It is a valid field for the API entity types of C<RESOURCE>, C<METHOD>, C<PATH_PARAMETER>, C<QUERY_PARAMETER>, C<REQUEST_HEADER>, C<REQUEST_BODY>, C<RESPONSE>, C<RESPONSE_HEADER>, and C<RESPONSE_BODY>. The default value is C</> for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other C<location> attributes, the child entity's C<path> attribute must match that of the parent entity as a prefix.
The HTTP status code of a response. It is a valid field for the API entity types of C<RESPONSE>, C<RESPONSE_HEADER>, and C<RESPONSE_BODY>. The default value is C<*> for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other C<location> attributes, the child entity's C<statusCode> attribute must match that of the parent entity exactly.
The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of C<API>, C<AUTHORIZER>, C<MODEL>, C<RESOURCE>, C<METHOD>, C<PATH_PARAMETER>, C<QUERY_PARAMETER>, C<REQUEST_HEADER>, C<REQUEST_BODY>, C<RESPONSE>, C<RESPONSE_HEADER>, and C<RESPONSE_BODY>. Content inheritance does not apply to any entity of the C<API>, C<AUTHROZER>, C<MODEL>, or C<RESOURCE> type.
This class forms part of Paws, describing an object used 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.