1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. getContactFlow
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.connect.getContactFlow

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Provides details about a specific Amazon Connect Contact Flow.

Example Usage

By name

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.connect.getContactFlow({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "Test",
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.connect.get_contact_flow(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="Test")
Copy
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.LookupContactFlow(ctx, &connect.LookupContactFlowArgs{
			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			Name:       pulumi.StringRef("Test"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Connect.GetContactFlow.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "Test",
    });

});
Copy
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.GetContactFlowArgs;
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 test = ConnectFunctions.getContactFlow(GetContactFlowArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("Test")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: aws:connect:getContactFlow
      arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        name: Test
Copy

By contact_flow_id

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.connect.getContactFlow({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    contactFlowId: "cccccccc-bbbb-cccc-dddd-111111111111",
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.connect.get_contact_flow(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    contact_flow_id="cccccccc-bbbb-cccc-dddd-111111111111")
Copy
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.LookupContactFlow(ctx, &connect.LookupContactFlowArgs{
			InstanceId:    "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			ContactFlowId: pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Connect.GetContactFlow.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        ContactFlowId = "cccccccc-bbbb-cccc-dddd-111111111111",
    });

});
Copy
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.GetContactFlowArgs;
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 test = ConnectFunctions.getContactFlow(GetContactFlowArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .contactFlowId("cccccccc-bbbb-cccc-dddd-111111111111")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: aws:connect:getContactFlow
      arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        contactFlowId: cccccccc-bbbb-cccc-dddd-111111111111
Copy

Using getContactFlow

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 getContactFlow(args: GetContactFlowArgs, opts?: InvokeOptions): Promise<GetContactFlowResult>
function getContactFlowOutput(args: GetContactFlowOutputArgs, opts?: InvokeOptions): Output<GetContactFlowResult>
Copy
def get_contact_flow(contact_flow_id: Optional[str] = None,
                     instance_id: Optional[str] = None,
                     name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     type: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetContactFlowResult
def get_contact_flow_output(contact_flow_id: Optional[pulumi.Input[str]] = None,
                     instance_id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     type: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetContactFlowResult]
Copy
func LookupContactFlow(ctx *Context, args *LookupContactFlowArgs, opts ...InvokeOption) (*LookupContactFlowResult, error)
func LookupContactFlowOutput(ctx *Context, args *LookupContactFlowOutputArgs, opts ...InvokeOption) LookupContactFlowResultOutput
Copy

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

public static class GetContactFlow 
{
    public static Task<GetContactFlowResult> InvokeAsync(GetContactFlowArgs args, InvokeOptions? opts = null)
    public static Output<GetContactFlowResult> Invoke(GetContactFlowInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetContactFlowResult> getContactFlow(GetContactFlowArgs args, InvokeOptions options)
public static Output<GetContactFlowResult> getContactFlow(GetContactFlowArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:connect/getContactFlow:getContactFlow
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
Reference to the hosting Amazon Connect Instance
ContactFlowId string
Returns information on a specific Contact Flow by contact flow id
Name string
Returns information on a specific Contact Flow by name
Tags Dictionary<string, string>
Tags to assign to the Contact Flow.
Type string
Type of Contact Flow.
InstanceId This property is required. string
Reference to the hosting Amazon Connect Instance
ContactFlowId string
Returns information on a specific Contact Flow by contact flow id
Name string
Returns information on a specific Contact Flow by name
Tags map[string]string
Tags to assign to the Contact Flow.
Type string
Type of Contact Flow.
instanceId This property is required. String
Reference to the hosting Amazon Connect Instance
contactFlowId String
Returns information on a specific Contact Flow by contact flow id
name String
Returns information on a specific Contact Flow by name
tags Map<String,String>
Tags to assign to the Contact Flow.
type String
Type of Contact Flow.
instanceId This property is required. string
Reference to the hosting Amazon Connect Instance
contactFlowId string
Returns information on a specific Contact Flow by contact flow id
name string
Returns information on a specific Contact Flow by name
tags {[key: string]: string}
Tags to assign to the Contact Flow.
type string
Type of Contact Flow.
instance_id This property is required. str
Reference to the hosting Amazon Connect Instance
contact_flow_id str
Returns information on a specific Contact Flow by contact flow id
name str
Returns information on a specific Contact Flow by name
tags Mapping[str, str]
Tags to assign to the Contact Flow.
type str
Type of Contact Flow.
instanceId This property is required. String
Reference to the hosting Amazon Connect Instance
contactFlowId String
Returns information on a specific Contact Flow by contact flow id
name String
Returns information on a specific Contact Flow by name
tags Map<String>
Tags to assign to the Contact Flow.
type String
Type of Contact Flow.

getContactFlow Result

The following output properties are available:

Arn string
ARN of the Contact Flow.
ContactFlowId string
Content string
Logic of the Contact Flow.
Description string
Description of the Contact Flow.
Id string
The provider-assigned unique ID for this managed resource.
InstanceId string
Name string
Tags Dictionary<string, string>
Tags to assign to the Contact Flow.
Type string
Type of Contact Flow.
Arn string
ARN of the Contact Flow.
ContactFlowId string
Content string
Logic of the Contact Flow.
Description string
Description of the Contact Flow.
Id string
The provider-assigned unique ID for this managed resource.
InstanceId string
Name string
Tags map[string]string
Tags to assign to the Contact Flow.
Type string
Type of Contact Flow.
arn String
ARN of the Contact Flow.
contactFlowId String
content String
Logic of the Contact Flow.
description String
Description of the Contact Flow.
id String
The provider-assigned unique ID for this managed resource.
instanceId String
name String
tags Map<String,String>
Tags to assign to the Contact Flow.
type String
Type of Contact Flow.
arn string
ARN of the Contact Flow.
contactFlowId string
content string
Logic of the Contact Flow.
description string
Description of the Contact Flow.
id string
The provider-assigned unique ID for this managed resource.
instanceId string
name string
tags {[key: string]: string}
Tags to assign to the Contact Flow.
type string
Type of Contact Flow.
arn str
ARN of the Contact Flow.
contact_flow_id str
content str
Logic of the Contact Flow.
description str
Description of the Contact Flow.
id str
The provider-assigned unique ID for this managed resource.
instance_id str
name str
tags Mapping[str, str]
Tags to assign to the Contact Flow.
type str
Type of Contact Flow.
arn String
ARN of the Contact Flow.
contactFlowId String
content String
Logic of the Contact Flow.
description String
Description of the Contact Flow.
id String
The provider-assigned unique ID for this managed resource.
instanceId String
name String
tags Map<String>
Tags to assign to the Contact Flow.
type String
Type of Contact Flow.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi