Skip to content

Get Component

proton_get_component R Documentation

Get detailed data for a component

Description

Get detailed data for a component.

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

Usage

proton_get_component(name)

Arguments

name

[required] The name of the component that you want to get the detailed data for.

Value

A list with the following syntax:

list(
  component = 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",
    description = "string",
    environmentName = "string",
    lastAttemptedDeploymentId = "string",
    lastClientRequestToken = "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",
    serviceSpec = "string"
  )
)

Request syntax

svc$get_component(
  name = "string"
)