AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

getGateway

Resource schema for AWS::IoTSiteWise::Gateway

Using getGateway

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 getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>

def get_gateway(gateway_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]

func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput

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

public static class GetGateway 
{
    public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: aws-native:iotsitewise:getGateway
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GatewayId string: The ID of the gateway device.

GatewayId string: The ID of the gateway device.

gatewayId String: The ID of the gateway device.

gatewayId string: The ID of the gateway device.

gateway_id str: The ID of the gateway device.

gatewayId String: The ID of the gateway device.

getGateway Result

The following output properties are available:

GatewayCapabilitySummaries List<Pulumi.AwsNative.IoTSiteWise.Outputs.GatewayCapabilitySummary>: A list of gateway capability summaries that each contain a namespace and status.
GatewayId string: The ID of the gateway device.
GatewayName string: A unique, friendly name for the gateway.
Tags List<Pulumi.AwsNative.IoTSiteWise.Outputs.GatewayTag>: A list of key-value pairs that contain metadata for the gateway.

GatewayCapabilitySummaries []GatewayCapabilitySummary: A list of gateway capability summaries that each contain a namespace and status.
GatewayId string: The ID of the gateway device.
GatewayName string: A unique, friendly name for the gateway.
Tags []GatewayTag: A list of key-value pairs that contain metadata for the gateway.

gatewayCapabilitySummaries List<GatewayCapabilitySummary>: A list of gateway capability summaries that each contain a namespace and status.
gatewayId String: The ID of the gateway device.
gatewayName String: A unique, friendly name for the gateway.
tags List<GatewayTag>: A list of key-value pairs that contain metadata for the gateway.

gatewayCapabilitySummaries GatewayCapabilitySummary[]: A list of gateway capability summaries that each contain a namespace and status.
gatewayId string: The ID of the gateway device.
gatewayName string: A unique, friendly name for the gateway.
tags GatewayTag[]: A list of key-value pairs that contain metadata for the gateway.

gateway_capability_summaries Sequence[GatewayCapabilitySummary]: A list of gateway capability summaries that each contain a namespace and status.
gateway_id str: The ID of the gateway device.
gateway_name str: A unique, friendly name for the gateway.
tags Sequence[GatewayTag]: A list of key-value pairs that contain metadata for the gateway.

gatewayCapabilitySummaries List<Property Map>: A list of gateway capability summaries that each contain a namespace and status.
gatewayId String: The ID of the gateway device.
gatewayName String: A unique, friendly name for the gateway.
tags List<Property Map>: A list of key-value pairs that contain metadata for the gateway.