NAME

Paws::ApiGateway::DocumentationPartLocation

USAGE

This class represents one of two things:

Arguments in a call to a service

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  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGateway::DocumentationPartLocation object:

  $result = $service_obj->Method(...);
  $result->Att1->Method

DESCRIPTION

Specifies the target API entity to which the documentation applies.

ATTRIBUTES

Method => Str

The HTTP verb of a method. It is a valid field for the API entity types of "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", and "RESPONSE_BODY". The default value is "*" 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 "location" attributes, the child entity's "method" attribute must match that of the parent entity exactly.

Name => Str

The name of the targeted API entity. It is a valid and required field for the API entity types of "AUTHORIZER", "MODEL", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY" and "RESPONSE_HEADER". It is an invalid field for any other entity type.

Path => Str

The URL path of the target. It is a valid field for the API entity types of "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", and "RESPONSE_BODY". The default value is "/" 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 "location" attributes, the child entity's "path" attribute must match that of the parent entity as a prefix.

StatusCode => Str

The HTTP status code of a response. It is a valid field for the API entity types of "RESPONSE", "RESPONSE_HEADER", and "RESPONSE_BODY". The default value is "*" 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 "location" attributes, the child entity's "statusCode" attribute must match that of the parent entity exactly.

REQUIRED Type => Str

[Required] The type of API entity to which the documentation content applies. Valid values are "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", and "RESPONSE_BODY". Content inheritance does not apply to any entity of the "API", "AUTHORIZER", "METHOD", "MODEL", "REQUEST_BODY", or "RESOURCE" type.

BUGS and CONTRIBUTIONS

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>