NAME

Paws::ApiGateway::GetDocumentationParts - Arguments for method GetDocumentationParts on Paws::ApiGateway

DESCRIPTION

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.

SYNOPSIS

    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

ATTRIBUTES

Limit => Int

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

LocationStatus => Str

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.

Valid values are: "DOCUMENTED", "UNDOCUMENTED"

NameQuery => Str

The name of API entities of the to-be-retrieved documentation parts.

Path => Str

The path of API entities of the to-be-retrieved documentation parts.

Position => Str

The current pagination position in the paged result set.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

Type => Str

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"

SEE ALSO

This class forms part of Paws, documenting arguments for method GetDocumentationParts in Paws::ApiGateway

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