Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. getAgentStatus

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.getAgentStatus

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::AgentStatus

    Using getAgentStatus

    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 getAgentStatus(args: GetAgentStatusArgs, opts?: InvokeOptions): Promise<GetAgentStatusResult>
function getAgentStatusOutput(args: GetAgentStatusOutputArgs, opts?: InvokeOptions): Output<GetAgentStatusResult>
    def get_agent_status(agent_status_arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAgentStatusResult
def get_agent_status_output(agent_status_arn: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAgentStatusResult]
    func LookupAgentStatus(ctx *Context, args *LookupAgentStatusArgs, opts ...InvokeOption) (*LookupAgentStatusResult, error)
func LookupAgentStatusOutput(ctx *Context, args *LookupAgentStatusOutputArgs, opts ...InvokeOption) LookupAgentStatusResultOutput

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

    public static class GetAgentStatus 
{
    public static Task<GetAgentStatusResult> InvokeAsync(GetAgentStatusArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentStatusResult> Invoke(GetAgentStatusInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentStatusResult> getAgentStatus(GetAgentStatusArgs args, InvokeOptions options)
public static Output<GetAgentStatusResult> getAgentStatus(GetAgentStatusArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:connect:getAgentStatus
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AgentStatusArn string
    The Amazon Resource Name (ARN) of the agent status.
    AgentStatusArn string
    The Amazon Resource Name (ARN) of the agent status.
    agentStatusArn String
    The Amazon Resource Name (ARN) of the agent status.
    agentStatusArn string
    The Amazon Resource Name (ARN) of the agent status.
    agent_status_arn str
    The Amazon Resource Name (ARN) of the agent status.
    agentStatusArn String
    The Amazon Resource Name (ARN) of the agent status.

    getAgentStatus Result

    The following output properties are available:

    AgentStatusArn string
    The Amazon Resource Name (ARN) of the agent status.
    Description string
    The description of the status.
    DisplayOrder int
    The display order of the status.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    LastModifiedRegion string
    Last modified region.
    LastModifiedTime double
    Last modified time.
    Name string
    The name of the status.
    ResetOrderNumber bool
    A number indicating the reset order of the agent status.
    State Pulumi.AwsNative.Connect.AgentStatusState
    The state of the status.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Type Pulumi.AwsNative.Connect.AgentStatusType
    The type of agent status.
    AgentStatusArn string
    The Amazon Resource Name (ARN) of the agent status.
    Description string
    The description of the status.
    DisplayOrder int
    The display order of the status.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    LastModifiedRegion string
    Last modified region.
    LastModifiedTime float64
    Last modified time.
    Name string
    The name of the status.
    ResetOrderNumber bool
    A number indicating the reset order of the agent status.
    State AgentStatusStateEnum
    The state of the status.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    Type AgentStatusType
    The type of agent status.
    agentStatusArn String
    The Amazon Resource Name (ARN) of the agent status.
    description String
    The description of the status.
    displayOrder Integer
    The display order of the status.
    instanceArn String
    The identifier of the Amazon Connect instance.
    lastModifiedRegion String
    Last modified region.
    lastModifiedTime Double
    Last modified time.
    name String
    The name of the status.
    resetOrderNumber Boolean
    A number indicating the reset order of the agent status.
    state AgentStatusState
    The state of the status.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    type AgentStatusType
    The type of agent status.
    agentStatusArn string
    The Amazon Resource Name (ARN) of the agent status.
    description string
    The description of the status.
    displayOrder number
    The display order of the status.
    instanceArn string
    The identifier of the Amazon Connect instance.
    lastModifiedRegion string
    Last modified region.
    lastModifiedTime number
    Last modified time.
    name string
    The name of the status.
    resetOrderNumber boolean
    A number indicating the reset order of the agent status.
    state AgentStatusState
    The state of the status.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    type AgentStatusType
    The type of agent status.
    agent_status_arn str
    The Amazon Resource Name (ARN) of the agent status.
    description str
    The description of the status.
    display_order int
    The display order of the status.
    instance_arn str
    The identifier of the Amazon Connect instance.
    last_modified_region str
    Last modified region.
    last_modified_time float
    Last modified time.
    name str
    The name of the status.
    reset_order_number bool
    A number indicating the reset order of the agent status.
    state AgentStatusState
    The state of the status.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    type AgentStatusType
    The type of agent status.
    agentStatusArn String
    The Amazon Resource Name (ARN) of the agent status.
    description String
    The description of the status.
    displayOrder Number
    The display order of the status.
    instanceArn String
    The identifier of the Amazon Connect instance.
    lastModifiedRegion String
    Last modified region.
    lastModifiedTime Number
    Last modified time.
    name String
    The name of the status.
    resetOrderNumber Boolean
    A number indicating the reset order of the agent status.
    state "ENABLED" | "DISABLED"
    The state of the status.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    type "ROUTABLE" | "CUSTOM" | "OFFLINE"
    The type of agent status.

    Supporting Types

    AgentStatusState

    AgentStatusType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native