AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the GetDeployment operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.AppConfig.Model.GetDeploymentResponse

Namespace: Amazon.AppConfig.Model
Assembly: AWSSDK.AppConfig.dll
Version: 3.x.y.z

Syntax

C#
public class GetDeploymentResponse : AmazonWebServiceResponse

The GetDeploymentResponse type exposes the following members

Constructors

NameDescription
Public Method GetDeploymentResponse()

Properties

NameTypeDescription
Public Property ApplicationId System.String

Gets and sets the property ApplicationId.

The ID of the application that was deployed.

Public Property AppliedExtensions System.Collections.Generic.List<Amazon.AppConfig.Model.AppliedExtension>

Gets and sets the property AppliedExtensions.

A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

Public Property CompletedAt System.DateTime

Gets and sets the property CompletedAt.

The time the deployment completed.

Public Property ConfigurationLocationUri System.String

Gets and sets the property ConfigurationLocationUri.

Information about the source location of the configuration.

Public Property ConfigurationName System.String

Gets and sets the property ConfigurationName.

The name of the configuration.

Public Property ConfigurationProfileId System.String

Gets and sets the property ConfigurationProfileId.

The ID of the configuration profile that was deployed.

Public Property ConfigurationVersion System.String

Gets and sets the property ConfigurationVersion.

The configuration version that was deployed.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property DeploymentDurationInMinutes System.Int32

Gets and sets the property DeploymentDurationInMinutes.

Total amount of time the deployment lasted.

Public Property DeploymentNumber System.Int32

Gets and sets the property DeploymentNumber.

The sequence number of the deployment.

Public Property DeploymentStrategyId System.String

Gets and sets the property DeploymentStrategyId.

The ID of the deployment strategy that was deployed.

Public Property Description System.String

Gets and sets the property Description.

The description of the deployment.

Public Property EnvironmentId System.String

Gets and sets the property EnvironmentId.

The ID of the environment that was deployed.

Public Property EventLog System.Collections.Generic.List<Amazon.AppConfig.Model.DeploymentEvent>

Gets and sets the property EventLog.

A list containing all events related to a deployment. The most recent events are displayed first.

Public Property FinalBakeTimeInMinutes System.Int32

Gets and sets the property FinalBakeTimeInMinutes.

The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

Public Property GrowthFactor System.Single

Gets and sets the property GrowthFactor.

The percentage of targets to receive a deployed configuration during each interval.

Public Property GrowthType Amazon.AppConfig.GrowthType

Gets and sets the property GrowthType.

The algorithm used to define how percentage grew over time.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property KmsKeyArn System.String

Gets and sets the property KmsKeyArn.

The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

Public Property KmsKeyIdentifier System.String

Gets and sets the property KmsKeyIdentifier.

The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

Public Property PercentageComplete System.Single

Gets and sets the property PercentageComplete.

The percentage of targets for which the deployment is available.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property StartedAt System.DateTime

Gets and sets the property StartedAt.

The time the deployment started.

Public Property State Amazon.AppConfig.DeploymentState

Gets and sets the property State.

The state of the deployment.

Public Property VersionLabel System.String

Gets and sets the property VersionLabel.

A user-defined label for an AppConfig hosted configuration version.

Examples

The following get-deployment example lists details of the deployment to the application in the specified environment and deployment.

To retrieve deployment details


var client = new AmazonAppConfigClient();
var response = client.GetDeployment(new GetDeploymentRequest 
{
    ApplicationId = "339ohji",
    DeploymentNumber = 1,
    EnvironmentId = "54j1r29"
});

string applicationId = response.ApplicationId;
DateTime completedAt = response.CompletedAt;
string configurationLocationUri = response.ConfigurationLocationUri;
string configurationName = response.ConfigurationName;
string configurationProfileId = response.ConfigurationProfileId;
string configurationVersion = response.ConfigurationVersion;
int deploymentDurationInMinutes = response.DeploymentDurationInMinutes;
int deploymentNumber = response.DeploymentNumber;
string deploymentStrategyId = response.DeploymentStrategyId;
string environmentId = response.EnvironmentId;
List<DeploymentEvent> eventLog = response.EventLog;
int finalBakeTimeInMinutes = response.FinalBakeTimeInMinutes;
float growthFactor = response.GrowthFactor;
string growthType = response.GrowthType;
float percentageComplete = response.PercentageComplete;
DateTime startedAt = response.StartedAt;
string state = response.State;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5