Amazonka.Snowball.ListClusters

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

This operation returns paginated results.

Creating a Request

data ListClusters

See: newListClusters smart constructor.

Constructors

ListClusters'

Fields

• maxResults :: Maybe Natural

  The number of ClusterListEntry objects to return.

• nextToken :: Maybe Text

  HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Instances

ToJSON ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

toJSON :: ListClusters -> Value

toEncoding :: ListClusters -> Encoding

toJSONList :: [ListClusters] -> Value

toEncodingList :: [ListClusters] -> Encoding

ToHeaders ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

toHeaders :: ListClusters -> [Header]

ToPath ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

toPath :: ListClusters -> ByteString

ToQuery ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

toQuery :: ListClusters -> QueryString

AWSPager ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

page :: ListClusters -> AWSResponse ListClusters -> Maybe ListClusters

AWSRequest ListClusters

Defined in Amazonka.Snowball.ListClusters

Associated Types

type AWSResponse ListClusters

Methods

request :: (Service -> Service) -> ListClusters -> Request ListClusters

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListClusters)))

Generic ListClusters

Defined in Amazonka.Snowball.ListClusters

Associated Types

type Rep ListClusters :: Type -> Type

Methods

from :: ListClusters -> Rep ListClusters x

to :: Rep ListClusters x -> ListClusters

Read ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

readsPrec :: Int -> ReadS ListClusters

readList :: ReadS [ListClusters]

readPrec :: ReadPrec ListClusters

readListPrec :: ReadPrec [ListClusters]

Show ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

showsPrec :: Int -> ListClusters -> ShowS

show :: ListClusters -> String

showList :: [ListClusters] -> ShowS

NFData ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

rnf :: ListClusters -> ()

Eq ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

(==) :: ListClusters -> ListClusters -> Bool

(/=) :: ListClusters -> ListClusters -> Bool

Hashable ListClusters

Defined in Amazonka.Snowball.ListClusters

Methods

hashWithSalt :: Int -> ListClusters -> Int

hash :: ListClusters -> Int

type AWSResponse ListClusters

Defined in Amazonka.Snowball.ListClusters

type AWSResponse ListClusters = ListClustersResponse

type Rep ListClusters

Defined in Amazonka.Snowball.ListClusters

type Rep ListClusters = D1 ('MetaData "ListClusters" "Amazonka.Snowball.ListClusters" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "ListClusters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListClusters :: ListClusters

Create a value of ListClusters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListClusters', listClusters_maxResults - The number of ClusterListEntry objects to return.

ListClusters, listClusters_nextToken - HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Request Lenses

listClusters_maxResults :: Lens' ListClusters (Maybe Natural)

The number of ClusterListEntry objects to return.

listClusters_nextToken :: Lens' ListClusters (Maybe Text)

HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Destructuring the Response

data ListClustersResponse

See: newListClustersResponse smart constructor.

Constructors

ListClustersResponse'

Fields

• clusterListEntries :: Maybe [ClusterListEntry]

  Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

• nextToken :: Maybe Text

  HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListClustersResponse

Defined in Amazonka.Snowball.ListClusters

Associated Types

type Rep ListClustersResponse :: Type -> Type

Methods

from :: ListClustersResponse -> Rep ListClustersResponse x

to :: Rep ListClustersResponse x -> ListClustersResponse

Read ListClustersResponse

Defined in Amazonka.Snowball.ListClusters

Methods

readsPrec :: Int -> ReadS ListClustersResponse

readList :: ReadS [ListClustersResponse]

readPrec :: ReadPrec ListClustersResponse

readListPrec :: ReadPrec [ListClustersResponse]

Show ListClustersResponse

Defined in Amazonka.Snowball.ListClusters

Methods

showsPrec :: Int -> ListClustersResponse -> ShowS

show :: ListClustersResponse -> String

showList :: [ListClustersResponse] -> ShowS

NFData ListClustersResponse

Defined in Amazonka.Snowball.ListClusters

Methods

rnf :: ListClustersResponse -> ()

Eq ListClustersResponse

Defined in Amazonka.Snowball.ListClusters

Methods

(==) :: ListClustersResponse -> ListClustersResponse -> Bool

(/=) :: ListClustersResponse -> ListClustersResponse -> Bool

type Rep ListClustersResponse

Defined in Amazonka.Snowball.ListClusters

type Rep ListClustersResponse = D1 ('MetaData "ListClustersResponse" "Amazonka.Snowball.ListClusters" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "ListClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterListEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterListEntry])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListClustersResponse

Arguments

:: Int

$sel:httpStatus:ListClustersResponse'

-> ListClustersResponse

Create a value of ListClustersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clusterListEntries:ListClustersResponse', listClustersResponse_clusterListEntries - Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

ListClusters, listClustersResponse_nextToken - HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.

$sel:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.

Response Lenses

listClustersResponse_clusterListEntries :: Lens' ListClustersResponse (Maybe [ClusterListEntry])

Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)

HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.

listClustersResponse_httpStatus :: Lens' ListClustersResponse Int

The response's http status code.