github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/polly/getVoices.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package polly

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Data source for managing an AWS Polly Voices.
//
// ## Example Usage
//
// ### Basic Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/polly"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := polly.GetVoices(ctx, nil, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ### With Language Code
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/polly"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := polly.GetVoices(ctx, &polly.GetVoicesArgs{
//				LanguageCode: pulumi.StringRef("en-GB"),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
func GetVoices(ctx *pulumi.Context, args *GetVoicesArgs, opts ...pulumi.InvokeOption) (*GetVoicesResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv GetVoicesResult
	err := ctx.Invoke("aws:polly/getVoices:getVoices", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getVoices.
type GetVoicesArgs struct {
	// Engine used by Amazon Polly when processing input text for speech synthesis. Valid values are `standard`, `neural`, and `long-form`.
	Engine *string `pulumi:"engine"`
	// Whether to return any bilingual voices that use the specified language as an additional language.
	IncludeAdditionalLanguageCodes *bool `pulumi:"includeAdditionalLanguageCodes"`
	// Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned.
	LanguageCode *string `pulumi:"languageCode"`
	// List of voices with their properties. See `voices` Attribute Reference below.
	Voices []GetVoicesVoice `pulumi:"voices"`
}

// A collection of values returned by getVoices.
type GetVoicesResult struct {
	Engine *string `pulumi:"engine"`
	// Amazon Polly assigned voice ID.
	Id                             string `pulumi:"id"`
	IncludeAdditionalLanguageCodes *bool  `pulumi:"includeAdditionalLanguageCodes"`
	// Language code of the voice.
	LanguageCode *string `pulumi:"languageCode"`
	// List of voices with their properties. See `voices` Attribute Reference below.
	Voices []GetVoicesVoice `pulumi:"voices"`
}

func GetVoicesOutput(ctx *pulumi.Context, args GetVoicesOutputArgs, opts ...pulumi.InvokeOption) GetVoicesResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (GetVoicesResult, error) {
			args := v.(GetVoicesArgs)
			r, err := GetVoices(ctx, &args, opts...)
			var s GetVoicesResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(GetVoicesResultOutput)
}

// A collection of arguments for invoking getVoices.
type GetVoicesOutputArgs struct {
	// Engine used by Amazon Polly when processing input text for speech synthesis. Valid values are `standard`, `neural`, and `long-form`.
	Engine pulumi.StringPtrInput `pulumi:"engine"`
	// Whether to return any bilingual voices that use the specified language as an additional language.
	IncludeAdditionalLanguageCodes pulumi.BoolPtrInput `pulumi:"includeAdditionalLanguageCodes"`
	// Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned.
	LanguageCode pulumi.StringPtrInput `pulumi:"languageCode"`
	// List of voices with their properties. See `voices` Attribute Reference below.
	Voices GetVoicesVoiceArrayInput `pulumi:"voices"`
}

func (GetVoicesOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*GetVoicesArgs)(nil)).Elem()
}

// A collection of values returned by getVoices.
type GetVoicesResultOutput struct{ *pulumi.OutputState }

func (GetVoicesResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*GetVoicesResult)(nil)).Elem()
}

func (o GetVoicesResultOutput) ToGetVoicesResultOutput() GetVoicesResultOutput {
	return o
}

func (o GetVoicesResultOutput) ToGetVoicesResultOutputWithContext(ctx context.Context) GetVoicesResultOutput {
	return o
}

func (o GetVoicesResultOutput) Engine() pulumi.StringPtrOutput {
	return o.ApplyT(func(v GetVoicesResult) *string { return v.Engine }).(pulumi.StringPtrOutput)
}

// Amazon Polly assigned voice ID.
func (o GetVoicesResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v GetVoicesResult) string { return v.Id }).(pulumi.StringOutput)
}

func (o GetVoicesResultOutput) IncludeAdditionalLanguageCodes() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v GetVoicesResult) *bool { return v.IncludeAdditionalLanguageCodes }).(pulumi.BoolPtrOutput)
}

// Language code of the voice.
func (o GetVoicesResultOutput) LanguageCode() pulumi.StringPtrOutput {
	return o.ApplyT(func(v GetVoicesResult) *string { return v.LanguageCode }).(pulumi.StringPtrOutput)
}

// List of voices with their properties. See `voices` Attribute Reference below.
func (o GetVoicesResultOutput) Voices() GetVoicesVoiceArrayOutput {
	return o.ApplyT(func(v GetVoicesResult) []GetVoicesVoice { return v.Voices }).(GetVoicesVoiceArrayOutput)
}

func init() {
	pulumi.RegisterOutputType(GetVoicesResultOutput{})
}