- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListFieldsCommand
Lists all fields in a Cases domain.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectCasesClient, ListFieldsCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
// const { ConnectCasesClient, ListFieldsCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
const client = new ConnectCasesClient(config);
const input = { // ListFieldsRequest
domainId: "STRING_VALUE", // required
maxResults: Number("int"),
nextToken: "STRING_VALUE",
};
const command = new ListFieldsCommand(input);
const response = await client.send(command);
// { // ListFieldsResponse
// fields: [ // FieldSummaryList // required
// { // FieldSummary
// fieldId: "STRING_VALUE", // required
// fieldArn: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// type: "STRING_VALUE", // required
// namespace: "STRING_VALUE", // required
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListFieldsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainId Required | string | undefined | The unique identifier of the Cases domain. |
maxResults | number | undefined | The maximum number of results to return per page. |
nextToken | string | undefined | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
ListFieldsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
fields Required | FieldSummary[] | undefined | List of detailed field information. |
nextToken | string | undefined | The token for the next set of results. This is null if there are no more results to return. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
InternalServerException | server | We couldn't process your request because of an issue with the server. Try again later. |
ResourceNotFoundException | client | We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again. |
ThrottlingException | client | The rate has been exceeded for this API. Please try again after a few minutes. |
ValidationException | client | The request isn't valid. Check the syntax and try again. |
ConnectCasesServiceException | Base exception class for all service exceptions from ConnectCases service. |