Batch Get Deployments

codedeploy_batch_get_deployments

R Documentation

Gets information about one or more deployments

Description

Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.

Usage

codedeploy_batch_get_deployments(deploymentIds)

Arguments

deploymentIds

[required] A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.

Value

A list with the following syntax:

list(
  deploymentsInfo = list(
    list(
      applicationName = "string",
      deploymentGroupName = "string",
      deploymentConfigName = "string",
      deploymentId = "string",
      previousRevision = list(
        revisionType = "S3"|"GitHub"|"String"|"AppSpecContent",
        s3Location = list(
          bucket = "string",
          key = "string",
          bundleType = "tar"|"tgz"|"zip"|"YAML"|"JSON",
          version = "string",
          eTag = "string"
        ),
        gitHubLocation = list(
          repository = "string",
          commitId = "string"
        ),
        string = list(
          content = "string",
          sha256 = "string"
        ),
        appSpecContent = list(
          content = "string",
          sha256 = "string"
        )
      ),
      revision = list(
        revisionType = "S3"|"GitHub"|"String"|"AppSpecContent",
        s3Location = list(
          bucket = "string",
          key = "string",
          bundleType = "tar"|"tgz"|"zip"|"YAML"|"JSON",
          version = "string",
          eTag = "string"
        ),
        gitHubLocation = list(
          repository = "string",
          commitId = "string"
        ),
        string = list(
          content = "string",
          sha256 = "string"
        ),
        appSpecContent = list(
          content = "string",
          sha256 = "string"
        )
      ),
      status = "Created"|"Queued"|"InProgress"|"Baking"|"Succeeded"|"Failed"|"Stopped"|"Ready",
      errorInformation = list(
        code = "AGENT_ISSUE"|"ALARM_ACTIVE"|"APPLICATION_MISSING"|"AUTOSCALING_VALIDATION_ERROR"|"AUTO_SCALING_CONFIGURATION"|"AUTO_SCALING_IAM_ROLE_PERMISSIONS"|"CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND"|"CUSTOMER_APPLICATION_UNHEALTHY"|"DEPLOYMENT_GROUP_MISSING"|"ECS_UPDATE_ERROR"|"ELASTIC_LOAD_BALANCING_INVALID"|"ELB_INVALID_INSTANCE"|"HEALTH_CONSTRAINTS"|"HEALTH_CONSTRAINTS_INVALID"|"HOOK_EXECUTION_FAILURE"|"IAM_ROLE_MISSING"|"IAM_ROLE_PERMISSIONS"|"INTERNAL_ERROR"|"INVALID_ECS_SERVICE"|"INVALID_LAMBDA_CONFIGURATION"|"INVALID_LAMBDA_FUNCTION"|"INVALID_REVISION"|"MANUAL_STOP"|"MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION"|"MISSING_ELB_INFORMATION"|"MISSING_GITHUB_TOKEN"|"NO_EC2_SUBSCRIPTION"|"NO_INSTANCES"|"OVER_MAX_INSTANCES"|"RESOURCE_LIMIT_EXCEEDED"|"REVISION_MISSING"|"THROTTLED"|"TIMEOUT"|"CLOUDFORMATION_STACK_FAILURE",
        message = "string"
      ),
      createTime = as.POSIXct(
        "2015-01-01"
      ),
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      completeTime = as.POSIXct(
        "2015-01-01"
      ),
      deploymentOverview = list(
        Pending = 123,
        InProgress = 123,
        Succeeded = 123,
        Failed = 123,
        Skipped = 123,
        Ready = 123
      ),
      description = "string",
      creator = "user"|"autoscaling"|"codeDeployRollback"|"CodeDeploy"|"CodeDeployAutoUpdate"|"CloudFormation"|"CloudFormationRollback"|"autoscalingTermination",
      ignoreApplicationStopFailures = TRUE|FALSE,
      autoRollbackConfiguration = list(
        enabled = TRUE|FALSE,
        events = list(
          "DEPLOYMENT_FAILURE"|"DEPLOYMENT_STOP_ON_ALARM"|"DEPLOYMENT_STOP_ON_REQUEST"
        )
      ),
      updateOutdatedInstancesOnly = TRUE|FALSE,
      rollbackInfo = list(
        rollbackDeploymentId = "string",
        rollbackTriggeringDeploymentId = "string",
        rollbackMessage = "string"
      ),
      deploymentStyle = list(
        deploymentType = "IN_PLACE"|"BLUE_GREEN",
        deploymentOption = "WITH_TRAFFIC_CONTROL"|"WITHOUT_TRAFFIC_CONTROL"
      ),
      targetInstances = list(
        tagFilters = list(
          list(
            Key = "string",
            Value = "string",
            Type = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"
          )
        ),
        autoScalingGroups = list(
          "string"
        ),
        ec2TagSet = list(
          ec2TagSetList = list(
            list(
              list(
                Key = "string",
                Value = "string",
                Type = "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"
              )
            )
          )
        )
      ),
      instanceTerminationWaitTimeStarted = TRUE|FALSE,
      blueGreenDeploymentConfiguration = list(
        terminateBlueInstancesOnDeploymentSuccess = list(
          action = "TERMINATE"|"KEEP_ALIVE",
          terminationWaitTimeInMinutes = 123
        ),
        deploymentReadyOption = list(
          actionOnTimeout = "CONTINUE_DEPLOYMENT"|"STOP_DEPLOYMENT",
          waitTimeInMinutes = 123
        ),
        greenFleetProvisioningOption = list(
          action = "DISCOVER_EXISTING"|"COPY_AUTO_SCALING_GROUP"
        )
      ),
      loadBalancerInfo = list(
        elbInfoList = list(
          list(
            name = "string"
          )
        ),
        targetGroupInfoList = list(
          list(
            name = "string"
          )
        ),
        targetGroupPairInfoList = list(
          list(
            targetGroups = list(
              list(
                name = "string"
              )
            ),
            prodTrafficRoute = list(
              listenerArns = list(
                "string"
              )
            ),
            testTrafficRoute = list(
              listenerArns = list(
                "string"
              )
            )
          )
        )
      ),
      additionalDeploymentStatusInfo = "string",
      fileExistsBehavior = "DISALLOW"|"OVERWRITE"|"RETAIN",
      deploymentStatusMessages = list(
        "string"
      ),
      computePlatform = "Server"|"Lambda"|"ECS",
      externalId = "string",
      relatedDeployments = list(
        autoUpdateOutdatedInstancesRootDeploymentId = "string",
        autoUpdateOutdatedInstancesDeploymentIds = list(
          "string"
        )
      ),
      overrideAlarmConfiguration = list(
        enabled = TRUE|FALSE,
        ignorePollAlarmFailure = TRUE|FALSE,
        alarms = list(
          list(
            name = "string"
          )
        )
      )
    )
  )
)

Request syntax

svc$batch_get_deployments(
  deploymentIds = list(
    "string"
  )
)