List Service Instances

proton_list_service_instances

R Documentation

List service instances with summary data¶

Description¶

List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.

Usage¶

proton_list_service_instances(filters, maxResults, nextToken,
  serviceName, sortBy, sortOrder)

Arguments¶

filters

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

maxResults

The maximum number of service instances to list.

nextToken

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

serviceName

The name of the service that the service instance belongs to.

sortBy

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

sortOrder

Result list sort order.

Default: ASCENDING

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  serviceInstances = list(
    list(
      arn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      deploymentStatus = "IN_PROGRESS"|"FAILED"|"SUCCEEDED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"CANCELLING"|"CANCELLED",
      deploymentStatusMessage = "string",
      environmentName = "string",
      lastAttemptedDeploymentId = "string",
      lastDeploymentAttemptedAt = as.POSIXct(
        "2015-01-01"
      ),
      lastDeploymentSucceededAt = as.POSIXct(
        "2015-01-01"
      ),
      lastSucceededDeploymentId = "string",
      name = "string",
      serviceName = "string",
      templateMajorVersion = "string",
      templateMinorVersion = "string",
      templateName = "string"
    )
  )
)

Request syntax¶

svc$list_service_instances(
  filters = list(
    list(
      key = "name"|"deploymentStatus"|"templateName"|"serviceName"|"deployedTemplateVersionStatus"|"environmentName"|"lastDeploymentAttemptedAtBefore"|"lastDeploymentAttemptedAtAfter"|"createdAtBefore"|"createdAtAfter",
      value = "string"
    )
  ),
  maxResults = 123,
  nextToken = "string",
  serviceName = "string",
  sortBy = "name"|"deploymentStatus"|"templateName"|"serviceName"|"environmentName"|"lastDeploymentAttemptedAt"|"createdAt",
  sortOrder = "ASCENDING"|"DESCENDING"
)