BatchGetUserAccessTasksCommand

Suggest an Edit

Gets user access details in a batch request.

This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppFabricClient, BatchGetUserAccessTasksCommand } from "@aws-sdk/client-appfabric"; // ES Modules import
// const { AppFabricClient, BatchGetUserAccessTasksCommand } = require("@aws-sdk/client-appfabric"); // CommonJS import
const client = new AppFabricClient(config);
const input = { // BatchGetUserAccessTasksRequest
  appBundleIdentifier: "STRING_VALUE", // required
  taskIdList: [ // TaskIdList // required
    "STRING_VALUE",
  ],
};
const command = new BatchGetUserAccessTasksCommand(input);
const response = await client.send(command);
// { // BatchGetUserAccessTasksResponse
//   userAccessResultsList: [ // UserAccessResultsList
//     { // UserAccessResultItem
//       app: "STRING_VALUE",
//       tenantId: "STRING_VALUE",
//       tenantDisplayName: "STRING_VALUE",
//       taskId: "STRING_VALUE",
//       resultStatus: "IN_PROGRESS" || "COMPLETED" || "FAILED" || "EXPIRED",
//       email: "STRING_VALUE",
//       userId: "STRING_VALUE",
//       userFullName: "STRING_VALUE",
//       userFirstName: "STRING_VALUE",
//       userLastName: "STRING_VALUE",
//       userStatus: "STRING_VALUE",
//       taskError: { // TaskError
//         errorCode: "STRING_VALUE",
//         errorMessage: "STRING_VALUE",
//       },
//     },
//   ],
// };

BatchGetUserAccessTasksCommand Input

See BatchGetUserAccessTasksCommandInput for more details

Parameter
Type
Description
appBundleIdentifier
Required
string | undefined

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

taskIdList
Required
string[] | undefined

The tasks IDs to use for the request.

BatchGetUserAccessTasksCommand Output

See BatchGetUserAccessTasksCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
userAccessResultsList
UserAccessResultItem[] | undefined

Contains a list of user access results.

Throws

Name
Fault
Details
AccessDeniedException
client

You are not authorized to perform this operation.

InternalServerException
server

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException
client

The specified resource does not exist.

ThrottlingException
client

The request rate exceeds the limit.

ValidationException
client

The request has invalid or missing parameters.

AppFabricServiceException
Base exception class for all service exceptions from AppFabric service.