DescribeAppBlockBuilders - Amazon AppStream 2.0

DescribeAppBlockBuilders

Retrieves a list that describes one or more app block builders.

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. The maximum value is 25.

Type: Integer

Required: No

Names

The names of the app block builders.

Type: Array of strings

Length Constraints: Minimum length of 1.

Required: No

NextToken

The pagination token used to retrieve the next page of results for this operation.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "AppBlockBuilders": [ { "AccessEndpoints": [ { "EndpointType": "string", "VpceId": "string" } ], "AppBlockBuilderErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "ErrorTimestamp": number } ], "Arn": "string", "CreatedTime": number, "Description": "string", "DisplayName": "string", "EnableDefaultInternetAccess": boolean, "IamRoleArn": "string", "InstanceType": "string", "Name": "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.

AppBlockBuilders

The list that describes one or more app block builders.

Type: Array of AppBlockBuilder objects

NextToken

The pagination token used to retrieve the next page of results for this operation.

Type: String

Length Constraints: Minimum length of 1.

Errors

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

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: