翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS SDK または CLI `DescribeGateway`で を使用する
次のサンプルコードは、`DescribeGateway` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [基本を学ぶ](example_iotsitewise_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**ゲートウェイの説明を表示するには**
次の `describe-gateway` の例では、ゲートウェイの説明を表示します。
```
aws iotsitewise describe-gateway \
--gateway-id {{a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE}}
```
出力:
```
{
"gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
"gatewayName": "ExampleCorpGateway",
"gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
"gatewayPlatform": {
"greengrass": {
"groupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE"
}
},
"gatewayCapabilitySummaries": [
{
"capabilityNamespace": "iotsitewise:opcuacollector:1",
"capabilitySyncStatus": "IN_SYNC"
}
],
"creationDate": 1588369971.457,
"lastUpdateDate": 1588369971.457
}
```
詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway.html)」を参照してください。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/iotsitewise#code-examples)での設定と実行の方法を確認してください。
```
/**
* Describes the specified gateway.
*
* @param gatewayId the ID of the gateway to describe.
* @return a {@link CompletableFuture} that represents a {@link DescribeGatewayResponse} result. The calling code
* can attach callbacks, then handle the result or exception by calling {@link CompletableFuture#join()} or
* {@link CompletableFuture#get()}.
*
* If any completion stage in this method throws an exception, the method logs the exception cause and keeps
* it available to the calling code as a {@link CompletionException}. By calling
* {@link CompletionException#getCause()}, the calling code can access the original exception.
*/
public CompletableFuture describeGatewayAsync(String gatewayId) {
DescribeGatewayRequest request = DescribeGatewayRequest.builder()
.gatewayId(gatewayId)
.build();
return getAsyncClient().describeGateway(request)
.whenComplete((response, exception) -> {
if (exception != null) {
logger.error("An error occurred during the describeGateway method: {}", exception.getCause().getMessage());
}
});
}
```
+ API の詳細については、「*AWS SDK for Java 2.x API リファレンス*」の「[DescribeGateway](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotsitewise-2019-12-02/DescribeGateway)」を参照してください。
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/iotsitewise#code-examples)での設定と実行の方法を確認してください。
```
import {
DescribeGatewayCommand,
IoTSiteWiseClient,
} from "@aws-sdk/client-iotsitewise";
import { parseArgs } from "node:util";
/**
* Create an SSM document.
* @param {{ content: string, name: string, documentType?: DocumentType }}
*/
export const main = async ({ gatewayId }) => {
const client = new IoTSiteWiseClient({});
try {
const { gatewayDescription } = await client.send(
new DescribeGatewayCommand({
gatewayId: gatewayId, // The ID of the Gateway to describe.
}),
);
console.log("Gateway information retrieved successfully.");
return { gatewayDescription: gatewayDescription };
} catch (caught) {
if (caught instanceof Error && caught.name === "ResourceNotFound") {
console.warn(
`${caught.message}. The Gateway could not be found. Please check the Gateway Id.`,
);
} else {
throw caught;
}
}
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[DescribeGateway](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotsitewise/command/DescribeGatewayCommand)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/iotsitewise#code-examples)での設定と実行の方法を確認してください。
```
class IoTSitewiseWrapper:
"""Encapsulates AWS IoT SiteWise actions using the client interface."""
def __init__(self, iotsitewise_client: client) -> None:
"""
Initializes the IoTSitewiseWrapper with an AWS IoT SiteWise client.
:param iotsitewise_client: A Boto3 AWS IoT SiteWise client. This client provides low-level
access to AWS IoT SiteWise services.
"""
self.iotsitewise_client = iotsitewise_client
self.entry_id = 0 # Incremented to generate unique entry IDs for batch_put_asset_property_value.
@classmethod
def from_client(cls) -> "IoTSitewiseWrapper":
"""
Creates an IoTSitewiseWrapper instance with a default AWS IoT SiteWise client.
:return: An instance of IoTSitewiseWrapper initialized with the default AWS IoT SiteWise client.
"""
iotsitewise_client = boto3.client("iotsitewise")
return cls(iotsitewise_client)
def describe_gateway(self, gateway_id: str) -> Dict[str, Any]:
"""
Describes an AWS IoT SiteWise Gateway.
:param gateway_id: The ID of the gateway to describe.
:return: A dictionary containing information about the gateway.
"""
try:
response = self.iotsitewise_client.describe_gateway(gatewayId=gateway_id)
return response
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Gateway %s does not exist.", gateway_id)
else:
logger.error(
"Error describing gateway %s. Here's why %s",
gateway_id,
err.response["Error"]["Message"],
)
raise
```
+ API の詳細については、AWS SDK for Python (Boto3) API リファレンスの「[DescribeGateway](https://docs.aws.amazon.com/goto/boto3/iotsitewise-2019-12-02/DescribeGateway)」を参照してください。**
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ios#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_ios->describegateway(
iv_gatewayid = iv_gateway_id
). " oo_result is returned for testing purposes. "
MESSAGE 'Retrieved gateway description.' TYPE 'I'.
CATCH /aws1/cx_iosresourcenotfoundex.
MESSAGE 'Gateway does not exist.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の「[DescribeGateway](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
AWS SDK 開発者ガイドとコード例の完全なリストについては、「」を参照してください[AWS SDK でのこのサービスの使用](sdk-general-information-section.md)。このトピックには、使用開始方法に関する情報と、以前の SDK バージョンの詳細も含まれています。