Menu
AWS CodeDeploy
API Reference (API Version 2014-10-06)

RegisterOnPremisesInstance

Registers an on-premises instance.

Note

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

Request Syntax

Copy
{ "iamSessionArn": "string", "iamUserArn": "string", "instanceName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

iamSessionArn

The ARN of the IAM session to associate with the on-premises instance.

Type: String

Required: No

iamUserArn

The ARN of the IAM user to associate with the on-premises instance.

Type: String

Required: No

instanceName

The name of the on-premises instance to register.

Type: String

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

IamArnRequiredException

No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.

HTTP Status Code: 400

IamSessionArnAlreadyRegisteredException

The request included an IAM session ARN that has already been used to register a different instance.

HTTP Status Code: 400

IamUserArnAlreadyRegisteredException

The specified IAM user ARN is already registered with an on-premises instance.

HTTP Status Code: 400

IamUserArnRequiredException

An IAM user ARN was not specified.

HTTP Status Code: 400

InstanceNameAlreadyRegisteredException

The specified on-premises instance name is already registered.

HTTP Status Code: 400

InstanceNameRequiredException

An on-premises instance name was not specified.

HTTP Status Code: 400

InvalidIamSessionArnException

The IAM session ARN was specified in an invalid format.

HTTP Status Code: 400

InvalidIamUserArnException

The IAM user ARN was specified in an invalid format.

HTTP Status Code: 400

InvalidInstanceNameException

The specified on-premises instance name was specified in an invalid format.

HTTP Status Code: 400

MultipleIamArnsProvidedException

Both an IAM user ARN and an IAM session ARN were included in the request. Use only one ARN type.

HTTP Status Code: 400

Example

Sample Request

Copy
POST / HTTP/1.1 Host: codedeploy.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 257 X-Amz-Target: CodeDeploy_20141006.RegisterOnPremisesInstance X-Amz-Date: 20160707T024712Z User-Agent: aws-cli/1.10.6 Python/2.7.9 Windows/7 botocore/1.3.28 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20160707/us-east-1/codedeploy/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "IamUserArn": "arn:aws:iam::444455556666:user/janedoe", "instanceName": "grp-o-inst-5" }

Sample Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: 4ccc9cf0-88c9-11e5-8ce3-2704437d0309 Content-Type: application/x-amz-json-1.1 Content-Length: 0

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: