# 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](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_DescribeImageBuilders_RequestSyntax) **   <a name="WorkSpacesApplications-DescribeImageBuilders-request-MaxResults"></a>
The maximum size of each page of results.  
Type: Integer  
Required: No

 ** [Names](#API_DescribeImageBuilders_RequestSyntax) **   <a name="WorkSpacesApplications-DescribeImageBuilders-request-Names"></a>
The names of the image builders to describe.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Required: No

 ** [NextToken](#API_DescribeImageBuilders_RequestSyntax) **   <a name="WorkSpacesApplications-DescribeImageBuilders-request-NextToken"></a>
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",
         "DisableIMDSV1": boolean,
         "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",
            "EniIpv6Addresses": [ "string" ],
            "EniPrivateIpAddress": "string"
         },
         "Platform": "string",
         "RootVolumeConfig": { 
            "VolumeSizeInGb": number
         },
         "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](#API_DescribeImageBuilders_ResponseSyntax) **   <a name="WorkSpacesApplications-DescribeImageBuilders-response-ImageBuilders"></a>
Information about the image builders.  
Type: Array of [ImageBuilder](API_ImageBuilder.md) objects

 ** [NextToken](#API_DescribeImageBuilders_ResponseSyntax) **   <a name="WorkSpacesApplications-DescribeImageBuilders-response-NextToken"></a>
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 Error Types](CommonErrors.md).

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The error message in the exception.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appstream-2016-12-01/DescribeImageBuilders) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appstream-2016-12-01/DescribeImageBuilders)