@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
58 lines (57 loc) • 2.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* A field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
*/
export declare function getField(args: GetFieldArgs, opts?: pulumi.InvokeOptions): Promise<GetFieldResult>;
export interface GetFieldArgs {
/**
* The Amazon Resource Name (ARN) of the field.
*/
fieldArn: string;
}
export interface GetFieldResult {
/**
* The time at which the field was created.
*/
readonly createdTime?: string;
/**
* A description explaining the purpose and usage of this field in cases. Helps agents and administrators understand what information should be captured in this field.
*/
readonly description?: string;
/**
* The Amazon Resource Name (ARN) of the field.
*/
readonly fieldArn?: string;
/**
* The unique identifier of a field.
*/
readonly fieldId?: string;
/**
* The time at which the field was created or last modified.
*/
readonly lastModifiedTime?: string;
/**
* The display name of the field as it appears to agents in the case interface. Should be descriptive and user-friendly (e.g., 'Customer Priority Level', 'Issue Category').
*/
readonly name?: string;
/**
* Indicates whether this is a System field (predefined by AWS) or a Custom field (created by your organization). System fields cannot be modified or deleted.
*/
readonly namespace?: enums.cases.FieldNamespace;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags?: outputs.Tag[];
}
/**
* A field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
*/
export declare function getFieldOutput(args: GetFieldOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFieldResult>;
export interface GetFieldOutputArgs {
/**
* The Amazon Resource Name (ARN) of the field.
*/
fieldArn: pulumi.Input<string>;
}