Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.comprehend.getDocumentClassifier
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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>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]func LookupDocumentClassifier(ctx *Context, args *LookupDocumentClassifierArgs, opts ...InvokeOption) (*LookupDocumentClassifierResult, error)
func LookupDocumentClassifierOutput(ctx *Context, args *LookupDocumentClassifierOutputArgs, opts ...InvokeOption) LookupDocumentClassifierResultOutput> 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)
}public static CompletableFuture<GetDocumentClassifierResult> getDocumentClassifier(GetDocumentClassifierArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:comprehend:getDocumentClassifier
arguments:
# arguments dictionaryThe following arguments are supported:
- Arn string
- The Amazon Resource Name (ARN) of the document classifier.
- Arn string
- The Amazon Resource Name (ARN) of the document classifier.
- arn String
- The Amazon Resource Name (ARN) of the document classifier.
- arn string
- The Amazon Resource Name (ARN) of the document classifier.
- arn str
- The Amazon Resource Name (ARN) of the document classifier.
- arn 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.
- Model
Policy 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"]}'-
List<Pulumi.
Aws Native. 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.
- Model
Policy 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"]}'- 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.
- model
Policy 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"]}'- 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.
- model
Policy 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"]}'- 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"]}'- 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.
- model
Policy 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"]}'- 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.