CodeDeploy / Client / batch_get_on_premises_instances

batch_get_on_premises_instances#

CodeDeploy.Client.batch_get_on_premises_instances(**kwargs)#

Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_on_premises_instances(
    instanceNames=[
        'string',
    ]
)
Parameters:

instanceNames (list) –

[REQUIRED]

The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.

  • (string) –

Return type:

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 BatchGetOnPremisesInstances 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.

Exceptions

  • CodeDeploy.Client.exceptions.InstanceNameRequiredException

  • CodeDeploy.Client.exceptions.InvalidInstanceNameException

  • CodeDeploy.Client.exceptions.BatchLimitExceededException