register_on_premises_instance

CodeDeploy.Client.register_on_premises_instance(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.register_on_premises_instance(
    instanceName='string',
    iamSessionArn='string',
    iamUserArn='string'
)

Parameters

• instanceName (string) --

  [REQUIRED]

  The name of the on-premises instance to register.

• iamSessionArn (string) -- The ARN of the IAM session to associate with the on-premises instance.
• iamUserArn (string) -- The ARN of the IAM user to associate with the on-premises instance.

Returns

None

Exceptions

• CodeDeploy.Client.exceptions.InstanceNameAlreadyRegisteredException
• CodeDeploy.Client.exceptions.IamArnRequiredException
• CodeDeploy.Client.exceptions.IamSessionArnAlreadyRegisteredException
• CodeDeploy.Client.exceptions.IamUserArnAlreadyRegisteredException
• CodeDeploy.Client.exceptions.InstanceNameRequiredException
• CodeDeploy.Client.exceptions.IamUserArnRequiredException
• CodeDeploy.Client.exceptions.InvalidInstanceNameException
• CodeDeploy.Client.exceptions.InvalidIamSessionArnException
• CodeDeploy.Client.exceptions.InvalidIamUserArnException
• CodeDeploy.Client.exceptions.MultipleIamArnsProvidedException