[CodeDeploy] Added getDeployment method (#1150)

* [CodeDeploy] Added `getDeployment` method

* Fix CS

* regenerated code

* Update psalm baseline

* add missing assertion

* fix assert

Author: martinssipenko

CHANGELOG.md

@@ -7,6 +7,7 @@
 - AWS api-change: Added `us-iso-west-1` region
 - AWS api-change: Use specific configuration for `us` regions
 - Added `createDeployment` method
+- Added `getDeployment` method
 
 ## 1.2.1
 

composer.json

@@ -12,6 +12,7 @@
     ],
     "require": {
         "php": "^7.2.5 || ^8.0",
+        "ext-filter": "*",
         "ext-json": "*",
         "async-aws/core": "^1.9"
     },

src/CodeDeployClient.php

@@ -36,8 +36,10 @@
 use AsyncAws\CodeDeploy\Exception\ThrottlingException;
 use AsyncAws\CodeDeploy\Exception\UnsupportedActionForDeploymentTypeException;
 use AsyncAws\CodeDeploy\Input\CreateDeploymentInput;
+use AsyncAws\CodeDeploy\Input\GetDeploymentInput;
 use AsyncAws\CodeDeploy\Input\PutLifecycleEventHookExecutionStatusInput;
 use AsyncAws\CodeDeploy\Result\CreateDeploymentOutput;
+use AsyncAws\CodeDeploy\Result\GetDeploymentOutput;
 use AsyncAws\CodeDeploy\Result\PutLifecycleEventHookExecutionStatusOutput;
 use AsyncAws\CodeDeploy\ValueObject\AutoRollbackConfiguration;
 use AsyncAws\CodeDeploy\ValueObject\RevisionLocation;
@@ -128,6 +130,33 @@ public function createDeployment($input): CreateDeploymentOutput
         return new CreateDeploymentOutput($response);
     }
 
+    /**
+     * Gets information about a deployment.
+     *
+     * @see https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_GetDeployment.html
+     * @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-codedeploy-2014-10-06.html#getdeployment
+     *
+     * @param array{
+     *   deploymentId: string,
+     *   @region?: string,
+     * }|GetDeploymentInput $input
+     *
+     * @throws DeploymentIdRequiredException
+     * @throws InvalidDeploymentIdException
+     * @throws DeploymentDoesNotExistException
+     */
+    public function getDeployment($input): GetDeploymentOutput
+    {
+        $input = GetDeploymentInput::create($input);
+        $response = $this->getResponse($input->request(), new RequestContext(['operation' => 'GetDeployment', 'region' => $input->getRegion(), 'exceptionMapping' => [
+            'DeploymentIdRequiredException' => DeploymentIdRequiredException::class,
+            'InvalidDeploymentIdException' => InvalidDeploymentIdException::class,
+            'DeploymentDoesNotExistException' => DeploymentDoesNotExistException::class,
+        ]]));
+
+        return new GetDeploymentOutput($response);
+    }
+
     /**
      * Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses
      * the AWS Lambda or Amazon ECS compute platform. For AWS Lambda deployments, the available lifecycle hooks are

src/Enum/ComputePlatform.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * The destination platform type for the deployment (`Lambda`, `Server`, or `ECS`).
+ */
+final class ComputePlatform
+{
+    public const ECS = 'ECS';
+    public const LAMBDA = 'Lambda';
+    public const SERVER = 'Server';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::ECS => true,
+            self::LAMBDA => true,
+            self::SERVER => true,
+        ][$value]);
+    }
+}

src/Enum/DeploymentCreator.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * The means by which the deployment was created:.
+ *
+ * - `user`: A user created the deployment.
+ * - `autoscaling`: Amazon EC2 Auto Scaling created the deployment.
+ * - `codeDeployRollback`: A rollback process created the deployment.
+ * - `CodeDeployAutoUpdate`: An auto-update process created the deployment when it detected outdated EC2 instances.
+ */
+final class DeploymentCreator
+{
+    public const AUTOSCALING = 'autoscaling';
+    public const CLOUD_FORMATION = 'CloudFormation';
+    public const CLOUD_FORMATION_ROLLBACK = 'CloudFormationRollback';
+    public const CODE_DEPLOY = 'CodeDeploy';
+    public const CODE_DEPLOY_AUTO_UPDATE = 'CodeDeployAutoUpdate';
+    public const CODE_DEPLOY_ROLLBACK = 'codeDeployRollback';
+    public const USER = 'user';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::AUTOSCALING => true,
+            self::CLOUD_FORMATION => true,
+            self::CLOUD_FORMATION_ROLLBACK => true,
+            self::CODE_DEPLOY => true,
+            self::CODE_DEPLOY_AUTO_UPDATE => true,
+            self::CODE_DEPLOY_ROLLBACK => true,
+            self::USER => true,
+        ][$value]);
+    }
+}

src/Enum/DeploymentOption.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * Indicates whether to route deployment traffic behind a load balancer.
+ */
+final class DeploymentOption
+{
+    public const WITHOUT_TRAFFIC_CONTROL = 'WITHOUT_TRAFFIC_CONTROL';
+    public const WITH_TRAFFIC_CONTROL = 'WITH_TRAFFIC_CONTROL';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::WITHOUT_TRAFFIC_CONTROL => true,
+            self::WITH_TRAFFIC_CONTROL => true,
+        ][$value]);
+    }
+}

src/Enum/DeploymentReadyAction.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * Information about when to reroute traffic from an original environment to a replacement environment in a blue/green
+ * deployment.
+ *
+ * - CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision
+ *   is installed on the instances in the replacement environment.
+ * - STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using
+ *   ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment
+ *   status is changed to Stopped.
+ */
+final class DeploymentReadyAction
+{
+    public const CONTINUE_DEPLOYMENT = 'CONTINUE_DEPLOYMENT';
+    public const STOP_DEPLOYMENT = 'STOP_DEPLOYMENT';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::CONTINUE_DEPLOYMENT => true,
+            self::STOP_DEPLOYMENT => true,
+        ][$value]);
+    }
+}

src/Enum/DeploymentStatus.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * The current state of the deployment as a whole.
+ */
+final class DeploymentStatus
+{
+    public const BAKING = 'Baking';
+    public const CREATED = 'Created';
+    public const FAILED = 'Failed';
+    public const IN_PROGRESS = 'InProgress';
+    public const QUEUED = 'Queued';
+    public const READY = 'Ready';
+    public const STOPPED = 'Stopped';
+    public const SUCCEEDED = 'Succeeded';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::BAKING => true,
+            self::CREATED => true,
+            self::FAILED => true,
+            self::IN_PROGRESS => true,
+            self::QUEUED => true,
+            self::READY => true,
+            self::STOPPED => true,
+            self::SUCCEEDED => true,
+        ][$value]);
+    }
+}

src/Enum/DeploymentType.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * Indicates whether to run an in-place deployment or a blue/green deployment.
+ */
+final class DeploymentType
+{
+    public const BLUE_GREEN = 'BLUE_GREEN';
+    public const IN_PLACE = 'IN_PLACE';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::BLUE_GREEN => true,
+            self::IN_PLACE => true,
+        ][$value]);
+    }
+}

src/Enum/ErrorCode.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * For more information, see Error Codes for AWS CodeDeploy in the AWS CodeDeploy User Guide.
+ * The error code:.
+ *
+ * - APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is
+ *   deleted after the deployment is created, but before it is started.
+ * - DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment
+ *   group is deleted after the deployment is created, but before it is started.
+ * - HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance
+ *   health constraints specified.
+ * - HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints
+ *   specified.
+ * - IAM_ROLE_MISSING: The service role cannot be accessed.
+ * - IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
+ * - INTERNAL_ERROR: There was an internal error.
+ * - NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.
+ * - NO_INSTANCES: No instances were specified, or no instances can be found.
+ * - OVER_MAX_INSTANCES: The maximum number of instances was exceeded.
+ * - THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more
+ *   AWS services.
+ * - TIMEOUT: The deployment has timed out.
+ * - REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted
+ *   after the deployment is created, but before it is started.
+ *
+ * @see https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html
+ * @see https://docs.aws.amazon.com/codedeploy/latest/userguide
+ */
+final class ErrorCode
+{
+    public const AGENT_ISSUE = 'AGENT_ISSUE';
+    public const ALARM_ACTIVE = 'ALARM_ACTIVE';
+    public const APPLICATION_MISSING = 'APPLICATION_MISSING';
+    public const AUTOSCALING_VALIDATION_ERROR = 'AUTOSCALING_VALIDATION_ERROR';
+    public const AUTO_SCALING_CONFIGURATION = 'AUTO_SCALING_CONFIGURATION';
+    public const AUTO_SCALING_IAM_ROLE_PERMISSIONS = 'AUTO_SCALING_IAM_ROLE_PERMISSIONS';
+    public const CLOUDFORMATION_STACK_FAILURE = 'CLOUDFORMATION_STACK_FAILURE';
+    public const CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND = 'CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND';
+    public const CUSTOMER_APPLICATION_UNHEALTHY = 'CUSTOMER_APPLICATION_UNHEALTHY';
+    public const DEPLOYMENT_GROUP_MISSING = 'DEPLOYMENT_GROUP_MISSING';
+    public const ECS_UPDATE_ERROR = 'ECS_UPDATE_ERROR';
+    public const ELASTIC_LOAD_BALANCING_INVALID = 'ELASTIC_LOAD_BALANCING_INVALID';
+    public const ELB_INVALID_INSTANCE = 'ELB_INVALID_INSTANCE';
+    public const HEALTH_CONSTRAINTS = 'HEALTH_CONSTRAINTS';
+    public const HEALTH_CONSTRAINTS_INVALID = 'HEALTH_CONSTRAINTS_INVALID';
+    public const HOOK_EXECUTION_FAILURE = 'HOOK_EXECUTION_FAILURE';
+    public const IAM_ROLE_MISSING = 'IAM_ROLE_MISSING';
+    public const IAM_ROLE_PERMISSIONS = 'IAM_ROLE_PERMISSIONS';
+    public const INTERNAL_ERROR = 'INTERNAL_ERROR';
+    public const INVALID_ECS_SERVICE = 'INVALID_ECS_SERVICE';
+    public const INVALID_LAMBDA_CONFIGURATION = 'INVALID_LAMBDA_CONFIGURATION';
+    public const INVALID_LAMBDA_FUNCTION = 'INVALID_LAMBDA_FUNCTION';
+    public const INVALID_REVISION = 'INVALID_REVISION';
+    public const MANUAL_STOP = 'MANUAL_STOP';
+    public const MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION = 'MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION';
+    public const MISSING_ELB_INFORMATION = 'MISSING_ELB_INFORMATION';
+    public const MISSING_GITHUB_TOKEN = 'MISSING_GITHUB_TOKEN';
+    public const NO_EC2_SUBSCRIPTION = 'NO_EC2_SUBSCRIPTION';
+    public const NO_INSTANCES = 'NO_INSTANCES';
+    public const OVER_MAX_INSTANCES = 'OVER_MAX_INSTANCES';
+    public const RESOURCE_LIMIT_EXCEEDED = 'RESOURCE_LIMIT_EXCEEDED';
+    public const REVISION_MISSING = 'REVISION_MISSING';
+    public const THROTTLED = 'THROTTLED';
+    public const TIMEOUT = 'TIMEOUT';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::AGENT_ISSUE => true,
+            self::ALARM_ACTIVE => true,
+            self::APPLICATION_MISSING => true,
+            self::AUTOSCALING_VALIDATION_ERROR => true,
+            self::AUTO_SCALING_CONFIGURATION => true,
+            self::AUTO_SCALING_IAM_ROLE_PERMISSIONS => true,
+            self::CLOUDFORMATION_STACK_FAILURE => true,
+            self::CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND => true,
+            self::CUSTOMER_APPLICATION_UNHEALTHY => true,
+            self::DEPLOYMENT_GROUP_MISSING => true,
+            self::ECS_UPDATE_ERROR => true,
+            self::ELASTIC_LOAD_BALANCING_INVALID => true,
+            self::ELB_INVALID_INSTANCE => true,
+            self::HEALTH_CONSTRAINTS => true,
+            self::HEALTH_CONSTRAINTS_INVALID => true,
+            self::HOOK_EXECUTION_FAILURE => true,
+            self::IAM_ROLE_MISSING => true,
+            self::IAM_ROLE_PERMISSIONS => true,
+            self::INTERNAL_ERROR => true,
+            self::INVALID_ECS_SERVICE => true,
+            self::INVALID_LAMBDA_CONFIGURATION => true,
+            self::INVALID_LAMBDA_FUNCTION => true,
+            self::INVALID_REVISION => true,
+            self::MANUAL_STOP => true,
+            self::MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION => true,
+            self::MISSING_ELB_INFORMATION => true,
+            self::MISSING_GITHUB_TOKEN => true,
+            self::NO_EC2_SUBSCRIPTION => true,
+            self::NO_INSTANCES => true,
+            self::OVER_MAX_INSTANCES => true,
+            self::RESOURCE_LIMIT_EXCEEDED => true,
+            self::REVISION_MISSING => true,
+            self::THROTTLED => true,
+            self::TIMEOUT => true,
+        ][$value]);
+    }
+}

src/Enum/GreenFleetProvisioningAction.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * The method used to add instances to a replacement environment.
+ *
+ * - `DISCOVER_EXISTING`: Use instances that already exist or will be created manually.
+ * - `COPY_AUTO_SCALING_GROUP`: Use settings from a specified Auto Scaling group to define and create instances in a new
+ *   Auto Scaling group.
+ */
+final class GreenFleetProvisioningAction
+{
+    public const COPY_AUTO_SCALING_GROUP = 'COPY_AUTO_SCALING_GROUP';
+    public const DISCOVER_EXISTING = 'DISCOVER_EXISTING';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::COPY_AUTO_SCALING_GROUP => true,
+            self::DISCOVER_EXISTING => true,
+        ][$value]);
+    }
+}

src/Enum/InstanceAction.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace AsyncAws\CodeDeploy\Enum;
+
+/**
+ * The action to take on instances in the original environment after a successful blue/green deployment.
+ *
+ * - `TERMINATE`: Instances are terminated after a specified wait time.
+ * - `KEEP_ALIVE`: Instances are left running after they are deregistered from the load balancer and removed from the
+ *   deployment group.
+ */
+final class InstanceAction
+{
+    public const KEEP_ALIVE = 'KEEP_ALIVE';
+    public const TERMINATE = 'TERMINATE';
+
+    public static function exists(string $value): bool
+    {
+        return isset([
+            self::KEEP_ALIVE => true,
+            self::TERMINATE => true,
+        ][$value]);
+    }
+}