Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeImageBuilders

Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.

Request Syntax


{
   "MaxResults": number,
   "Names": [ "string" ],
   "NextToken": "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.

MaxResults

The maximum size of each page of results.

Type: Integer

Required: No

Names

The names of the image builders to describe.

Type: Array of strings

Length Constraints: Minimum length of 1.

Required: No

NextToken

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


{
   "ImageBuilders": [ 
      { 
         "AccessEndpoints": [ 
            { 
               "EndpointType": "string",
               "VpceId": "string"
            }
         ],
         "AppstreamAgentVersion": "string",
         "Arn": "string",
         "CreatedTime": number,
         "Description": "string",
         "DisplayName": "string",
         "DomainJoinInfo": { 
            "DirectoryName": "string",
            "OrganizationalUnitDistinguishedName": "string"
         },
         "EnableDefaultInternetAccess": boolean,
         "IamRoleArn": "string",
         "ImageArn": "string",
         "ImageBuilderErrors": [ 
            { 
               "ErrorCode": "string",
               "ErrorMessage": "string",
               "ErrorTimestamp": number
            }
         ],
         "InstanceType": "string",
         "LatestAppstreamAgentVersion": "string",
         "Name": "string",
         "NetworkAccessConfiguration": { 
            "EniId": "string",
            "EniPrivateIpAddress": "string"
         },
         "Platform": "string",
         "State": "string",
         "StateChangeReason": { 
            "Code": "string",
            "Message": "string"
         },
         "VpcConfig": { 
            "SecurityGroupIds": [ "string" ],
            "SubnetIds": [ "string" ]
         }
      }
   ],
   "NextToken": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

ImageBuilders

Information about the image builders.

Type: Array of ImageBuilder objects

NextToken

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Type: String

Length Constraints: Minimum length of 1.

Errors

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400