Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. iotsitewise
  5. getGateway

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.iotsitewise.getGateway

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

    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.Outputs.Tag>
    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 Tag
    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<Tag>
    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 Tag[]
    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[root_Tag]
    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.

    Supporting Types

    GatewayCapabilitySummary

    CapabilityNamespace string
    The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
    CapabilityConfiguration string
    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .
    CapabilityNamespace string
    The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
    CapabilityConfiguration string
    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .
    capabilityNamespace String
    The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
    capabilityConfiguration String
    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .
    capabilityNamespace string
    The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
    capabilityConfiguration string
    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .
    capability_namespace str
    The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
    capability_configuration str
    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .
    capabilityNamespace String
    The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .
    capabilityConfiguration String
    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .

    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

    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