Skip to content

Update Deployment

apigatewayv2_update_deployment R Documentation

Updates a Deployment

Description

Updates a Deployment.

Usage

apigatewayv2_update_deployment(ApiId, DeploymentId, Description)

Arguments

ApiId

[required] The API identifier.

DeploymentId

[required] The deployment ID.

Description

The description for the deployment resource.

Value

A list with the following syntax:

list(
  AutoDeployed = TRUE|FALSE,
  CreatedDate = as.POSIXct(
    "2015-01-01"
  ),
  DeploymentId = "string",
  DeploymentStatus = "PENDING"|"FAILED"|"DEPLOYED",
  DeploymentStatusMessage = "string",
  Description = "string"
)

Request syntax

svc$update_deployment(
  ApiId = "string",
  DeploymentId = "string",
  Description = "string"
)