ListServices - AWS Proton

ListServices

List services with summaries of detail data.

Request Syntax

{ "maxResults": number, "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

The maximum number of services to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

A token that indicates the location of the next service in the array of services, after the list of services that was previously requested.

Type: String

Pattern: ^[A-Za-z0-9+=/]+$

Required: No

Response Syntax

{ "nextToken": "string", "services": [ { "arn": "string", "createdAt": number, "description": "string", "lastModifiedAt": number, "name": "string", "status": "string", "statusMessage": "string", "templateName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

A token that indicates the location of the next service in the array of services, after the current requested list of services.

Type: String

Pattern: ^[A-Za-z0-9+=/]+$

services

An array of services with summaries of detail data.

Type: Array of ServiceSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: