1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. getRoutingProfile
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.connect.getRoutingProfile

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides details about a specific Amazon Connect Routing Profile.

    Example Usage

    By name

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.connect.getRoutingProfile({
        instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        name: "Example",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.connect.get_routing_profile(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.LookupRoutingProfile(ctx, &connect.LookupRoutingProfileArgs{
    			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.GetRoutingProfile.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.GetRoutingProfileArgs;
    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.getRoutingProfile(GetRoutingProfileArgs.builder()
                .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
                .name("Example")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:connect:getRoutingProfile
          Arguments:
            instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
            name: Example
    

    By routing_profile_id

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.connect.getRoutingProfile({
        instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        routingProfileId: "cccccccc-bbbb-cccc-dddd-111111111111",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.connect.get_routing_profile(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
        routing_profile_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.LookupRoutingProfile(ctx, &connect.LookupRoutingProfileArgs{
    			InstanceId:       "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    			RoutingProfileId: 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.GetRoutingProfile.Invoke(new()
        {
            InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
            RoutingProfileId = "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.GetRoutingProfileArgs;
    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.getRoutingProfile(GetRoutingProfileArgs.builder()
                .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
                .routingProfileId("cccccccc-bbbb-cccc-dddd-111111111111")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:connect:getRoutingProfile
          Arguments:
            instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
            routingProfileId: cccccccc-bbbb-cccc-dddd-111111111111
    

    Using getRoutingProfile

    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 getRoutingProfile(args: GetRoutingProfileArgs, opts?: InvokeOptions): Promise<GetRoutingProfileResult>
    function getRoutingProfileOutput(args: GetRoutingProfileOutputArgs, opts?: InvokeOptions): Output<GetRoutingProfileResult>
    def get_routing_profile(instance_id: Optional[str] = None,
                            name: Optional[str] = None,
                            routing_profile_id: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetRoutingProfileResult
    def get_routing_profile_output(instance_id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            routing_profile_id: Optional[pulumi.Input[str]] = None,
                            tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetRoutingProfileResult]
    func LookupRoutingProfile(ctx *Context, args *LookupRoutingProfileArgs, opts ...InvokeOption) (*LookupRoutingProfileResult, error)
    func LookupRoutingProfileOutput(ctx *Context, args *LookupRoutingProfileOutputArgs, opts ...InvokeOption) LookupRoutingProfileResultOutput

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

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

    The following arguments are supported:

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

    getRoutingProfile Result

    The following output properties are available:

    Arn string
    ARN of the Routing Profile.
    DefaultOutboundQueueId string
    Specifies the default outbound queue for the Routing Profile.
    Description string
    Description of the Routing Profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    MediaConcurrencies List<GetRoutingProfileMediaConcurrency>
    One or more media_concurrencies blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The media_concurrencies block is documented below.
    Name string
    QueueConfigs List<GetRoutingProfileQueueConfig>
    One or more queue_configs blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The queue_configs block is documented below.
    RoutingProfileId string
    Tags Dictionary<string, string>
    Map of tags to assign to the Routing Profile.
    Arn string
    ARN of the Routing Profile.
    DefaultOutboundQueueId string
    Specifies the default outbound queue for the Routing Profile.
    Description string
    Description of the Routing Profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    MediaConcurrencies []GetRoutingProfileMediaConcurrency
    One or more media_concurrencies blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The media_concurrencies block is documented below.
    Name string
    QueueConfigs []GetRoutingProfileQueueConfig
    One or more queue_configs blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The queue_configs block is documented below.
    RoutingProfileId string
    Tags map[string]string
    Map of tags to assign to the Routing Profile.
    arn String
    ARN of the Routing Profile.
    defaultOutboundQueueId String
    Specifies the default outbound queue for the Routing Profile.
    description String
    Description of the Routing Profile.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    mediaConcurrencies List<GetRoutingProfileMediaConcurrency>
    One or more media_concurrencies blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The media_concurrencies block is documented below.
    name String
    queueConfigs List<GetRoutingProfileQueueConfig>
    One or more queue_configs blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The queue_configs block is documented below.
    routingProfileId String
    tags Map<String,String>
    Map of tags to assign to the Routing Profile.
    arn string
    ARN of the Routing Profile.
    defaultOutboundQueueId string
    Specifies the default outbound queue for the Routing Profile.
    description string
    Description of the Routing Profile.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    mediaConcurrencies GetRoutingProfileMediaConcurrency[]
    One or more media_concurrencies blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The media_concurrencies block is documented below.
    name string
    queueConfigs GetRoutingProfileQueueConfig[]
    One or more queue_configs blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The queue_configs block is documented below.
    routingProfileId string
    tags {[key: string]: string}
    Map of tags to assign to the Routing Profile.
    arn str
    ARN of the Routing Profile.
    default_outbound_queue_id str
    Specifies the default outbound queue for the Routing Profile.
    description str
    Description of the Routing Profile.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    media_concurrencies Sequence[GetRoutingProfileMediaConcurrency]
    One or more media_concurrencies blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The media_concurrencies block is documented below.
    name str
    queue_configs Sequence[GetRoutingProfileQueueConfig]
    One or more queue_configs blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The queue_configs block is documented below.
    routing_profile_id str
    tags Mapping[str, str]
    Map of tags to assign to the Routing Profile.
    arn String
    ARN of the Routing Profile.
    defaultOutboundQueueId String
    Specifies the default outbound queue for the Routing Profile.
    description String
    Description of the Routing Profile.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    mediaConcurrencies List<Property Map>
    One or more media_concurrencies blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The media_concurrencies block is documented below.
    name String
    queueConfigs List<Property Map>
    One or more queue_configs blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The queue_configs block is documented below.
    routingProfileId String
    tags Map<String>
    Map of tags to assign to the Routing Profile.

    Supporting Types

    GetRoutingProfileMediaConcurrency

    Channel string
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    Concurrency int
    Number of contacts an agent can have on a channel simultaneously. Valid Range for VOICE: Minimum value of 1. Maximum value of 1. Valid Range for CHAT: Minimum value of 1. Maximum value of 10. Valid Range for TASK: Minimum value of 1. Maximum value of 10.
    Channel string
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    Concurrency int
    Number of contacts an agent can have on a channel simultaneously. Valid Range for VOICE: Minimum value of 1. Maximum value of 1. Valid Range for CHAT: Minimum value of 1. Maximum value of 10. Valid Range for TASK: Minimum value of 1. Maximum value of 10.
    channel String
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    concurrency Integer
    Number of contacts an agent can have on a channel simultaneously. Valid Range for VOICE: Minimum value of 1. Maximum value of 1. Valid Range for CHAT: Minimum value of 1. Maximum value of 10. Valid Range for TASK: Minimum value of 1. Maximum value of 10.
    channel string
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    concurrency number
    Number of contacts an agent can have on a channel simultaneously. Valid Range for VOICE: Minimum value of 1. Maximum value of 1. Valid Range for CHAT: Minimum value of 1. Maximum value of 10. Valid Range for TASK: Minimum value of 1. Maximum value of 10.
    channel str
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    concurrency int
    Number of contacts an agent can have on a channel simultaneously. Valid Range for VOICE: Minimum value of 1. Maximum value of 1. Valid Range for CHAT: Minimum value of 1. Maximum value of 10. Valid Range for TASK: Minimum value of 1. Maximum value of 10.
    channel String
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    concurrency Number
    Number of contacts an agent can have on a channel simultaneously. Valid Range for VOICE: Minimum value of 1. Maximum value of 1. Valid Range for CHAT: Minimum value of 1. Maximum value of 10. Valid Range for TASK: Minimum value of 1. Maximum value of 10.

    GetRoutingProfileQueueConfig

    Channel string
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    Delay int
    Delay, in seconds, that a contact should be in the queue before they are routed to an available agent
    Priority int
    Order in which contacts are to be handled for the queue.
    QueueArn string
    ARN for the queue.
    QueueId string
    Identifier for the queue.
    QueueName string
    Name for the queue.
    Channel string
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    Delay int
    Delay, in seconds, that a contact should be in the queue before they are routed to an available agent
    Priority int
    Order in which contacts are to be handled for the queue.
    QueueArn string
    ARN for the queue.
    QueueId string
    Identifier for the queue.
    QueueName string
    Name for the queue.
    channel String
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    delay Integer
    Delay, in seconds, that a contact should be in the queue before they are routed to an available agent
    priority Integer
    Order in which contacts are to be handled for the queue.
    queueArn String
    ARN for the queue.
    queueId String
    Identifier for the queue.
    queueName String
    Name for the queue.
    channel string
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    delay number
    Delay, in seconds, that a contact should be in the queue before they are routed to an available agent
    priority number
    Order in which contacts are to be handled for the queue.
    queueArn string
    ARN for the queue.
    queueId string
    Identifier for the queue.
    queueName string
    Name for the queue.
    channel str
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    delay int
    Delay, in seconds, that a contact should be in the queue before they are routed to an available agent
    priority int
    Order in which contacts are to be handled for the queue.
    queue_arn str
    ARN for the queue.
    queue_id str
    Identifier for the queue.
    queue_name str
    Name for the queue.
    channel String
    Channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Valid values are VOICE, CHAT, TASK.
    delay Number
    Delay, in seconds, that a contact should be in the queue before they are routed to an available agent
    priority Number
    Order in which contacts are to be handled for the queue.
    queueArn String
    ARN for the queue.
    queueId String
    Identifier for the queue.
    queueName String
    Name for the queue.

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi