update_deployment

ApiGatewayV2.Client.update_deployment(**kwargs)

Updates a Deployment.

See also: AWS API Documentation

Request Syntax

response = client.update_deployment(
    ApiId='string',
    DeploymentId='string',
    Description='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • DeploymentId (string) --

    [REQUIRED]

    The deployment ID.

  • Description (string) -- The description for the deployment resource.
Return type

dict

Returns

Response Syntax

{
    'AutoDeployed': True|False,
    'CreatedDate': datetime(2015, 1, 1),
    'DeploymentId': 'string',
    'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
    'DeploymentStatusMessage': 'string',
    'Description': 'string'
}

Response Structure

  • (dict) --

    Success

    • AutoDeployed (boolean) --

      Specifies whether a deployment was automatically released.

    • CreatedDate (datetime) --

      The date and time when the Deployment resource was created.

    • DeploymentId (string) --

      The identifier for the deployment.

    • DeploymentStatus (string) --

      The status of the deployment: PENDING, FAILED, or SUCCEEDED.

    • DeploymentStatusMessage (string) --

      May contain additional feedback on the status of an API deployment.

    • Description (string) --

      The description for the deployment.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException