The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::Robomaker::ListWorlds - Arguments for method ListWorlds on Paws::Robomaker

DESCRIPTION

This class represents the parameters used for calling the method ListWorlds on the AWS RoboMaker service. Use the attributes of this class as arguments to method ListWorlds.

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

SYNOPSIS

    my $robomaker = Paws->service('Robomaker');
    my $ListWorldsResponse = $robomaker->ListWorlds(
      Filters => [
        {
          Name   => 'MyName',    # min: 1, max: 255; OPTIONAL
          Values => [
            'MyName', ...        # min: 1, max: 255; OPTIONAL
          ],    # min: 1, max: 1; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      MaxResults => 1,                      # OPTIONAL
      NextToken  => 'MyPaginationToken',    # OPTIONAL
    );

    # Results:
    my $NextToken      = $ListWorldsResponse->NextToken;
    my $WorldSummaries = $ListWorldsResponse->WorldSummaries;

    # Returns a L<Paws::Robomaker::ListWorldsResponse> 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/robomaker/ListWorlds

ATTRIBUTES

Filters => ArrayRef[Paws::Robomaker::Filter]

Optional filters to limit results. You can use status.

MaxResults => Int

When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

NextToken => Str

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListWorlds in Paws::Robomaker

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