++ed by:
IOANR PABLROD LUKEC CAFEGRATZ AKIYM

17 PAUSE users
18 non-PAUSE users.

Jose Luis Martinez Torres
and 1 contributors

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method GetResources on the Amazon API Gateway service. Use the attributes of this class as arguments to method GetResources.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetResources.

SYNOPSIS

    my $apigateway = Paws->service('ApiGateway');
    my $Resources = $apigateway->GetResources(
      RestApiId => 'MyString',
      Embed     => [ 'MyString', ... ],    # OPTIONAL
      Limit     => 1,                      # OPTIONAL
      Position  => 'MyString',             # OPTIONAL
    );

    # Results:
    my $Items    = $Resources->Items;
    my $Position = $Resources->Position;

    # Returns a L<Paws::ApiGateway::Resources> 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://aws.amazon.com/documentation/apigateway/

ATTRIBUTES

Embed => ArrayRef[Str|Undef]

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Limit => Int

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

Position => Str

The current pagination position in the paged result set.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetResources 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