Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeAppBlocks

Retrieves a list that describes one or more app blocks.

Request Syntax


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

Arns

The ARNs of the app blocks.

Type: Array of strings

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Required: No

MaxResults

The maximum size of each page of results.

Type: Integer

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


{
   "AppBlocks": [ 
      { 
         "AppBlockErrors": [ 
            { 
               "ErrorCode": "string",
               "ErrorMessage": "string"
            }
         ],
         "Arn": "string",
         "CreatedTime": number,
         "Description": "string",
         "DisplayName": "string",
         "Name": "string",
         "PackagingType": "string",
         "PostSetupScriptDetails": { 
            "ExecutableParameters": "string",
            "ExecutablePath": "string",
            "ScriptS3Location": { 
               "S3Bucket": "string",
               "S3Key": "string"
            },
            "TimeoutInSeconds": number
         },
         "SetupScriptDetails": { 
            "ExecutableParameters": "string",
            "ExecutablePath": "string",
            "ScriptS3Location": { 
               "S3Bucket": "string",
               "S3Key": "string"
            },
            "TimeoutInSeconds": number
         },
         "SourceS3Location": { 
            "S3Bucket": "string",
            "S3Key": "string"
         },
         "State": "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.

AppBlocks

The app blocks in the list.

Type: Array of AppBlock 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