AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getEntity

Resource schema for AWS::IoTTwinMaker::Entity

Using getEntity

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 getEntity(args: GetEntityArgs, opts?: InvokeOptions): Promise<GetEntityResult>
function getEntityOutput(args: GetEntityOutputArgs, opts?: InvokeOptions): Output<GetEntityResult>
def get_entity(entity_id: Optional[str] = None,
               workspace_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetEntityResult
def get_entity_output(entity_id: Optional[pulumi.Input[str]] = None,
               workspace_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetEntityResult]
func LookupEntity(ctx *Context, args *LookupEntityArgs, opts ...InvokeOption) (*LookupEntityResult, error)
func LookupEntityOutput(ctx *Context, args *LookupEntityOutputArgs, opts ...InvokeOption) LookupEntityResultOutput

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

public static class GetEntity 
{
    public static Task<GetEntityResult> InvokeAsync(GetEntityArgs args, InvokeOptions? opts = null)
    public static Output<GetEntityResult> Invoke(GetEntityInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEntityResult> getEntity(GetEntityArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:iottwinmaker:getEntity
  Arguments:
    # Arguments dictionary

The following arguments are supported:

EntityId string

The ID of the entity.

WorkspaceId string

The ID of the workspace.

EntityId string

The ID of the entity.

WorkspaceId string

The ID of the workspace.

entityId String

The ID of the entity.

workspaceId String

The ID of the workspace.

entityId string

The ID of the entity.

workspaceId string

The ID of the workspace.

entity_id str

The ID of the entity.

workspace_id str

The ID of the workspace.

entityId String

The ID of the entity.

workspaceId String

The ID of the workspace.

getEntity Result

The following output properties are available:

Arn string

The ARN of the entity.

Components object

A map that sets information about a component type.

CreationDateTime string

The date and time when the entity was created.

Description string

The description of the entity.

EntityName string

The name of the entity.

HasChildEntities bool

A Boolean value that specifies whether the entity has child entities or not.

ParentEntityId string

The ID of the parent entity.

Status Pulumi.AwsNative.IoTTwinMaker.Outputs.EntityStatus

The current status of the entity.

Tags object

A key-value pair to associate with a resource.

UpdateDateTime string

The last date and time when the entity was updated.

Arn string

The ARN of the entity.

Components interface{}

A map that sets information about a component type.

CreationDateTime string

The date and time when the entity was created.

Description string

The description of the entity.

EntityName string

The name of the entity.

HasChildEntities bool

A Boolean value that specifies whether the entity has child entities or not.

ParentEntityId string

The ID of the parent entity.

Status EntityStatus

The current status of the entity.

Tags interface{}

A key-value pair to associate with a resource.

UpdateDateTime string

The last date and time when the entity was updated.

arn String

The ARN of the entity.

components Object

A map that sets information about a component type.

creationDateTime String

The date and time when the entity was created.

description String

The description of the entity.

entityName String

The name of the entity.

hasChildEntities Boolean

A Boolean value that specifies whether the entity has child entities or not.

parentEntityId String

The ID of the parent entity.

status EntityStatus

The current status of the entity.

tags Object

A key-value pair to associate with a resource.

updateDateTime String

The last date and time when the entity was updated.

arn string

The ARN of the entity.

components any

A map that sets information about a component type.

creationDateTime string

The date and time when the entity was created.

description string

The description of the entity.

entityName string

The name of the entity.

hasChildEntities boolean

A Boolean value that specifies whether the entity has child entities or not.

parentEntityId string

The ID of the parent entity.

status EntityStatus

The current status of the entity.

tags any

A key-value pair to associate with a resource.

updateDateTime string

The last date and time when the entity was updated.

arn str

The ARN of the entity.

components Any

A map that sets information about a component type.

creation_date_time str

The date and time when the entity was created.

description str

The description of the entity.

entity_name str

The name of the entity.

has_child_entities bool

A Boolean value that specifies whether the entity has child entities or not.

parent_entity_id str

The ID of the parent entity.

status EntityStatus

The current status of the entity.

tags Any

A key-value pair to associate with a resource.

update_date_time str

The last date and time when the entity was updated.

arn String

The ARN of the entity.

components Any

A map that sets information about a component type.

creationDateTime String

The date and time when the entity was created.

description String

The description of the entity.

entityName String

The name of the entity.

hasChildEntities Boolean

A Boolean value that specifies whether the entity has child entities or not.

parentEntityId String

The ID of the parent entity.

status Property Map

The current status of the entity.

tags Any

A key-value pair to associate with a resource.

updateDateTime String

The last date and time when the entity was updated.

Supporting Types

EntityStatus

EntityStatusErrorProperties

EntityStatusErrorPropertiesCode

EntityStatusState

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0