NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Interface ResourceIteratorInterface

Iterates over a paginated resource using subsequent requests in order to retrieve the entire matching result set

  Guzzle\Service\Resource\ResourceIteratorInterface implements Guzzle\Common\ToArrayInterface, Guzzle\Common\HasDispatcherInterface, Iterator, Countable

### Direct known implementers

`Guzzle\Service\Resource\ResourceIterator`

### Indirect known implementers

`Aws\Common\Iterator\AwsResourceIterator`, `Aws\Ec2\Iterator\DescribeInstancesIterator`, `Aws\S3\Iterator\ListBucketsIterator`, `Aws\S3\Iterator\ListMultipartUploadsIterator`, `Aws\S3\Iterator\ListObjectsIterator`, `Aws\S3\Iterator\ListObjectVersionsIterator`

Namespace: Guzzle\Service\Resource
Located at Guzzle/Service/Resource/ResourceIteratorInterface.php

## Methods summary

- `public` `getNextToken ( )`

  Retrieve the NextToken that can be used in other iterators.

- `public` `setLimit ( int $limit )`

  Attempt to limit the total number of resources returned by the iterator.

- `public` `setPageSize ( int $pageSize )`

  Attempt to limit the total number of resources retrieved per request by the iterator.

- `public` `get ( string $key )`

  Get a data option from the iterator

- `public` `set ( string $key, mixed $value )`

  Set a data option on the iterator

## Methods detail

# `public string`
`getNextToken( )`

Retrieve the NextToken that can be used in other iterators.

#### Returns

`string`
Returns a NextToken
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`setLimit( integer $limit )`

Attempt to limit the total number of resources returned by the iterator.

You may still receive more items than you specify. Set to 0 to specify no limit.

#### Parameters

$limit
  `integer`
  $limit Limit amount

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`setPageSize( integer $pageSize )`

Attempt to limit the total number of resources retrieved per request by the iterator.

The iterator may return more than you specify in the page size argument depending on the service and underlying command implementation. Set to 0 to specify no page size limitation.

#### Parameters

$pageSize
  `integer`
  $pageSize Limit amount

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public mixed|null`
`get( string $key )`

Get a data option from the iterator

#### Parameters

$key
  `string`
  $key Key of the option to retrieve

#### Returns

`mixed|null`
Returns NULL if not set or the value if set
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`set( string $key, mixed $value )`

Set a data option on the iterator

#### Parameters

$key
  `string`
  $key Key of the option to set
$value
  `mixed`
  $value Value to set for the option

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``

### Methods inherited from Guzzle\Common\ToArrayInterface

`toArray()`

### Methods inherited from Guzzle\Common\HasDispatcherInterface

`addSubscriber()`, `dispatch()`, `getAllEvents()`, `getEventDispatcher()`, `setEventDispatcher()`

### Methods inherited from Iterator

`current()`, `key()`, `next()`, `rewind()`, `valid()`

### Methods inherited from Countable

`count()`

### Magic methods summary