1. Packages
  2. AWS Classic
  3. API Docs
  4. connect
  5. getVocabulary

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.connect.getVocabulary

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Provides details about a specific Amazon Connect Vocabulary.

    Example Usage

    By name

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.connect.getVocabulary({
        instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        name: "Example",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.connect.get_vocabulary(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
        name="Example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := connect.LookupVocabulary(ctx, &connect.LookupVocabularyArgs{
    			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    			Name:       pulumi.StringRef("Example"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Connect.GetVocabulary.Invoke(new()
        {
            InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
            Name = "Example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.connect.ConnectFunctions;
    import com.pulumi.aws.connect.inputs.GetVocabularyArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = ConnectFunctions.getVocabulary(GetVocabularyArgs.builder()
                .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
                .name("Example")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:connect:getVocabulary
          Arguments:
            instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
            name: Example
    

    By vocabulary_id

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.connect.getVocabulary({
        instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        vocabularyId: "cccccccc-bbbb-cccc-dddd-111111111111",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.connect.get_vocabulary(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
        vocabulary_id="cccccccc-bbbb-cccc-dddd-111111111111")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := connect.LookupVocabulary(ctx, &connect.LookupVocabularyArgs{
    			InstanceId:   "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    			VocabularyId: pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Connect.GetVocabulary.Invoke(new()
        {
            InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
            VocabularyId = "cccccccc-bbbb-cccc-dddd-111111111111",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.connect.ConnectFunctions;
    import com.pulumi.aws.connect.inputs.GetVocabularyArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = ConnectFunctions.getVocabulary(GetVocabularyArgs.builder()
                .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
                .vocabularyId("cccccccc-bbbb-cccc-dddd-111111111111")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:connect:getVocabulary
          Arguments:
            instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
            vocabularyId: cccccccc-bbbb-cccc-dddd-111111111111
    

    Using getVocabulary

    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 getVocabulary(args: GetVocabularyArgs, opts?: InvokeOptions): Promise<GetVocabularyResult>
    function getVocabularyOutput(args: GetVocabularyOutputArgs, opts?: InvokeOptions): Output<GetVocabularyResult>
    def get_vocabulary(instance_id: Optional[str] = None,
                       name: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       vocabulary_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetVocabularyResult
    def get_vocabulary_output(instance_id: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                       vocabulary_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetVocabularyResult]
    func LookupVocabulary(ctx *Context, args *LookupVocabularyArgs, opts ...InvokeOption) (*LookupVocabularyResult, error)
    func LookupVocabularyOutput(ctx *Context, args *LookupVocabularyOutputArgs, opts ...InvokeOption) LookupVocabularyResultOutput

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

    public static class GetVocabulary 
    {
        public static Task<GetVocabularyResult> InvokeAsync(GetVocabularyArgs args, InvokeOptions? opts = null)
        public static Output<GetVocabularyResult> Invoke(GetVocabularyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVocabularyResult> getVocabulary(GetVocabularyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:connect/getVocabulary:getVocabulary
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Reference to the hosting Amazon Connect Instance
    Name string
    Returns information on a specific Vocabulary by name
    Tags Dictionary<string, string>
    A map of tags to assign to the Vocabulary.
    VocabularyId string
    Returns information on a specific Vocabulary by Vocabulary id
    InstanceId string
    Reference to the hosting Amazon Connect Instance
    Name string
    Returns information on a specific Vocabulary by name
    Tags map[string]string
    A map of tags to assign to the Vocabulary.
    VocabularyId string
    Returns information on a specific Vocabulary by Vocabulary id
    instanceId String
    Reference to the hosting Amazon Connect Instance
    name String
    Returns information on a specific Vocabulary by name
    tags Map<String,String>
    A map of tags to assign to the Vocabulary.
    vocabularyId String
    Returns information on a specific Vocabulary by Vocabulary id
    instanceId string
    Reference to the hosting Amazon Connect Instance
    name string
    Returns information on a specific Vocabulary by name
    tags {[key: string]: string}
    A map of tags to assign to the Vocabulary.
    vocabularyId string
    Returns information on a specific Vocabulary by Vocabulary id
    instance_id str
    Reference to the hosting Amazon Connect Instance
    name str
    Returns information on a specific Vocabulary by name
    tags Mapping[str, str]
    A map of tags to assign to the Vocabulary.
    vocabulary_id str
    Returns information on a specific Vocabulary by Vocabulary id
    instanceId String
    Reference to the hosting Amazon Connect Instance
    name String
    Returns information on a specific Vocabulary by name
    tags Map<String>
    A map of tags to assign to the Vocabulary.
    vocabularyId String
    Returns information on a specific Vocabulary by Vocabulary id

    getVocabulary Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the Vocabulary.
    Content string
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
    FailureReason string
    The reason why the custom vocabulary was not created.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    LanguageCode string
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?. Valid Values are ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN.
    LastModifiedTime string
    The timestamp when the custom vocabulary was last modified.
    Name string
    State string
    The current state of the custom vocabulary. Valid values are CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS.
    Tags Dictionary<string, string>
    A map of tags to assign to the Vocabulary.
    VocabularyId string
    The identifier of the custom vocabulary.
    Arn string
    The Amazon Resource Name (ARN) of the Vocabulary.
    Content string
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
    FailureReason string
    The reason why the custom vocabulary was not created.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    LanguageCode string
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?. Valid Values are ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN.
    LastModifiedTime string
    The timestamp when the custom vocabulary was last modified.
    Name string
    State string
    The current state of the custom vocabulary. Valid values are CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS.
    Tags map[string]string
    A map of tags to assign to the Vocabulary.
    VocabularyId string
    The identifier of the custom vocabulary.
    arn String
    The Amazon Resource Name (ARN) of the Vocabulary.
    content String
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
    failureReason String
    The reason why the custom vocabulary was not created.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    languageCode String
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?. Valid Values are ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN.
    lastModifiedTime String
    The timestamp when the custom vocabulary was last modified.
    name String
    state String
    The current state of the custom vocabulary. Valid values are CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS.
    tags Map<String,String>
    A map of tags to assign to the Vocabulary.
    vocabularyId String
    The identifier of the custom vocabulary.
    arn string
    The Amazon Resource Name (ARN) of the Vocabulary.
    content string
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
    failureReason string
    The reason why the custom vocabulary was not created.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    languageCode string
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?. Valid Values are ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN.
    lastModifiedTime string
    The timestamp when the custom vocabulary was last modified.
    name string
    state string
    The current state of the custom vocabulary. Valid values are CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS.
    tags {[key: string]: string}
    A map of tags to assign to the Vocabulary.
    vocabularyId string
    The identifier of the custom vocabulary.
    arn str
    The Amazon Resource Name (ARN) of the Vocabulary.
    content str
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
    failure_reason str
    The reason why the custom vocabulary was not created.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    language_code str
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?. Valid Values are ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN.
    last_modified_time str
    The timestamp when the custom vocabulary was last modified.
    name str
    state str
    The current state of the custom vocabulary. Valid values are CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS.
    tags Mapping[str, str]
    A map of tags to assign to the Vocabulary.
    vocabulary_id str
    The identifier of the custom vocabulary.
    arn String
    The Amazon Resource Name (ARN) of the Vocabulary.
    content String
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
    failureReason String
    The reason why the custom vocabulary was not created.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    languageCode String
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?. Valid Values are ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN.
    lastModifiedTime String
    The timestamp when the custom vocabulary was last modified.
    name String
    state String
    The current state of the custom vocabulary. Valid values are CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS.
    tags Map<String>
    A map of tags to assign to the Vocabulary.
    vocabularyId String
    The identifier of the custom vocabulary.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi