{ "info": { "_postman_id": "cf92d2e0-5bf7-46d8-ac44-6db67687eecf", "name": "AWS CodeDeploy Applications #X Amz Target=CodeDeploy 20141006.RegisterOnPremisesInstance API", "description": "

CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.

CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

CodeDeploy Components

Use the information in this guide to help you work with the following CodeDeploy components:

This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.

CodeDeploy Information Resources

\n\nContact Support:\n Name: Mike Ralphson\n Email: mike.ralphson@gmail.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T10:13:13.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "lastUpdatedBy": "35240", "uid": "35240-cf92d2e0-5bf7-46d8-ac44-6db67687eecf" }, "item": [ { "name": "#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "item": [ { "name": "Amazon CodeDeploy Register on Premises Instance", "id": "9f7393e6-cbb7-49c7-908e-ac2218b7e72b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" }, "description": "

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

" }, "response": [ { "id": "bc9ead6a-163c-46dd-9748-e09b11f2d353", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-bc9ead6a-163c-46dd-9748-e09b11f2d353" }, { "id": "339cefd0-72f8-4c31-bbe1-5ed9c27fa8ac", "name": "InstanceNameAlreadyRegisteredException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-339cefd0-72f8-4c31-bbe1-5ed9c27fa8ac" }, { "id": "03e18baa-873a-4ded-a002-eeae8a159298", "name": "IamArnRequiredException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-03e18baa-873a-4ded-a002-eeae8a159298" }, { "id": "4232152d-86e2-46d4-a535-b25801923e74", "name": "IamSessionArnAlreadyRegisteredException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-4232152d-86e2-46d4-a535-b25801923e74" }, { "id": "69f163b8-9f05-4f46-adf2-4c2b6aba7895", "name": "IamUserArnAlreadyRegisteredException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-69f163b8-9f05-4f46-adf2-4c2b6aba7895" }, { "id": "c62703e6-175b-4bf9-a8f5-38fb7e52a30a", "name": "InstanceNameRequiredException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-c62703e6-175b-4bf9-a8f5-38fb7e52a30a" }, { "id": "2d5630b4-41bd-488c-9842-084c2229f931", "name": "IamUserArnRequiredException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-2d5630b4-41bd-488c-9842-084c2229f931" }, { "id": "ebfb561c-0980-48c4-b618-75abb845b01d", "name": "InvalidInstanceNameException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-ebfb561c-0980-48c4-b618-75abb845b01d" }, { "id": "3a0e2baf-174c-4a14-8cd9-6c4154d641e8", "name": "InvalidIamSessionArnException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-3a0e2baf-174c-4a14-8cd9-6c4154d641e8" }, { "id": "76ce3ff6-8ea1-4e0d-9d9e-d7a6e5ffe732", "name": "InvalidIamUserArnException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-76ce3ff6-8ea1-4e0d-9d9e-d7a6e5ffe732" }, { "id": "988c42bc-2826-4b1b-b09a-babffa6d4cd3", "name": "MultipleIamArnsProvidedException", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Amz-Target", "value": "CodeDeploy_20141006.RegisterOnPremisesInstance" }, { "key": "X-Amz-Content-Sha256", "value": "" }, { "key": "X-Amz-Date", "value": "" }, { "key": "X-Amz-Algorithm", "value": "" }, { "key": "X-Amz-Credential", "value": "" }, { "key": "X-Amz-Security-Token", "value": "" }, { "key": "X-Amz-Signature", "value": "" }, { "key": "X-Amz-SignedHeaders", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"instanceName\": \"\",\n \"iamSessionArn\": \"\",\n \"iamUserArn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance", "host": [ "{{baseUrl}}" ], "path": [ "" ], "hash": "X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance" } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-988c42bc-2826-4b1b-b09a-babffa6d4cd3" } ], "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-9f7393e6-cbb7-49c7-908e-ac2218b7e72b" } ], "id": "c400f0c3-380e-4ad5-83f8-9588522533e8", "createdAt": "2026-07-28T10:13:14.000Z", "updatedAt": "2026-07-28T10:13:14.000Z", "uid": "35240-c400f0c3-380e-4ad5-83f8-9588522533e8" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "region", "value": "us-east-1" }, { "key": "baseUrl", "value": "http://codedeploy.{{region}}.amazonaws.com" } ] }