Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. bedrock
  5. getAgentAlias

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.getAgentAlias

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Bedrock::AgentAlias Resource Type

    Using getAgentAlias

    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 getAgentAlias(args: GetAgentAliasArgs, opts?: InvokeOptions): Promise<GetAgentAliasResult>
function getAgentAliasOutput(args: GetAgentAliasOutputArgs, opts?: InvokeOptions): Output<GetAgentAliasResult>
    def get_agent_alias(agent_alias_id: Optional[str] = None,
                    agent_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAgentAliasResult
def get_agent_alias_output(agent_alias_id: Optional[pulumi.Input[str]] = None,
                    agent_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAgentAliasResult]
    func LookupAgentAlias(ctx *Context, args *LookupAgentAliasArgs, opts ...InvokeOption) (*LookupAgentAliasResult, error)
func LookupAgentAliasOutput(ctx *Context, args *LookupAgentAliasOutputArgs, opts ...InvokeOption) LookupAgentAliasResultOutput

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

    public static class GetAgentAlias 
{
    public static Task<GetAgentAliasResult> InvokeAsync(GetAgentAliasArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentAliasResult> Invoke(GetAgentAliasInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentAliasResult> getAgentAlias(GetAgentAliasArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:bedrock:getAgentAlias
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AgentAliasId string
    Id for an Agent Alias generated at the server side.
    AgentId string
    Identifier for a resource.
    AgentAliasId string
    Id for an Agent Alias generated at the server side.
    AgentId string
    Identifier for a resource.
    agentAliasId String
    Id for an Agent Alias generated at the server side.
    agentId String
    Identifier for a resource.
    agentAliasId string
    Id for an Agent Alias generated at the server side.
    agentId string
    Identifier for a resource.
    agent_alias_id str
    Id for an Agent Alias generated at the server side.
    agent_id str
    Identifier for a resource.
    agentAliasId String
    Id for an Agent Alias generated at the server side.
    agentId String
    Identifier for a resource.

    getAgentAlias Result

    The following output properties are available:

    AgentAliasArn string
    Arn representation of the Agent Alias.
    AgentAliasHistoryEvents List<Pulumi.AwsNative.Bedrock.Outputs.AgentAliasHistoryEvent>
    The list of history events for an alias for an Agent.
    AgentAliasId string
    Id for an Agent Alias generated at the server side.
    AgentAliasName string
    Name for a resource.
    AgentAliasStatus Pulumi.AwsNative.Bedrock.AgentAliasStatus
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent alias is being created.
    • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    • FAILED – The agent alias API operation failed.
    • UPDATING – The agent alias is being updated.
    • DELETING – The agent alias is being deleted.
    CreatedAt string
    Time Stamp.
    Description string
    Description of the Resource.
    RoutingConfiguration List<Pulumi.AwsNative.Bedrock.Outputs.AgentAliasRoutingConfigurationListItem>
    Routing configuration for an Agent alias.
    Tags Dictionary<string, string>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    UpdatedAt string
    Time Stamp.
    AgentAliasArn string
    Arn representation of the Agent Alias.
    AgentAliasHistoryEvents []AgentAliasHistoryEvent
    The list of history events for an alias for an Agent.
    AgentAliasId string
    Id for an Agent Alias generated at the server side.
    AgentAliasName string
    Name for a resource.
    AgentAliasStatus AgentAliasStatus
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent alias is being created.
    • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    • FAILED – The agent alias API operation failed.
    • UPDATING – The agent alias is being updated.
    • DELETING – The agent alias is being deleted.
    CreatedAt string
    Time Stamp.
    Description string
    Description of the Resource.
    RoutingConfiguration []AgentAliasRoutingConfigurationListItem
    Routing configuration for an Agent alias.
    Tags map[string]string
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    UpdatedAt string
    Time Stamp.
    agentAliasArn String
    Arn representation of the Agent Alias.
    agentAliasHistoryEvents List<AgentAliasHistoryEvent>
    The list of history events for an alias for an Agent.
    agentAliasId String
    Id for an Agent Alias generated at the server side.
    agentAliasName String
    Name for a resource.
    agentAliasStatus AgentAliasStatus
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent alias is being created.
    • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    • FAILED – The agent alias API operation failed.
    • UPDATING – The agent alias is being updated.
    • DELETING – The agent alias is being deleted.
    createdAt String
    Time Stamp.
    description String
    Description of the Resource.
    routingConfiguration List<AgentAliasRoutingConfigurationListItem>
    Routing configuration for an Agent alias.
    tags Map<String,String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt String
    Time Stamp.
    agentAliasArn string
    Arn representation of the Agent Alias.
    agentAliasHistoryEvents AgentAliasHistoryEvent[]
    The list of history events for an alias for an Agent.
    agentAliasId string
    Id for an Agent Alias generated at the server side.
    agentAliasName string
    Name for a resource.
    agentAliasStatus AgentAliasStatus
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent alias is being created.
    • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    • FAILED – The agent alias API operation failed.
    • UPDATING – The agent alias is being updated.
    • DELETING – The agent alias is being deleted.
    createdAt string
    Time Stamp.
    description string
    Description of the Resource.
    routingConfiguration AgentAliasRoutingConfigurationListItem[]
    Routing configuration for an Agent alias.
    tags {[key: string]: string}
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt string
    Time Stamp.
    agent_alias_arn str
    Arn representation of the Agent Alias.
    agent_alias_history_events Sequence[AgentAliasHistoryEvent]
    The list of history events for an alias for an Agent.
    agent_alias_id str
    Id for an Agent Alias generated at the server side.
    agent_alias_name str
    Name for a resource.
    agent_alias_status AgentAliasStatus
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent alias is being created.
    • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    • FAILED – The agent alias API operation failed.
    • UPDATING – The agent alias is being updated.
    • DELETING – The agent alias is being deleted.
    created_at str
    Time Stamp.
    description str
    Description of the Resource.
    routing_configuration Sequence[AgentAliasRoutingConfigurationListItem]
    Routing configuration for an Agent alias.
    tags Mapping[str, str]
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updated_at str
    Time Stamp.
    agentAliasArn String
    Arn representation of the Agent Alias.
    agentAliasHistoryEvents List<Property Map>
    The list of history events for an alias for an Agent.
    agentAliasId String
    Id for an Agent Alias generated at the server side.
    agentAliasName String
    Name for a resource.
    agentAliasStatus "CREATING" | "PREPARED" | "FAILED" | "UPDATING" | "DELETING"
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent alias is being created.
    • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    • FAILED – The agent alias API operation failed.
    • UPDATING – The agent alias is being updated.
    • DELETING – The agent alias is being deleted.
    createdAt String
    Time Stamp.
    description String
    Description of the Resource.
    routingConfiguration List<Property Map>
    Routing configuration for an Agent alias.
    tags Map<String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt String
    Time Stamp.

    Supporting Types

    AgentAliasHistoryEvent

    EndDate string
    Time Stamp.
    RoutingConfiguration List<Pulumi.AwsNative.Bedrock.Inputs.AgentAliasRoutingConfigurationListItem>
    Routing configuration for an Agent alias.
    StartDate string
    Time Stamp.
    EndDate string
    Time Stamp.
    RoutingConfiguration []AgentAliasRoutingConfigurationListItem
    Routing configuration for an Agent alias.
    StartDate string
    Time Stamp.
    endDate String
    Time Stamp.
    routingConfiguration List<AgentAliasRoutingConfigurationListItem>
    Routing configuration for an Agent alias.
    startDate String
    Time Stamp.
    endDate string
    Time Stamp.
    routingConfiguration AgentAliasRoutingConfigurationListItem[]
    Routing configuration for an Agent alias.
    startDate string
    Time Stamp.
    end_date str
    Time Stamp.
    routing_configuration Sequence[AgentAliasRoutingConfigurationListItem]
    Routing configuration for an Agent alias.
    start_date str
    Time Stamp.
    endDate String
    Time Stamp.
    routingConfiguration List<Property Map>
    Routing configuration for an Agent alias.
    startDate String
    Time Stamp.

    AgentAliasRoutingConfigurationListItem

    AgentVersion string
    Agent Version.
    AgentVersion string
    Agent Version.
    agentVersion String
    Agent Version.
    agentVersion string
    Agent Version.
    agent_version str
    Agent Version.
    agentVersion String
    Agent Version.

    AgentAliasStatus

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native