ApiGatewayV2 / Client / create_deployment

create_deployment#

ApiGatewayV2.Client.create_deployment(**kwargs)#

Creates a Deployment for an API.

Request Syntax

response = client.create_deployment(
    ApiId='string',
    Description='string',
    StageName='string'
)

Parameters:

ApiId (string) –
[REQUIRED]

The API identifier.
Description (string) – The description for the deployment resource.
StageName (string) – The name of the Stage resource for the Deployment resource to create.

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) –

The request has succeeded and has resulted in the creation of a resource.
- 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