List Deployments

proton_list_deployments

R Documentation

List deployments

Description

List deployments. You can filter the result list by environment, service, or a single service instance.

Usage

proton_list_deployments(componentName, environmentName, maxResults,
  nextToken, serviceInstanceName, serviceName)

Arguments

componentName

The name of a component for result list filtering. Proton returns deployments associated with that component.

environmentName

The name of an environment for result list filtering. Proton returns deployments associated with the environment.

maxResults

The maximum number of deployments to list.

nextToken

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

serviceInstanceName

The name of a service instance for result list filtering. Proton returns the deployments associated with the service instance.

serviceName

The name of a service for result list filtering. Proton returns deployments associated with service instances of the service.

Value

A list with the following syntax:

list(
  deployments = list(
    list(
      arn = "string",
      completedAt = as.POSIXct(
        "2015-01-01"
      ),
      componentName = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      deploymentStatus = "IN_PROGRESS"|"FAILED"|"SUCCEEDED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"CANCELLING"|"CANCELLED",
      environmentName = "string",
      id = "string",
      lastAttemptedDeploymentId = "string",
      lastModifiedAt = as.POSIXct(
        "2015-01-01"
      ),
      lastSucceededDeploymentId = "string",
      serviceInstanceName = "string",
      serviceName = "string",
      targetArn = "string",
      targetResourceCreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      targetResourceType = "ENVIRONMENT"|"SERVICE_PIPELINE"|"SERVICE_INSTANCE"|"COMPONENT"
    )
  ),
  nextToken = "string"
)

Request syntax

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