Method: projects.locations.awsClusters.list

Lists all AwsCluster resources on a given Google Cloud project and region.

HTTP request

GET https://{endpoint}/v1/{parent=projects/*/locations/*}/awsClusters

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent location which owns this collection of AwsCluster resources.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud Platform resource names.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return.

If not specified, a default value of 50 will be used by the service. Regardless of the pageSize value, the response can include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.
pageToken

string

The nextPageToken value returned from a previous awsClusters.list request, if any.

Request body

The request body must be empty.

Response body

Response message for AwsClusters.ListAwsClusters method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "awsClusters": [
    {
      object (AwsCluster)
    }
  ],
  "nextPageToken": string
}
Fields
awsClusters[]

object (AwsCluster)

A list of AwsCluster resources in the specified Google Cloud Platform project and region region.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gkemulticloud.awsClusters.list

For more information, see the IAM documentation.