getField

AWS Cloud Control v1.57.0, Mar 9 26

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getField

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getField(args: GetFieldArgs, opts?: InvokeOptions): Promise<GetFieldResult>
function getFieldOutput(args: GetFieldOutputArgs, opts?: InvokeOptions): Output<GetFieldResult>

def get_field(field_arn: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetFieldResult
def get_field_output(field_arn: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetFieldResult]

func LookupField(ctx *Context, args *LookupFieldArgs, opts ...InvokeOption) (*LookupFieldResult, error)
func LookupFieldOutput(ctx *Context, args *LookupFieldOutputArgs, opts ...InvokeOption) LookupFieldResultOutput

> Note: This function is named LookupField in the Go SDK.

public static class GetField 
{
    public static Task<GetFieldResult> InvokeAsync(GetFieldArgs args, InvokeOptions? opts = null)
    public static Output<GetFieldResult> Invoke(GetFieldInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFieldResult> getField(GetFieldArgs args, InvokeOptions options)
public static Output<GetFieldResult> getField(GetFieldArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:cases:getField
  arguments:
    # arguments dictionary

The following arguments are supported:

FieldArn string: The Amazon Resource Name (ARN) of the field.

FieldArn string: The Amazon Resource Name (ARN) of the field.

fieldArn String: The Amazon Resource Name (ARN) of the field.

fieldArn string: The Amazon Resource Name (ARN) of the field.

field_arn str: The Amazon Resource Name (ARN) of the field.

fieldArn String: The Amazon Resource Name (ARN) of the field.

getField Result

The following output properties are available:

Attributes Pulumi.AwsNative.Cases.Outputs.FieldAttributes: Field-type specific attributes that control rendering and validation behavior
CreatedTime string: The time at which the field was created.
Description 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.
FieldArn string: The Amazon Resource Name (ARN) of the field.
FieldId string: The unique identifier of a field.
LastModifiedTime string: The time at which the field was created or last modified.
Name 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').
Namespace Pulumi.AwsNative.Cases.FieldNamespace: 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.
Tags List<Pulumi.AwsNative.Outputs.Tag>: An array of key-value pairs to apply to this resource.

Attributes FieldAttributes: Field-type specific attributes that control rendering and validation behavior
CreatedTime string: The time at which the field was created.
Description 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.
FieldArn string: The Amazon Resource Name (ARN) of the field.
FieldId string: The unique identifier of a field.
LastModifiedTime string: The time at which the field was created or last modified.
Name 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').
Namespace FieldNamespace: 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.
Tags Tag: An array of key-value pairs to apply to this resource.

attributes FieldAttributes: Field-type specific attributes that control rendering and validation behavior
createdTime String: The time at which the field was created.
description 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.
fieldArn String: The Amazon Resource Name (ARN) of the field.
fieldId String: The unique identifier of a field.
lastModifiedTime String: The time at which the field was created or last modified.
name 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').
namespace FieldNamespace: 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.
tags List<Tag>: An array of key-value pairs to apply to this resource.

attributes FieldAttributes: Field-type specific attributes that control rendering and validation behavior
createdTime string: The time at which the field was created.
description 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.
fieldArn string: The Amazon Resource Name (ARN) of the field.
fieldId string: The unique identifier of a field.
lastModifiedTime string: The time at which the field was created or last modified.
name 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').
namespace FieldNamespace: 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.
tags Tag[]: An array of key-value pairs to apply to this resource.

attributes FieldAttributes: Field-type specific attributes that control rendering and validation behavior
created_time str: The time at which the field was created.
description str: 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.
field_arn str: The Amazon Resource Name (ARN) of the field.
field_id str: The unique identifier of a field.
last_modified_time str: The time at which the field was created or last modified.
name str: 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').
namespace FieldNamespace: 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.
tags Sequence[root_Tag]: An array of key-value pairs to apply to this resource.

attributes Property Map: Field-type specific attributes that control rendering and validation behavior
createdTime String: The time at which the field was created.
description 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.
fieldArn String: The Amazon Resource Name (ARN) of the field.
fieldId String: The unique identifier of a field.
lastModifiedTime String: The time at which the field was created or last modified.
name 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').
namespace "System" | "Custom": 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.
tags List<Property Map>: An array of key-value pairs to apply to this resource.