AWS CodeDeploy

2016/12/29 - AWS CodeDeploy - 3 updated api methods

Changes  CodeDeploy supports IAM Session Arns in addition to IAM User Arns for on premise host authentication.

BatchGetOnPremisesInstances (updated) Link ¶
Changes (response) 
{'instanceInfos': {'iamSessionArn': 'string'}}

Gets information about one or more on-premises instances.

See also: AWS API Documentation

Request Syntax

client.batch_get_on_premises_instances(
    instanceNames=[
        'string',
    ]
)
type instanceNames

list

param instanceNames

The names of the on-premises instances about which to get information.

  • (string) --

rtype

dict

returns

Response Syntax

{
    'instanceInfos': [
        {
            'instanceName': 'string',
            'iamSessionArn': 'string',
            'iamUserArn': 'string',
            'instanceArn': 'string',
            'registerTime': datetime(2015, 1, 1),
            'deregisterTime': datetime(2015, 1, 1),
            'tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    Represents the output of a batch get on-premises instances operation.

    • instanceInfos (list) --

      Information about the on-premises instances.

      • (dict) --

        Information about an on-premises instance.

        • instanceName (string) --

          The name of the on-premises instance.

        • iamSessionArn (string) --

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

        • iamUserArn (string) --

          The IAM user ARN associated with the on-premises instance.

        • instanceArn (string) --

          The ARN of the on-premises instance.

        • registerTime (datetime) --

          The time at which the on-premises instance was registered.

        • deregisterTime (datetime) --

          If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

        • tags (list) --

          The tags currently associated with the on-premises instance.

          • (dict) --

            Information about a tag.

            • Key (string) --

              The tag's key.

            • Value (string) --

              The tag's value.

GetOnPremisesInstance (updated) Link ¶
Changes (response) 
{'instanceInfo': {'iamSessionArn': 'string'}}

Gets information about an on-premises instance.

See also: AWS API Documentation

Request Syntax

client.get_on_premises_instance(
    instanceName='string'
)
type instanceName

string

param instanceName

[REQUIRED]

The name of the on-premises instance about which to get information.

rtype

dict

returns

Response Syntax

{
    'instanceInfo': {
        'instanceName': 'string',
        'iamSessionArn': 'string',
        'iamUserArn': 'string',
        'instanceArn': 'string',
        'registerTime': datetime(2015, 1, 1),
        'deregisterTime': datetime(2015, 1, 1),
        'tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    Represents the output of a get on-premises instance operation.

    • instanceInfo (dict) --

      Information about the on-premises instance.

      • instanceName (string) --

        The name of the on-premises instance.

      • iamSessionArn (string) --

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

      • iamUserArn (string) --

        The IAM user ARN associated with the on-premises instance.

      • instanceArn (string) --

        The ARN of the on-premises instance.

      • registerTime (datetime) --

        The time at which the on-premises instance was registered.

      • deregisterTime (datetime) --

        If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

      • tags (list) --

        The tags currently associated with the on-premises instance.

        • (dict) --

          Information about a tag.

          • Key (string) --

            The tag's key.

          • Value (string) --

            The tag's value.

RegisterOnPremisesInstance (updated) Link ¶
Changes (request) 
{'iamSessionArn': 'string'}

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

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

string

param instanceName

[REQUIRED]

The name of the on-premises instance to register.

type iamSessionArn

string

param iamSessionArn

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

type iamUserArn

string

param iamUserArn

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

returns

None