1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. comprehend
  5. getDocumentClassifier

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.comprehend.getDocumentClassifier

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Document Classifier enables training document classifier models.

Using getDocumentClassifier

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 getDocumentClassifier(args: GetDocumentClassifierArgs, opts?: InvokeOptions): Promise<GetDocumentClassifierResult>
function getDocumentClassifierOutput(args: GetDocumentClassifierOutputArgs, opts?: InvokeOptions): Output<GetDocumentClassifierResult>
Copy
def get_document_classifier(arn: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetDocumentClassifierResult
def get_document_classifier_output(arn: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetDocumentClassifierResult]
Copy
func LookupDocumentClassifier(ctx *Context, args *LookupDocumentClassifierArgs, opts ...InvokeOption) (*LookupDocumentClassifierResult, error)
func LookupDocumentClassifierOutput(ctx *Context, args *LookupDocumentClassifierOutputArgs, opts ...InvokeOption) LookupDocumentClassifierResultOutput
Copy

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

public static class GetDocumentClassifier 
{
    public static Task<GetDocumentClassifierResult> InvokeAsync(GetDocumentClassifierArgs args, InvokeOptions? opts = null)
    public static Output<GetDocumentClassifierResult> Invoke(GetDocumentClassifierInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDocumentClassifierResult> getDocumentClassifier(GetDocumentClassifierArgs args, InvokeOptions options)
public static Output<GetDocumentClassifierResult> getDocumentClassifier(GetDocumentClassifierArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:comprehend:getDocumentClassifier
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn This property is required. string
The Amazon Resource Name (ARN) of the document classifier.
Arn This property is required. string
The Amazon Resource Name (ARN) of the document classifier.
arn This property is required. String
The Amazon Resource Name (ARN) of the document classifier.
arn This property is required. string
The Amazon Resource Name (ARN) of the document classifier.
arn This property is required. str
The Amazon Resource Name (ARN) of the document classifier.
arn This property is required. String
The Amazon Resource Name (ARN) of the document classifier.

getDocumentClassifier Result

The following output properties are available:

Arn string
The Amazon Resource Name (ARN) of the document classifier.
ModelPolicy string

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Tags List<Pulumi.AwsNative.Outputs.Tag>
Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
Arn string
The Amazon Resource Name (ARN) of the document classifier.
ModelPolicy string

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Tags Tag
Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
arn String
The Amazon Resource Name (ARN) of the document classifier.
modelPolicy String

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

tags List<Tag>
Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
arn string
The Amazon Resource Name (ARN) of the document classifier.
modelPolicy string

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

tags Tag[]
Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
arn str
The Amazon Resource Name (ARN) of the document classifier.
model_policy str

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

tags Sequence[root_Tag]
Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
arn String
The Amazon Resource Name (ARN) of the document classifier.
modelPolicy String

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

tags List<Property Map>
Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi