Skip to content

List Components

proton_list_components R Documentation

List components with summary data

Description

List components with summary data. You can filter the result list by environment, service, or a single service instance.

For more information about components, see Proton components in the Proton User Guide.

Usage

proton_list_components(environmentName, maxResults, nextToken,
  serviceInstanceName, serviceName)

Arguments

environmentName

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

maxResults

The maximum number of components to list.

nextToken

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

serviceInstanceName

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

serviceName

The name of a service for result list filtering. Proton returns components attached to service instances of the service.

Value

A list with the following syntax: 

list(
  components = 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"
      ),
      lastModifiedAt = as.POSIXct(
        "2015-01-01"
      ),
      lastSucceededDeploymentId = "string",
      name = "string",
      serviceInstanceName = "string",
      serviceName = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_components(
  environmentName = "string",
  maxResults = 123,
  nextToken = "string",
  serviceInstanceName = "string",
  serviceName = "string"
)