}} props
*/
export async function waitForPipelineComplete({ arn, sagemakerClient, wait }) {
const command = new DescribePipelineExecutionCommand({
PipelineExecutionArn: arn,
});
let complete = false;
const intervalInSeconds = 15;
const COMPLETION_STATUSES = [
PipelineExecutionStatus.FAILED,
PipelineExecutionStatus.STOPPED,
PipelineExecutionStatus.SUCCEEDED,
];
do {
const { PipelineExecutionStatus: status, FailureReason } =
await sagemakerClient.send(command);
complete = COMPLETION_STATUSES.includes(status);
if (!complete) {
console.log(
`Pipeline is ${status}. Waiting ${intervalInSeconds} seconds before checking again.`,
);
await wait(intervalInSeconds);
} else if (status === PipelineExecutionStatus.FAILED) {
throw new Error(`Pipeline failed because: ${FailureReason}`);
} else if (status === PipelineExecutionStatus.STOPPED) {
throw new Error("Pipeline was forcefully stopped.");
} else {
console.log(`Pipeline execution ${status}.`);
}
} while (!complete);
}
/**
* Return the string value of an Amazon S3 object.
* @param {{ bucket: string, key: string, s3Client: import('@aws-sdk/client-s3').S3Client}} param0
*/
export async function getObject({ bucket, s3Client }) {
const prefix = "output/";
const { Contents } = await s3Client.send(
new ListObjectsV2Command({ MaxKeys: 1, Bucket: bucket, Prefix: prefix }),
);
if (!Contents.length) {
throw new Error("No objects found in bucket.");
}
// Find the CSV file.
const outputObject = Contents.find((obj) => obj.Key.endsWith(".csv"));
if (!outputObject) {
throw new Error(`No CSV file found in bucket with the prefix "${prefix}".`);
}
const { Body } = await s3Client.send(
new GetObjectCommand({
Bucket: bucket,
Key: outputObject.Key,
}),
);
return Body.transformToString();
}
```
この関数は、上記のライブラリ関数により SageMaker AI パイプラインを設定して実行し、作成されたすべてのリソースを削除するファイルからの抜粋です。
```
import { retry, wait } from "@aws-doc-sdk-examples/lib/utils/util-timers.js";
import {
attachPolicy,
configureLambdaSQSEventSource,
createLambdaExecutionPolicy,
createLambdaExecutionRole,
createLambdaFunction,
createLambdaLayer,
createS3Bucket,
createSQSQueue,
createSagemakerExecutionPolicy,
createSagemakerPipeline,
createSagemakerRole,
getObject,
startPipelineExecution,
uploadCSVDataToS3,
waitForPipelineComplete,
} from "./lib.js";
import { MESSAGES } from "./messages.js";
export class SageMakerPipelinesWkflw {
names = {
LAMBDA_EXECUTION_ROLE: "sagemaker-wkflw-lambda-execution-role",
LAMBDA_EXECUTION_ROLE_POLICY:
"sagemaker-wkflw-lambda-execution-role-policy",
LAMBDA_FUNCTION: "sagemaker-wkflw-lambda-function",
LAMBDA_LAYER: "sagemaker-wkflw-lambda-layer",
SAGE_MAKER_EXECUTION_ROLE: "sagemaker-wkflw-pipeline-execution-role",
SAGE_MAKER_EXECUTION_ROLE_POLICY:
"sagemaker-wkflw-pipeline-execution-role-policy",
SAGE_MAKER_PIPELINE: "sagemaker-wkflw-pipeline",
SQS_QUEUE: "sagemaker-wkflw-sqs-queue",
S3_BUCKET: `sagemaker-wkflw-s3-bucket-${Date.now()}`,
};
cleanUpFunctions = [];
/**
* @param {import("@aws-doc-sdk-examples/lib/prompter.js").Prompter} prompter
* @param {import("@aws-doc-sdk-examples/lib/logger.js").Logger} logger
* @param {{ IAM: import("@aws-sdk/client-iam").IAMClient, Lambda: import("@aws-sdk/client-lambda").LambdaClient, SageMaker: import("@aws-sdk/client-sagemaker").SageMakerClient, S3: import("@aws-sdk/client-s3").S3Client, SQS: import("@aws-sdk/client-sqs").SQSClient }} clients
*/
constructor(prompter, logger, clients) {
this.prompter = prompter;
this.logger = logger;
this.clients = clients;
}
async run() {
try {
await this.startWorkflow();
} catch (err) {
console.error(err);
throw err;
} finally {
this.logger.logSeparator();
const doCleanUp = await this.prompter.confirm({
message: "Clean up resources?",
});
if (doCleanUp) {
await this.cleanUp();
}
}
}
async cleanUp() {
// Run all of the clean up functions. If any fail, we log the error and continue.
// This ensures all clean up functions are run.
for (let i = this.cleanUpFunctions.length - 1; i >= 0; i--) {
await retry(
{ intervalInMs: 1000, maxRetries: 60, swallowError: true },
this.cleanUpFunctions[i],
);
}
}
async startWorkflow() {
this.logger.logSeparator(MESSAGES.greetingHeader);
await this.logger.log(MESSAGES.greeting);
this.logger.logSeparator();
await this.logger.log(
MESSAGES.creatingRole.replace(
"${ROLE_NAME}",
this.names.LAMBDA_EXECUTION_ROLE,
),
);
// Create an IAM role that will be assumed by the AWS Lambda function. This function
// is triggered by Amazon SQS messages and calls SageMaker and SageMaker GeoSpatial actions.
const { arn: lambdaExecutionRoleArn, cleanUp: lambdaExecutionRoleCleanUp } =
await createLambdaExecutionRole({
name: this.names.LAMBDA_EXECUTION_ROLE,
iamClient: this.clients.IAM,
});
// Add a clean up step to a stack for every resource created.
this.cleanUpFunctions.push(lambdaExecutionRoleCleanUp);
await this.logger.log(
MESSAGES.roleCreated.replace(
"${ROLE_NAME}",
this.names.LAMBDA_EXECUTION_ROLE,
),
);
this.logger.logSeparator();
await this.logger.log(
MESSAGES.creatingRole.replace(
"${ROLE_NAME}",
this.names.SAGE_MAKER_EXECUTION_ROLE,
),
);
// Create an IAM role that will be assumed by the SageMaker pipeline. The pipeline
// sends messages to an Amazon SQS queue and puts/retrieves Amazon S3 objects.
const {
arn: pipelineExecutionRoleArn,
cleanUp: pipelineExecutionRoleCleanUp,
} = await createSagemakerRole({
iamClient: this.clients.IAM,
name: this.names.SAGE_MAKER_EXECUTION_ROLE,
wait,
});
this.cleanUpFunctions.push(pipelineExecutionRoleCleanUp);
await this.logger.log(
MESSAGES.roleCreated.replace(
"${ROLE_NAME}",
this.names.SAGE_MAKER_EXECUTION_ROLE,
),
);
this.logger.logSeparator();
// Create an IAM policy that allows the AWS Lambda function to invoke SageMaker APIs.
const {
arn: lambdaExecutionPolicyArn,
policy: lambdaPolicy,
cleanUp: lambdaExecutionPolicyCleanUp,
} = await createLambdaExecutionPolicy({
name: this.names.LAMBDA_EXECUTION_ROLE_POLICY,
s3BucketName: this.names.S3_BUCKET,
iamClient: this.clients.IAM,
pipelineExecutionRoleArn,
});
this.cleanUpFunctions.push(lambdaExecutionPolicyCleanUp);
console.log(JSON.stringify(lambdaPolicy, null, 2), "\n");
await this.logger.log(
MESSAGES.attachPolicy
.replace("${POLICY_NAME}", this.names.LAMBDA_EXECUTION_ROLE_POLICY)
.replace("${ROLE_NAME}", this.names.LAMBDA_EXECUTION_ROLE),
);
await this.prompter.checkContinue();
// Attach the Lambda execution policy to the execution role.
const { cleanUp: lambdaExecutionRolePolicyCleanUp } = await attachPolicy({
roleName: this.names.LAMBDA_EXECUTION_ROLE,
policyArn: lambdaExecutionPolicyArn,
iamClient: this.clients.IAM,
});
this.cleanUpFunctions.push(lambdaExecutionRolePolicyCleanUp);
await this.logger.log(MESSAGES.policyAttached);
this.logger.logSeparator();
// Create Lambda layer for SageMaker packages.
const { versionArn: layerVersionArn, cleanUp: lambdaLayerCleanUp } =
await createLambdaLayer({
name: this.names.LAMBDA_LAYER,
lambdaClient: this.clients.Lambda,
});
this.cleanUpFunctions.push(lambdaLayerCleanUp);
await this.logger.log(
MESSAGES.creatingFunction.replace(
"${FUNCTION_NAME}",
this.names.LAMBDA_FUNCTION,
),
);
// Create the Lambda function with the execution role.
const { arn: lambdaArn, cleanUp: lambdaCleanUp } =
await createLambdaFunction({
roleArn: lambdaExecutionRoleArn,
lambdaClient: this.clients.Lambda,
name: this.names.LAMBDA_FUNCTION,
layerVersionArn,
});
this.cleanUpFunctions.push(lambdaCleanUp);
await this.logger.log(
MESSAGES.functionCreated.replace(
"${FUNCTION_NAME}",
this.names.LAMBDA_FUNCTION,
),
);
this.logger.logSeparator();
await this.logger.log(
MESSAGES.creatingSQSQueue.replace("${QUEUE_NAME}", this.names.SQS_QUEUE),
);
// Create an SQS queue for the SageMaker pipeline.
const {
queueUrl,
queueArn,
cleanUp: queueCleanUp,
} = await createSQSQueue({
name: this.names.SQS_QUEUE,
sqsClient: this.clients.SQS,
});
this.cleanUpFunctions.push(queueCleanUp);
await this.logger.log(
MESSAGES.sqsQueueCreated.replace("${QUEUE_NAME}", this.names.SQS_QUEUE),
);
this.logger.logSeparator();
await this.logger.log(
MESSAGES.configuringLambdaSQSEventSource
.replace("${LAMBDA_NAME}", this.names.LAMBDA_FUNCTION)
.replace("${QUEUE_NAME}", this.names.SQS_QUEUE),
);
// Configure the SQS queue as an event source for the Lambda.
const { cleanUp: lambdaSQSEventSourceCleanUp } =
await configureLambdaSQSEventSource({
lambdaArn,
lambdaName: this.names.LAMBDA_FUNCTION,
queueArn,
sqsClient: this.clients.SQS,
lambdaClient: this.clients.Lambda,
});
this.cleanUpFunctions.push(lambdaSQSEventSourceCleanUp);
await this.logger.log(
MESSAGES.lambdaSQSEventSourceConfigured
.replace("${LAMBDA_NAME}", this.names.LAMBDA_FUNCTION)
.replace("${QUEUE_NAME}", this.names.SQS_QUEUE),
);
this.logger.logSeparator();
// Create an IAM policy that allows the SageMaker pipeline to invoke AWS Lambda
// and send messages to the Amazon SQS queue.
const {
arn: pipelineExecutionPolicyArn,
policy: sagemakerPolicy,
cleanUp: pipelineExecutionPolicyCleanUp,
} = await createSagemakerExecutionPolicy({
sqsQueueArn: queueArn,
lambdaArn,
iamClient: this.clients.IAM,
name: this.names.SAGE_MAKER_EXECUTION_ROLE_POLICY,
s3BucketName: this.names.S3_BUCKET,
});
this.cleanUpFunctions.push(pipelineExecutionPolicyCleanUp);
console.log(JSON.stringify(sagemakerPolicy, null, 2));
await this.logger.log(
MESSAGES.attachPolicy
.replace("${POLICY_NAME}", this.names.SAGE_MAKER_EXECUTION_ROLE_POLICY)
.replace("${ROLE_NAME}", this.names.SAGE_MAKER_EXECUTION_ROLE),
);
await this.prompter.checkContinue();
// Attach the SageMaker execution policy to the execution role.
const { cleanUp: pipelineExecutionRolePolicyCleanUp } = await attachPolicy({
roleName: this.names.SAGE_MAKER_EXECUTION_ROLE,
policyArn: pipelineExecutionPolicyArn,
iamClient: this.clients.IAM,
});
this.cleanUpFunctions.push(pipelineExecutionRolePolicyCleanUp);
// Wait for the role to be ready. If the role is used immediately,
// the pipeline will fail.
await wait(5);
await this.logger.log(MESSAGES.policyAttached);
this.logger.logSeparator();
await this.logger.log(
MESSAGES.creatingPipeline.replace(
"${PIPELINE_NAME}",
this.names.SAGE_MAKER_PIPELINE,
),
);
// Create the SageMaker pipeline.
const { cleanUp: pipelineCleanUp } = await createSagemakerPipeline({
roleArn: pipelineExecutionRoleArn,
functionArn: lambdaArn,
sagemakerClient: this.clients.SageMaker,
name: this.names.SAGE_MAKER_PIPELINE,
});
this.cleanUpFunctions.push(pipelineCleanUp);
await this.logger.log(
MESSAGES.pipelineCreated.replace(
"${PIPELINE_NAME}",
this.names.SAGE_MAKER_PIPELINE,
),
);
this.logger.logSeparator();
await this.logger.log(
MESSAGES.creatingS3Bucket.replace("${BUCKET_NAME}", this.names.S3_BUCKET),
);
// Create an S3 bucket for storing inputs and outputs.
const { cleanUp: s3BucketCleanUp } = await createS3Bucket({
name: this.names.S3_BUCKET,
s3Client: this.clients.S3,
});
this.cleanUpFunctions.push(s3BucketCleanUp);
await this.logger.log(
MESSAGES.s3BucketCreated.replace("${BUCKET_NAME}", this.names.S3_BUCKET),
);
this.logger.logSeparator();
await this.logger.log(
MESSAGES.uploadingInputData.replace(
"${BUCKET_NAME}",
this.names.S3_BUCKET,
),
);
// Upload CSV Lat/Long data to S3.
await uploadCSVDataToS3({
bucketName: this.names.S3_BUCKET,
s3Client: this.clients.S3,
});
await this.logger.log(MESSAGES.inputDataUploaded);
this.logger.logSeparator();
await this.prompter.checkContinue(MESSAGES.executePipeline);
// Execute the SageMaker pipeline.
const { arn: pipelineExecutionArn } = await startPipelineExecution({
name: this.names.SAGE_MAKER_PIPELINE,
sagemakerClient: this.clients.SageMaker,
roleArn: pipelineExecutionRoleArn,
bucketName: this.names.S3_BUCKET,
queueUrl,
});
// Wait for the pipeline execution to finish.
await waitForPipelineComplete({
arn: pipelineExecutionArn,
sagemakerClient: this.clients.SageMaker,
wait,
});
this.logger.logSeparator();
await this.logger.log(MESSAGES.outputDelay);
// The getOutput function will throw an error if the output is not
// found. The retry function will retry a failed function call once
// ever 10 seconds for 2 minutes.
const output = await retry({ intervalInMs: 10000, maxRetries: 12 }, () =>
getObject({
bucket: this.names.S3_BUCKET,
s3Client: this.clients.S3,
}),
);
this.logger.logSeparator();
await this.logger.log(MESSAGES.outputDataRetrieved);
console.log(output.split("\n").slice(0, 6).join("\n"));
}
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の以下のトピックを参照してください。
+ [CreatePipeline](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/CreatePipelineCommand)
+ [DeletePipeline](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DeletePipelineCommand)
+ [DescribePipelineExecution](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DescribePipelineExecutionCommand)
+ [StartPipelineExecution](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/StartPipelineExecutionCommand)
+ [UpdatePipeline](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/UpdatePipelineCommand)
# SDK for JavaScript (v3) を使用した Secrets Manager の例
次のコード例は、Secrets Manager で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `GetSecretValue`
次のコード例は、`GetSecretValue` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/secrets-manager#code-examples)での設定と実行の方法を確認してください。
```
import {
GetSecretValueCommand,
SecretsManagerClient,
} from "@aws-sdk/client-secrets-manager";
export const getSecretValue = async (secretName = "SECRET_NAME") => {
const client = new SecretsManagerClient();
const response = await client.send(
new GetSecretValueCommand({
SecretId: secretName,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '584eb612-f8b0-48c9-855e-6d246461b604',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// ARN: 'arn:aws:secretsmanager:us-east-1:xxxxxxxxxxxx:secret:binary-secret-3873048-xxxxxx',
// CreatedDate: 2023-08-08T19:29:51.294Z,
// Name: 'binary-secret-3873048',
// SecretBinary: Uint8Array(11) [
// 98, 105, 110, 97, 114,
// 121, 32, 100, 97, 116,
// 97
// ],
// VersionId: '712083f4-0d26-415e-8044-16735142cd6a',
// VersionStages: [ 'AWSCURRENT' ]
// }
if (response.SecretString) {
return response.SecretString;
}
if (response.SecretBinary) {
return response.SecretBinary;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[GetSecretValue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/secrets-manager/command/GetSecretValueCommand)」を参照してください。
# SDK for JavaScript (v3) を使用した Amazon SES の例
次のコード例は、Amazon SES で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
*シナリオ*は、1 つのサービス内から、または他の AWS のサービスと組み合わせて複数の関数を呼び出し、特定のタスクを実行する方法を示すコード例です。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
+ [シナリオ](#scenarios)
## アクション
### `CreateReceiptFilter`
次のコード例は、`CreateReceiptFilter` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import {
CreateReceiptFilterCommand,
ReceiptFilterPolicy,
} from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
const createCreateReceiptFilterCommand = ({ policy, ipOrRange, name }) => {
return new CreateReceiptFilterCommand({
Filter: {
IpFilter: {
Cidr: ipOrRange, // string, either a single IP address (10.0.0.1) or an IP address range in CIDR notation (10.0.0.1/24)).
Policy: policy, // enum ReceiptFilterPolicy, email traffic from the filtered addressesOptions.
},
/*
The name of the IP address filter. Only ASCII letters, numbers, underscores, or dashes.
Must be less than 64 characters and start and end with a letter or number.
*/
Name: name,
},
});
};
const FILTER_NAME = getUniqueName("ReceiptFilter");
const run = async () => {
const createReceiptFilterCommand = createCreateReceiptFilterCommand({
policy: ReceiptFilterPolicy.Allow,
ipOrRange: "10.0.0.1",
name: FILTER_NAME,
});
try {
return await sesClient.send(createReceiptFilterCommand);
} catch (caught) {
if (caught instanceof Error && caught.name === "MessageRejected") {
/** @type { import('@aws-sdk/client-ses').MessageRejected} */
const messageRejectedError = caught;
return messageRejectedError;
}
throw caught;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[CreateReceiptFilter](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/CreateReceiptFilterCommand)」を参照してください。
### `CreateReceiptRule`
次のコード例は、`CreateReceiptRule` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { CreateReceiptRuleCommand, TlsPolicy } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
const RULE_SET_NAME = getUniqueName("RuleSetName");
const RULE_NAME = getUniqueName("RuleName");
const S3_BUCKET_NAME = getUniqueName("S3BucketName");
const createS3ReceiptRuleCommand = ({
bucketName,
emailAddresses,
name,
ruleSet,
}) => {
return new CreateReceiptRuleCommand({
Rule: {
Actions: [
{
S3Action: {
BucketName: bucketName,
ObjectKeyPrefix: "email",
},
},
],
Recipients: emailAddresses,
Enabled: true,
Name: name,
ScanEnabled: false,
TlsPolicy: TlsPolicy.Optional,
},
RuleSetName: ruleSet, // Required
});
};
const run = async () => {
const s3ReceiptRuleCommand = createS3ReceiptRuleCommand({
bucketName: S3_BUCKET_NAME,
emailAddresses: ["email@example.com"],
name: RULE_NAME,
ruleSet: RULE_SET_NAME,
});
try {
return await sesClient.send(s3ReceiptRuleCommand);
} catch (err) {
console.log("Failed to create S3 receipt rule.", err);
throw err;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[CreateReceiptRule](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/CreateReceiptRuleCommand)」を参照してください。
### `CreateReceiptRuleSet`
次のコード例は、`CreateReceiptRuleSet` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { CreateReceiptRuleSetCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
const RULE_SET_NAME = getUniqueName("RuleSetName");
const createCreateReceiptRuleSetCommand = (ruleSetName) => {
return new CreateReceiptRuleSetCommand({ RuleSetName: ruleSetName });
};
const run = async () => {
const createReceiptRuleSetCommand =
createCreateReceiptRuleSetCommand(RULE_SET_NAME);
try {
return await sesClient.send(createReceiptRuleSetCommand);
} catch (err) {
console.log("Failed to create receipt rule set", err);
return err;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[CreateReceiptRuleSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/CreateReceiptRuleSetCommand)」を参照してください。
### `CreateTemplate`
次のコード例は、`CreateTemplate` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { CreateTemplateCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
const TEMPLATE_NAME = getUniqueName("TestTemplateName");
const createCreateTemplateCommand = () => {
return new CreateTemplateCommand({
/**
* The template feature in Amazon SES is based on the Handlebars template system.
*/
Template: {
/**
* The name of an existing template in Amazon SES.
*/
TemplateName: TEMPLATE_NAME,
HtmlPart: `
Hello, {{contact.firstName}}!
Did you know Amazon has a mascot named Peccy?
`,
SubjectPart: "Amazon Tip",
},
});
};
const run = async () => {
const createTemplateCommand = createCreateTemplateCommand();
try {
return await sesClient.send(createTemplateCommand);
} catch (err) {
console.log("Failed to create template.", err);
return err;
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[CreateTemplate](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/CreateTemplateCommand)」を参照してください。
### `DeleteIdentity`
次のコード例は、`DeleteIdentity` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { DeleteIdentityCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
const IDENTITY_EMAIL = "fake@example.com";
const createDeleteIdentityCommand = (identityName) => {
return new DeleteIdentityCommand({
Identity: identityName,
});
};
const run = async () => {
const deleteIdentityCommand = createDeleteIdentityCommand(IDENTITY_EMAIL);
try {
return await sesClient.send(deleteIdentityCommand);
} catch (err) {
console.log("Failed to delete identity.", err);
return err;
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DeleteIdentity](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/DeleteIdentityCommand)」を参照してください。
### `DeleteReceiptFilter`
次のコード例は、`DeleteReceiptFilter` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { DeleteReceiptFilterCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
const RECEIPT_FILTER_NAME = getUniqueName("ReceiptFilterName");
const createDeleteReceiptFilterCommand = (filterName) => {
return new DeleteReceiptFilterCommand({ FilterName: filterName });
};
const run = async () => {
const deleteReceiptFilterCommand =
createDeleteReceiptFilterCommand(RECEIPT_FILTER_NAME);
try {
return await sesClient.send(deleteReceiptFilterCommand);
} catch (err) {
console.log("Error deleting receipt filter.", err);
return err;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[DeleteReceiptFilter](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/DeleteReceiptFilterCommand)」を参照してください。
### `DeleteReceiptRule`
次のコード例は、`DeleteReceiptRule` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { DeleteReceiptRuleCommand } from "@aws-sdk/client-ses";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import { sesClient } from "./libs/sesClient.js";
const RULE_NAME = getUniqueName("RuleName");
const RULE_SET_NAME = getUniqueName("RuleSetName");
const createDeleteReceiptRuleCommand = () => {
return new DeleteReceiptRuleCommand({
RuleName: RULE_NAME,
RuleSetName: RULE_SET_NAME,
});
};
const run = async () => {
const deleteReceiptRuleCommand = createDeleteReceiptRuleCommand();
try {
return await sesClient.send(deleteReceiptRuleCommand);
} catch (err) {
console.log("Failed to delete receipt rule.", err);
return err;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[DeleteReceiptRule](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/DeleteReceiptRuleCommand)」を参照してください。
### `DeleteReceiptRuleSet`
次のコード例は、`DeleteReceiptRuleSet` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { DeleteReceiptRuleSetCommand } from "@aws-sdk/client-ses";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import { sesClient } from "./libs/sesClient.js";
const RULE_SET_NAME = getUniqueName("RuleSetName");
const createDeleteReceiptRuleSetCommand = () => {
return new DeleteReceiptRuleSetCommand({ RuleSetName: RULE_SET_NAME });
};
const run = async () => {
const deleteReceiptRuleSetCommand = createDeleteReceiptRuleSetCommand();
try {
return await sesClient.send(deleteReceiptRuleSetCommand);
} catch (err) {
console.log("Failed to delete receipt rule set.", err);
return err;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[DeleteReceiptRuleSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/DeleteReceiptRuleSetCommand)」を参照してください。
### `DeleteTemplate`
次のコード例は、`DeleteTemplate` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { DeleteTemplateCommand } from "@aws-sdk/client-ses";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import { sesClient } from "./libs/sesClient.js";
const TEMPLATE_NAME = getUniqueName("TemplateName");
const createDeleteTemplateCommand = (templateName) =>
new DeleteTemplateCommand({ TemplateName: templateName });
const run = async () => {
const deleteTemplateCommand = createDeleteTemplateCommand(TEMPLATE_NAME);
try {
return await sesClient.send(deleteTemplateCommand);
} catch (err) {
console.log("Failed to delete template.", err);
return err;
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*のの「[DeleteTemplate](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/DeleteTemplateCommand)」を参照してください。
### `GetTemplate`
次のコード例は、`GetTemplate` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { GetTemplateCommand } from "@aws-sdk/client-ses";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import { sesClient } from "./libs/sesClient.js";
const TEMPLATE_NAME = getUniqueName("TemplateName");
const createGetTemplateCommand = (templateName) =>
new GetTemplateCommand({ TemplateName: templateName });
const run = async () => {
const getTemplateCommand = createGetTemplateCommand(TEMPLATE_NAME);
try {
return await sesClient.send(getTemplateCommand);
} catch (caught) {
if (caught instanceof Error && caught.name === "MessageRejected") {
/** @type { import('@aws-sdk/client-ses').MessageRejected} */
const messageRejectedError = caught;
return messageRejectedError;
}
throw caught;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[GetTemplate](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/GetTemplateCommand)」を参照してください。
### `ListIdentities`
次のコード例は、`ListIdentities` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { ListIdentitiesCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
const createListIdentitiesCommand = () =>
new ListIdentitiesCommand({ IdentityType: "EmailAddress", MaxItems: 10 });
const run = async () => {
const listIdentitiesCommand = createListIdentitiesCommand();
try {
return await sesClient.send(listIdentitiesCommand);
} catch (err) {
console.log("Failed to list identities.", err);
return err;
}
};
```
+ API の詳細については、**AWS SDK for JavaScript API リファレンスの「[ListIdentities](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/ListIdentitiesCommand)」を参照してください。
### `ListReceiptFilters`
次のコード例は、`ListReceiptFilters` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { ListReceiptFiltersCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
const createListReceiptFiltersCommand = () => new ListReceiptFiltersCommand({});
const run = async () => {
const listReceiptFiltersCommand = createListReceiptFiltersCommand();
return await sesClient.send(listReceiptFiltersCommand);
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[ListReceiptFilters](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/ListReceiptFiltersCommand)」を参照してください。
### `ListTemplates`
次のコード例は、`ListTemplates` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { ListTemplatesCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
const createListTemplatesCommand = (maxItems) =>
new ListTemplatesCommand({ MaxItems: maxItems });
const run = async () => {
const listTemplatesCommand = createListTemplatesCommand(10);
try {
return await sesClient.send(listTemplatesCommand);
} catch (err) {
console.log("Failed to list templates.", err);
return err;
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[ListTemplates](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/ListTemplatesCommand)」を参照してください。
### `SendBulkTemplatedEmail`
次のコード例は、`SendBulkTemplatedEmail` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { SendBulkTemplatedEmailCommand } from "@aws-sdk/client-ses";
import {
getUniqueName,
postfix,
} from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import { sesClient } from "./libs/sesClient.js";
/**
* Replace this with the name of an existing template.
*/
const TEMPLATE_NAME = getUniqueName("ReminderTemplate");
/**
* Replace these with existing verified emails.
*/
const VERIFIED_EMAIL_1 = postfix(getUniqueName("Bilbo"), "@example.com");
const VERIFIED_EMAIL_2 = postfix(getUniqueName("Frodo"), "@example.com");
const USERS = [
{ firstName: "Bilbo", emailAddress: VERIFIED_EMAIL_1 },
{ firstName: "Frodo", emailAddress: VERIFIED_EMAIL_2 },
];
/**
*
* @param { { emailAddress: string, firstName: string }[] } users
* @param { string } templateName the name of an existing template in SES
* @returns { SendBulkTemplatedEmailCommand }
*/
const createBulkReminderEmailCommand = (users, templateName) => {
return new SendBulkTemplatedEmailCommand({
/**
* Each 'Destination' uses a corresponding set of replacement data. We can map each user
* to a 'Destination' and provide user specific replacement data to create personalized emails.
*
* Here's an example of how a template would be replaced with user data:
* Template: Hello {{name}},
Don't forget about the party gifts!
* Destination 1: Hello Bilbo,
Don't forget about the party gifts!
* Destination 2: Hello Frodo,
Don't forget about the party gifts!
*/
Destinations: users.map((user) => ({
Destination: { ToAddresses: [user.emailAddress] },
ReplacementTemplateData: JSON.stringify({ name: user.firstName }),
})),
DefaultTemplateData: JSON.stringify({ name: "Shireling" }),
Source: VERIFIED_EMAIL_1,
Template: templateName,
});
};
const run = async () => {
const sendBulkTemplateEmailCommand = createBulkReminderEmailCommand(
USERS,
TEMPLATE_NAME,
);
try {
return await sesClient.send(sendBulkTemplateEmailCommand);
} catch (caught) {
if (caught instanceof Error && caught.name === "MessageRejected") {
/** @type { import('@aws-sdk/client-ses').MessageRejected} */
const messageRejectedError = caught;
return messageRejectedError;
}
throw caught;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[SendBulkTemplatedEmail](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/SendBulkTemplatedEmailCommand)」を参照してください。
### `SendEmail`
次のコード例は、`SendEmail` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { SendEmailCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
const createSendEmailCommand = (toAddress, fromAddress) => {
return new SendEmailCommand({
Destination: {
/* required */
CcAddresses: [
/* more items */
],
ToAddresses: [
toAddress,
/* more To-email addresses */
],
},
Message: {
/* required */
Body: {
/* required */
Html: {
Charset: "UTF-8",
Data: "HTML_FORMAT_BODY",
},
Text: {
Charset: "UTF-8",
Data: "TEXT_FORMAT_BODY",
},
},
Subject: {
Charset: "UTF-8",
Data: "EMAIL_SUBJECT",
},
},
Source: fromAddress,
ReplyToAddresses: [
/* more items */
],
});
};
const run = async () => {
const sendEmailCommand = createSendEmailCommand(
"recipient@example.com",
"sender@example.com",
);
try {
return await sesClient.send(sendEmailCommand);
} catch (caught) {
if (caught instanceof Error && caught.name === "MessageRejected") {
/** @type { import('@aws-sdk/client-ses').MessageRejected} */
const messageRejectedError = caught;
return messageRejectedError;
}
throw caught;
}
};
```
+ API の詳細については、**AWS SDK for JavaScript API リファレンスの「[SendEmail](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/SendEmailCommand)」を参照してください。
### `SendRawEmail`
次のコード例は、`SendRawEmail` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
[nodemailer](https://nodemailer.com/transports/ses) を使用して、添付ファイル付きの E メールを送信します。
```
import sesClientModule from "@aws-sdk/client-ses";
/**
* nodemailer wraps the SES SDK and calls SendRawEmail. Use this for more advanced
* functionality like adding attachments to your email.
*
* https://nodemailer.com/transports/ses
*/
import nodemailer from "nodemailer";
/**
* @param {string} from An Amazon SES verified email address.
* @param {*} to An Amazon SES verified email address.
*/
export const sendEmailWithAttachments = (
from = "from@example.com",
to = "to@example.com",
) => {
const ses = new sesClientModule.SESClient({});
const transporter = nodemailer.createTransport({
SES: { ses, aws: sesClientModule },
});
return new Promise((resolve, reject) => {
transporter.sendMail(
{
from,
to,
subject: "Hello World",
text: "Greetings from Amazon SES!",
attachments: [{ content: "Hello World!", filename: "hello.txt" }],
},
(err, info) => {
if (err) {
reject(err);
} else {
resolve(info);
}
},
);
});
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[SendRawEmail](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/SendRawEmailCommand)」を参照してください。
### `SendTemplatedEmail`
次のコード例は、`SendTemplatedEmail` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { SendTemplatedEmailCommand } from "@aws-sdk/client-ses";
import {
getUniqueName,
postfix,
} from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import { sesClient } from "./libs/sesClient.js";
/**
* Replace this with the name of an existing template.
*/
const TEMPLATE_NAME = getUniqueName("ReminderTemplate");
/**
* Replace these with existing verified emails.
*/
const VERIFIED_EMAIL = postfix(getUniqueName("Bilbo"), "@example.com");
const USER = { firstName: "Bilbo", emailAddress: VERIFIED_EMAIL };
/**
*
* @param { { emailAddress: string, firstName: string } } user
* @param { string } templateName - The name of an existing template in Amazon SES.
* @returns { SendTemplatedEmailCommand }
*/
const createReminderEmailCommand = (user, templateName) => {
return new SendTemplatedEmailCommand({
/**
* Here's an example of how a template would be replaced with user data:
* Template: Hello {{contact.firstName}},
Don't forget about the party gifts!
* Destination: Hello Bilbo,
Don't forget about the party gifts!
*/
Destination: { ToAddresses: [user.emailAddress] },
TemplateData: JSON.stringify({ contact: { firstName: user.firstName } }),
Source: VERIFIED_EMAIL,
Template: templateName,
});
};
const run = async () => {
const sendReminderEmailCommand = createReminderEmailCommand(
USER,
TEMPLATE_NAME,
);
try {
return await sesClient.send(sendReminderEmailCommand);
} catch (caught) {
if (caught instanceof Error && caught.name === "MessageRejected") {
/** @type { import('@aws-sdk/client-ses').MessageRejected} */
const messageRejectedError = caught;
return messageRejectedError;
}
throw caught;
}
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[SendTemplatedEmail](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/SendTemplatedEmailCommand)」を参照してください。
### `UpdateTemplate`
次のコード例は、`UpdateTemplate` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { UpdateTemplateCommand } from "@aws-sdk/client-ses";
import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import { sesClient } from "./libs/sesClient.js";
const TEMPLATE_NAME = getUniqueName("TemplateName");
const HTML_PART = "Hello, World!
";
const createUpdateTemplateCommand = () => {
return new UpdateTemplateCommand({
Template: {
TemplateName: TEMPLATE_NAME,
HtmlPart: HTML_PART,
SubjectPart: "Example",
TextPart: "Updated template text.",
},
});
};
const run = async () => {
const updateTemplateCommand = createUpdateTemplateCommand();
try {
return await sesClient.send(updateTemplateCommand);
} catch (err) {
console.log("Failed to update template.", err);
return err;
}
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[UpdateTemplate](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/UpdateTemplateCommand)」を参照してください。
### `VerifyDomainIdentity`
次のコード例は、`VerifyDomainIdentity` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
import { VerifyDomainIdentityCommand } from "@aws-sdk/client-ses";
import {
getUniqueName,
postfix,
} from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import { sesClient } from "./libs/sesClient.js";
/**
* You must have access to the domain's DNS settings to complete the
* domain verification process.
*/
const DOMAIN_NAME = postfix(getUniqueName("Domain"), ".example.com");
const createVerifyDomainIdentityCommand = () => {
return new VerifyDomainIdentityCommand({ Domain: DOMAIN_NAME });
};
const run = async () => {
const VerifyDomainIdentityCommand = createVerifyDomainIdentityCommand();
try {
return await sesClient.send(VerifyDomainIdentityCommand);
} catch (err) {
console.log("Failed to verify domain.", err);
return err;
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[VerifyDomainIdentity](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/VerifyDomainIdentityCommand)」を参照してください。
### `VerifyEmailIdentity`
次のコード例は、`VerifyEmailIdentity` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ses#code-examples)での設定と実行の方法を確認してください。
```
// Import required AWS SDK clients and commands for Node.js
import { VerifyEmailIdentityCommand } from "@aws-sdk/client-ses";
import { sesClient } from "./libs/sesClient.js";
const EMAIL_ADDRESS = "name@example.com";
const createVerifyEmailIdentityCommand = (emailAddress) => {
return new VerifyEmailIdentityCommand({ EmailAddress: emailAddress });
};
const run = async () => {
const verifyEmailIdentityCommand =
createVerifyEmailIdentityCommand(EMAIL_ADDRESS);
try {
return await sesClient.send(verifyEmailIdentityCommand);
} catch (err) {
console.log("Failed to verify email identity.", err);
return err;
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[VerifyEmailIdentity](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ses/command/VerifyEmailIdentityCommand)」を参照してください。
## シナリオ
### Amazon Transcribe ストリーミングアプリケーションを構築する
次のコード例は、ライブ音声をリアルタイムで記録、転写、翻訳し、結果を E メールで送信するアプリケーションを構築する方法を示しています。
**SDK for JavaScript (v3)**
Amazon Transcribe を使用して、ライブ音声をリアルタイムで記録、転写、翻訳し、Amazon Simple Email Service (Amazon SES) を使用して結果を E メールで送信するアプリケーションを構築する方法について説明します。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/transcribe-streaming-app) で完全な例を参照してください。
**この例で使用されているサービス**
+ Amazon Comprehend
+ Amazon SES
+ Amazon Transcribe
+ Amazon Translate
### Aurora Serverless 作業項目トラッカーの作成
次のコード例は、Amazon Aurora Serverless データベースの作業項目を追跡し、Amazon Simple Email Service (Amazon SES) を使用してレポートを送信するウェブアプリケーションを作成する方法を示しています。
**SDK for JavaScript (v3)**
AWS SDK for JavaScript (v3) を使用して Amazon Aurora データベース内の作業項目を追跡し、Amazon Simple Email Service (Amazon SES) を使用してレポートを E メールで送信するウェブアプリケーションを作成する方法を示します。この例では、React.js で構築されたフロントエンドを使用して Express Node.js バックエンドと対話します。
+ React.js ウェブアプリケーションを と統合します AWS のサービス。
+ Aurora テーブルの項目を一覧表示、追加、更新します。
+ Amazon SES を使用して、フィルター処理された作業項目の E メールレポートを送信します。
+ 含まれている AWS CloudFormation スクリプトを使用してサンプルリソースをデプロイおよび管理します。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/aurora-serverless-app) で完全な例を参照してください。
**この例で使用されているサービス**
+ Aurora
+ Amazon RDS
+ Amazon RDS データサービス
+ Amazon SES
### 画像内のオブジェクトを検出する
次のコード例は、Amazon Rekognition を使用して画像内でカテゴリ別にオブジェクトを検出するアプリケーションを構築する方法を示しています。
**SDK for JavaScript (v3)**
で Amazon Rekognition を使用して、Amazon Rekognition を使用して Amazon Simple Storage Service (Amazon S3) バケットにあるイメージ内のオブジェクトをカテゴリ別に識別するアプリケーション AWS SDK for JavaScript を作成する方法を示します。アプリケーションは Amazon Simple Email Service (Amazon SES) を使用して、結果を含む E メール通知を管理者に送信します。
以下ではその方法を説明しています。
+ Amazon Cognito を使用して認証されていないユーザーを作成します。
+ Amazon Rekognition を使用して、オブジェクトのイメージを分析します。
+ Amazon SES の E メールアドレスを検証します。
+ Amazon SES を使用して、E メール通知を送信します。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/photo_analyzer) で完全な例を参照してください。
**この例で使用されているサービス**
+ Amazon Rekognition
+ Amazon S3
+ Amazon SES
# SDK for JavaScript (v3) を使用した Amazon SNS の例
次のコード例は、Amazon SNS で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
*シナリオ*は、1 つのサービス内から、または他の AWS のサービスと組み合わせて複数の関数を呼び出し、特定のタスクを実行する方法を示すコード例です。
各例には完全なソースコードへのリンクが含まれており、コンテキスト内でコードを設定および実行する方法の手順を確認できます。
**Topics**
+ [はじめに](#get_started)
+ [アクション](#actions)
+ [シナリオ](#scenarios)
+ [サーバーレスサンプル](#serverless_examples)
## はじめに
### Hello Amazon SNS
次のコード例は、Amazon SNS の使用を開始する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
SNS クライアントを初期化し、アカウントのトピックを一覧表示します。
```
import { SNSClient, paginateListTopics } from "@aws-sdk/client-sns";
export const helloSns = async () => {
// The configuration object (`{}`) is required. If the region and credentials
// are omitted, the SDK uses your local configuration if it exists.
const client = new SNSClient({});
// You can also use `ListTopicsCommand`, but to use that command you must
// handle the pagination yourself. You can do that by sending the `ListTopicsCommand`
// with the `NextToken` parameter from the previous request.
const paginatedTopics = paginateListTopics({ client }, {});
const topics = [];
for await (const page of paginatedTopics) {
if (page.Topics?.length) {
topics.push(...page.Topics);
}
}
const suffix = topics.length === 1 ? "" : "s";
console.log(
`Hello, Amazon SNS! You have ${topics.length} topic${suffix} in your account.`,
);
console.log(topics.map((t) => ` * ${t.TopicArn}`).join("\n"));
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[ListTopics](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/ListTopicsCommand)」を参照してください。
## アクション
### `CheckIfPhoneNumberIsOptedOut`
次のコード例は、`CheckIfPhoneNumberIsOptedOut` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { CheckIfPhoneNumberIsOptedOutCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
export const checkIfPhoneNumberIsOptedOut = async (
phoneNumber = "5555555555",
) => {
const command = new CheckIfPhoneNumberIsOptedOutCommand({
phoneNumber,
});
const response = await snsClient.send(command);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '3341c28a-cdc8-5b39-a3ee-9fb0ee125732',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// isOptedOut: false
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-sending-sms.html#sending-sms-checkifphonenumberisoptedout)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[CheckIfPhoneNumberIsOptedOut](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/CheckIfPhoneNumberIsOptedOutCommand)」を参照してください。
### `ConfirmSubscription`
次のコード例は、`ConfirmSubscription` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { ConfirmSubscriptionCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} token - This token is sent the subscriber. Only subscribers
* that are not AWS services (HTTP/S, email) need to be confirmed.
* @param {string} topicArn - The ARN of the topic for which you wish to confirm a subscription.
*/
export const confirmSubscription = async (
token = "TOKEN",
topicArn = "TOPIC_ARN",
) => {
const response = await snsClient.send(
// A subscription only needs to be confirmed if the endpoint type is
// HTTP/S, email, or in another AWS account.
new ConfirmSubscriptionCommand({
Token: token,
TopicArn: topicArn,
// If this is true, the subscriber cannot unsubscribe while unauthenticated.
AuthenticateOnUnsubscribe: "false",
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '4bb5bce9-805a-5517-8333-e1d2cface90b',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// SubscriptionArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:TOPIC_NAME:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-sending-sms.html#sending-sms-getattributes)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[ConfirmSubscription](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/ConfirmSubscriptionCommand)」を参照してください。
### `CreateTopic`
次のコード例は、`CreateTopic` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { CreateTopicCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} topicName - The name of the topic to create.
*/
export const createTopic = async (topicName = "TOPIC_NAME") => {
const response = await snsClient.send(
new CreateTopicCommand({ Name: topicName }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '087b8ad2-4593-50c4-a496-d7e90b82cf3e',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// TopicArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:TOPIC_NAME'
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-managing-topics.html#sns-examples-managing-topics-createtopic)」を参照してください。
+ API の詳細については、AWS SDK for JavaScript API リファレンスの**「[CreateTopic](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/CreateTopicCommand)」を参照してください。
### `DeleteTopic`
次のコード例は、`DeleteTopic` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { DeleteTopicCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} topicArn - The ARN of the topic to delete.
*/
export const deleteTopic = async (topicArn = "TOPIC_ARN") => {
const response = await snsClient.send(
new DeleteTopicCommand({ TopicArn: topicArn }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'a10e2886-5a8f-5114-af36-75bd39498332',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// }
// }
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-managing-topics.html#sns-examples-managing-topics-deletetopic)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DeleteTopic](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/DeleteTopicCommand)」を参照してください。
### `GetSMSAttributes`
次のコード例は、`GetSMSAttributes` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { GetSMSAttributesCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
export const getSmsAttributes = async () => {
const response = await snsClient.send(
// If you have not modified the account-level mobile settings of SNS,
// the DefaultSMSType is undefined. For this example, it was set to
// Transactional.
new GetSMSAttributesCommand({ attributes: ["DefaultSMSType"] }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '67ad8386-4169-58f1-bdb9-debd281d48d5',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// attributes: { DefaultSMSType: 'Transactional' }
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-subscribing-unubscribing-topics.html#sns-confirm-subscription-email)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[GetSMSAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/GetSMSAttributesCommand)」を参照してください。
### `GetTopicAttributes`
次のコード例は、`GetTopicAttributes` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { GetTopicAttributesCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} topicArn - The ARN of the topic to retrieve attributes for.
*/
export const getTopicAttributes = async (topicArn = "TOPIC_ARN") => {
const response = await snsClient.send(
new GetTopicAttributesCommand({
TopicArn: topicArn,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '36b6a24e-5473-5d4e-ac32-ff72d9a73d94',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// Attributes: {
// Policy: '{...}',
// Owner: 'xxxxxxxxxxxx',
// SubscriptionsPending: '1',
// TopicArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:mytopic',
// TracingConfig: 'PassThrough',
// EffectiveDeliveryPolicy: '{"http":{"defaultHealthyRetryPolicy":{"minDelayTarget":20,"maxDelayTarget":20,"numRetries":3,"numMaxDelayRetries":0,"numNoDelayRetries":0,"numMinDelayRetries":0,"backoffFunction":"linear"},"disableSubscriptionOverrides":false,"defaultRequestPolicy":{"headerContentType":"text/plain; charset=UTF-8"}}}',
// SubscriptionsConfirmed: '0',
// DisplayName: '',
// SubscriptionsDeleted: '1'
// }
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-managing-topics.html#sns-examples-managing-topicsgetttopicattributes)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[GetTopicAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/GetTopicAttributesCommand)」を参照してください。
### `ListSubscriptions`
次のコード例は、`ListSubscriptions` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { ListSubscriptionsByTopicCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} topicArn - The ARN of the topic for which you wish to list subscriptions.
*/
export const listSubscriptionsByTopic = async (topicArn = "TOPIC_ARN") => {
const response = await snsClient.send(
new ListSubscriptionsByTopicCommand({ TopicArn: topicArn }),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '0934fedf-0c4b-572e-9ed2-a3e38fadb0c8',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// Subscriptions: [
// {
// SubscriptionArn: 'PendingConfirmation',
// Owner: '901487484989',
// Protocol: 'email',
// Endpoint: 'corepyle@amazon.com',
// TopicArn: 'arn:aws:sns:us-east-1:901487484989:mytopic'
// }
// ]
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-managing-topics.html#sns-examples-managing-topicsgetttopicattributes)」を参照してください。
+ API の詳細については、AWS SDK for JavaScript API リファレンスの「[ListSubscriptions](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/ListSubscriptionsCommand)」を参照してください。**
### `ListTopics`
次のコード例は、`ListTopics` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { ListTopicsCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
export const listTopics = async () => {
const response = await snsClient.send(new ListTopicsCommand({}));
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '936bc5ad-83ca-53c2-b0b7-9891167b909e',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// Topics: [ { TopicArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:mytopic' } ]
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-managing-topics.html#sns-examples-managing-topics-listtopics)」を参照してください。
+ API の詳細については、**AWS SDK for JavaScript API リファレンスの「[ListTopics](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/ListTopicsCommand)」を参照してください。
### `Publish`
次のコード例は、`Publish` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { PublishCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string | Record} message - The message to send. Can be a plain string or an object
* if you are using the `json` `MessageStructure`.
* @param {string} topicArn - The ARN of the topic to which you would like to publish.
*/
export const publish = async (
message = "Hello from SNS!",
topicArn = "TOPIC_ARN",
) => {
const response = await snsClient.send(
new PublishCommand({
Message: message,
TopicArn: topicArn,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'e7f77526-e295-5325-9ee4-281a43ad1f05',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// MessageId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
// }
return response;
};
```
グループ、重複、属性のオプションを指定してトピックにメッセージを発行します。
```
async publishMessages() {
const message = await this.prompter.input({
message: MESSAGES.publishMessagePrompt,
});
let groupId;
let deduplicationId;
let choices;
if (this.isFifo) {
await this.logger.log(MESSAGES.groupIdNotice);
groupId = await this.prompter.input({
message: MESSAGES.groupIdPrompt,
});
if (this.autoDedup === false) {
await this.logger.log(MESSAGES.deduplicationIdNotice);
deduplicationId = await this.prompter.input({
message: MESSAGES.deduplicationIdPrompt,
});
}
choices = await this.prompter.checkbox({
message: MESSAGES.messageAttributesPrompt,
choices: toneChoices,
});
}
await this.snsClient.send(
new PublishCommand({
TopicArn: this.topicArn,
Message: message,
...(groupId
? {
MessageGroupId: groupId,
}
: {}),
...(deduplicationId
? {
MessageDeduplicationId: deduplicationId,
}
: {}),
...(choices
? {
MessageAttributes: {
tone: {
DataType: "String.Array",
StringValue: JSON.stringify(choices),
},
},
}
: {}),
}),
);
const publishAnother = await this.prompter.confirm({
message: MESSAGES.publishAnother,
});
if (publishAnother) {
await this.publishMessages();
}
}
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-publishing-messages.html)」を参照してください。
+ API の詳細については、AWS SDK for JavaScript API リファレンスの「[Publish](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/PublishCommand)」を参照してください。**
### `SetSMSAttributes`
次のコード例は、`SetSMSAttributes` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { SetSMSAttributesCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {"Transactional" | "Promotional"} defaultSmsType
*/
export const setSmsType = async (defaultSmsType = "Transactional") => {
const response = await snsClient.send(
new SetSMSAttributesCommand({
attributes: {
// Promotional – (Default) Noncritical messages, such as marketing messages.
// Transactional – Critical messages that support customer transactions,
// such as one-time passcodes for multi-factor authentication.
DefaultSMSType: defaultSmsType,
},
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '1885b977-2d7e-535e-8214-e44be727e265',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// }
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-sending-sms.html#sending-sms-setattributes)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[SetSMSAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/SetSMSAttributesCommand)」を参照してください。
### `SetTopicAttributes`
次のコード例は、`SetTopicAttributes` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { SetTopicAttributesCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
export const setTopicAttributes = async (
topicArn = "TOPIC_ARN",
attributeName = "DisplayName",
attributeValue = "Test Topic",
) => {
const response = await snsClient.send(
new SetTopicAttributesCommand({
AttributeName: attributeName,
AttributeValue: attributeValue,
TopicArn: topicArn,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'd1b08d0e-e9a4-54c3-b8b1-d03238d2b935',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// }
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-managing-topics.html#sns-examples-managing-topicsstttopicattributes)」を参照してください。
+ API の詳細については、**AWS SDK for JavaScript API リファレンスの「[SetTopicAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/SetTopicAttributesCommand)」を参照してください。
### `Subscribe`
次のコード例は、`Subscribe` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { SubscribeCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} topicArn - The ARN of the topic for which you wish to confirm a subscription.
* @param {string} emailAddress - The email address that is subscribed to the topic.
*/
export const subscribeEmail = async (
topicArn = "TOPIC_ARN",
emailAddress = "usern@me.com",
) => {
const response = await snsClient.send(
new SubscribeCommand({
Protocol: "email",
TopicArn: topicArn,
Endpoint: emailAddress,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'c8e35bcd-b3c0-5940-9f66-06f6fcc108f0',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// SubscriptionArn: 'pending confirmation'
// }
};
```
モバイルアプリケーションをトピックにサブスクライブします。
```
import { SubscribeCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} topicArn - The ARN of the topic the subscriber is subscribing to.
* @param {string} endpoint - The Endpoint ARN of an application. This endpoint is created
* when an application registers for notifications.
*/
export const subscribeApp = async (
topicArn = "TOPIC_ARN",
endpoint = "ENDPOINT",
) => {
const response = await snsClient.send(
new SubscribeCommand({
Protocol: "application",
TopicArn: topicArn,
Endpoint: endpoint,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'c8e35bcd-b3c0-5940-9f66-06f6fcc108f0',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// SubscriptionArn: 'pending confirmation'
// }
return response;
};
```
Lambda 関数をトピックにサブスクライブします。
```
import { SubscribeCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} topicArn - The ARN of the topic the subscriber is subscribing to.
* @param {string} endpoint - The Endpoint ARN of and AWS Lambda function.
*/
export const subscribeLambda = async (
topicArn = "TOPIC_ARN",
endpoint = "ENDPOINT",
) => {
const response = await snsClient.send(
new SubscribeCommand({
Protocol: "lambda",
TopicArn: topicArn,
Endpoint: endpoint,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'c8e35bcd-b3c0-5940-9f66-06f6fcc108f0',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// SubscriptionArn: 'pending confirmation'
// }
return response;
};
```
SQS キューをトピックにサブスクライブします。
```
import { SubscribeCommand, SNSClient } from "@aws-sdk/client-sns";
const client = new SNSClient({});
export const subscribeQueue = async (
topicArn = "TOPIC_ARN",
queueArn = "QUEUE_ARN",
) => {
const command = new SubscribeCommand({
TopicArn: topicArn,
Protocol: "sqs",
Endpoint: queueArn,
});
const response = await client.send(command);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '931e13d9-5e2b-543f-8781-4e9e494c5ff2',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// SubscriptionArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:subscribe-queue-test-430895:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
// }
return response;
};
```
トピックにフィルターでサブスクライブします。
```
import { SubscribeCommand, SNSClient } from "@aws-sdk/client-sns";
const client = new SNSClient({});
export const subscribeQueueFiltered = async (
topicArn = "TOPIC_ARN",
queueArn = "QUEUE_ARN",
) => {
const command = new SubscribeCommand({
TopicArn: topicArn,
Protocol: "sqs",
Endpoint: queueArn,
Attributes: {
// This subscription will only receive messages with the 'event' attribute set to 'order_placed'.
FilterPolicyScope: "MessageAttributes",
FilterPolicy: JSON.stringify({
event: ["order_placed"],
}),
},
});
const response = await client.send(command);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '931e13d9-5e2b-543f-8781-4e9e494c5ff2',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// SubscriptionArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:subscribe-queue-test-430895:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-managing-topics.html#sns-examples-subscribing-email)」を参照してください。
+ API の詳細については、AWS SDK for JavaScript API リファレンスの「[Subscribe](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/SubscribeCommand)」を参照してください。**
### `Unsubscribe`
次のコード例は、`Unsubscribe` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sns#code-examples)での設定と実行の方法を確認してください。
別のモジュールでクライアントを作成し、エクスポートします。
```
import { SNSClient } from "@aws-sdk/client-sns";
// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});
```
SDK モジュールとクライアントモジュールをインポートし、API を呼び出します。
```
import { UnsubscribeCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";
/**
* @param {string} subscriptionArn - The ARN of the subscription to cancel.
*/
const unsubscribe = async (
subscriptionArn = "arn:aws:sns:us-east-1:xxxxxxxxxxxx:mytopic:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
) => {
const response = await snsClient.send(
new UnsubscribeCommand({
SubscriptionArn: subscriptionArn,
}),
);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '0178259a-9204-507c-b620-78a7570a44c6',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// }
// }
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sns-examples-managing-topics.html#sns-examples-unsubscribing)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[Unsubscribe](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/UnsubscribeCommand)」を参照してください。
## シナリオ
### DynamoDB テーブルにデータを送信するアプリケーションを構築する
次のコード例は、Amazon DynamoDB テーブルにデータを送信し、ユーザーがテーブルを更新したときに通知するアプリケーションを構築する方法を示しています。
**SDK for JavaScript (v3)**
この例では、ユーザーが Amazon DynamoDB テーブルにデータを送信し、Amazon Simple Notification Service (Amazon SNS) を使用して管理者にテキストメッセージを送信できるようにするアプリを構築する方法を示します。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/submit-data-app) で完全な例を参照してください。
この例は、[AWS SDK for JavaScript v3 デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/cross-service-example-submitting-data.html)でも使用できます。
**この例で使用されているサービス**
+ DynamoDB
+ Amazon SNS
### サーバーレスアプリケーションを作成して写真を管理する
次のコード例では、ユーザーがラベルを使用して写真を管理できるサーバーレスアプリケーションを作成する方法について示しています。
**SDK for JavaScript (v3)**
Amazon Rekognition を使用して画像内のラベルを検出し、保存して後で取得できるようにする写真アセット管理アプリケーションの開発方法を示します。
完全なソースコードと設定および実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/photo-asset-manager) で完全な例を参照してください。
この例のソースについて詳しくは、[AWS コミュニティ](https://community.aws/posts/cloud-journeys/01-serverless-image-recognition-app)でブログ投稿を参照してください。
**この例で使用されているサービス**
+ API ゲートウェイ
+ DynamoDB
+ Lambda
+ Amazon Rekognition
+ Amazon S3
+ Amazon SNS
### Amazon Textract エクスプローラーアプリケーションを作成する
次のコード例は、インタラクティブアプリケーションで Amazon Textract の出力を調べる方法を示しています。
**SDK for JavaScript (v3)**
を使用して、Amazon Textract を使用してドキュメントイメージからデータを抽出し、インタラクティブなウェブページに表示する React アプリケーション AWS SDK for JavaScript を構築する方法を示します。この例はウェブブラウザで実行され、認証情報に認証された Amazon Cognito ID が必要です。Amazon Simple Storage Service (Amazon S3) をストレージに使用し、通知のために、Amazon Simple Notification Service (Amazon SNS) トピックにサブスクライブした Amazon Simple Queue Service (Amazon SQS) キューをポーリングします。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/textract-react) で完全な例を参照してください。
**この例で使用されているサービス**
+ Amazon Cognito ID
+ Amazon S3
+ Amazon SNS
+ Amazon SQS
+ Amazon Textract
### メッセージをキューに発行する
次のコード例は、以下の操作方法を示しています。
+ トピック (FIFO または非 FIFO) を作成します。
+ フィルターを適用するオプションを使用して、複数のキューをトピックにサブスクライブします。
+ メッセージをトピックに発行します。
+ 受信したメッセージのキューをポーリングします。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/wkflw-topics-queues#code-examples)での設定と実行の方法を確認してください。
これがこのシナリオのエントリーポイントです。
```
import { SNSClient } from "@aws-sdk/client-sns";
import { SQSClient } from "@aws-sdk/client-sqs";
import { TopicsQueuesWkflw } from "./TopicsQueuesWkflw.js";
import { Prompter } from "@aws-doc-sdk-examples/lib/prompter.js";
export const startSnsWorkflow = () => {
const snsClient = new SNSClient({});
const sqsClient = new SQSClient({});
const prompter = new Prompter();
const logger = console;
const wkflw = new TopicsQueuesWkflw(snsClient, sqsClient, prompter, logger);
wkflw.start();
};
```
上記のコードにより必要な依存関係が提供され、シナリオが開始されます。次のセクションには、この例の大部分が含まれています。
```
const toneChoices = [
{ name: "cheerful", value: "cheerful" },
{ name: "funny", value: "funny" },
{ name: "serious", value: "serious" },
{ name: "sincere", value: "sincere" },
];
export class TopicsQueuesWkflw {
// SNS topic is configured as First-In-First-Out
isFifo = true;
// Automatic content-based deduplication is enabled.
autoDedup = false;
snsClient;
sqsClient;
topicName;
topicArn;
subscriptionArns = [];
/**
* @type {{ queueName: string, queueArn: string, queueUrl: string, policy?: string }[]}
*/
queues = [];
prompter;
/**
* @param {import('@aws-sdk/client-sns').SNSClient} snsClient
* @param {import('@aws-sdk/client-sqs').SQSClient} sqsClient
* @param {import('../../libs/prompter.js').Prompter} prompter
* @param {import('../../libs/logger.js').Logger} logger
*/
constructor(snsClient, sqsClient, prompter, logger) {
this.snsClient = snsClient;
this.sqsClient = sqsClient;
this.prompter = prompter;
this.logger = logger;
}
async welcome() {
await this.logger.log(MESSAGES.description);
}
async confirmFifo() {
await this.logger.log(MESSAGES.snsFifoDescription);
this.isFifo = await this.prompter.confirm({
message: MESSAGES.snsFifoPrompt,
});
if (this.isFifo) {
this.logger.logSeparator(MESSAGES.headerDedup);
await this.logger.log(MESSAGES.deduplicationNotice);
await this.logger.log(MESSAGES.deduplicationDescription);
this.autoDedup = await this.prompter.confirm({
message: MESSAGES.deduplicationPrompt,
});
}
}
async createTopic() {
await this.logger.log(MESSAGES.creatingTopics);
this.topicName = await this.prompter.input({
message: MESSAGES.topicNamePrompt,
});
if (this.isFifo) {
this.topicName += ".fifo";
this.logger.logSeparator(MESSAGES.headerFifoNaming);
await this.logger.log(MESSAGES.appendFifoNotice);
}
const response = await this.snsClient.send(
new CreateTopicCommand({
Name: this.topicName,
Attributes: {
FifoTopic: this.isFifo ? "true" : "false",
...(this.autoDedup ? { ContentBasedDeduplication: "true" } : {}),
},
}),
);
this.topicArn = response.TopicArn;
await this.logger.log(
MESSAGES.topicCreatedNotice
.replace("${TOPIC_NAME}", this.topicName)
.replace("${TOPIC_ARN}", this.topicArn),
);
}
async createQueues() {
await this.logger.log(MESSAGES.createQueuesNotice);
// Increase this number to add more queues.
const maxQueues = 2;
for (let i = 0; i < maxQueues; i++) {
await this.logger.log(MESSAGES.queueCount.replace("${COUNT}", i + 1));
let queueName = await this.prompter.input({
message: MESSAGES.queueNamePrompt.replace(
"${EXAMPLE_NAME}",
i === 0 ? "good-news" : "bad-news",
),
});
if (this.isFifo) {
queueName += ".fifo";
await this.logger.log(MESSAGES.appendFifoNotice);
}
const response = await this.sqsClient.send(
new CreateQueueCommand({
QueueName: queueName,
Attributes: { ...(this.isFifo ? { FifoQueue: "true" } : {}) },
}),
);
const { Attributes } = await this.sqsClient.send(
new GetQueueAttributesCommand({
QueueUrl: response.QueueUrl,
AttributeNames: ["QueueArn"],
}),
);
this.queues.push({
queueName,
queueArn: Attributes.QueueArn,
queueUrl: response.QueueUrl,
});
await this.logger.log(
MESSAGES.queueCreatedNotice
.replace("${QUEUE_NAME}", queueName)
.replace("${QUEUE_URL}", response.QueueUrl)
.replace("${QUEUE_ARN}", Attributes.QueueArn),
);
}
}
async attachQueueIamPolicies() {
for (const [index, queue] of this.queues.entries()) {
const policy = JSON.stringify(
{
Statement: [
{
Effect: "Allow",
Principal: {
Service: "sns.amazonaws.com",
},
Action: "sqs:SendMessage",
Resource: queue.queueArn,
Condition: {
ArnEquals: {
"aws:SourceArn": this.topicArn,
},
},
},
],
},
null,
2,
);
if (index !== 0) {
this.logger.logSeparator();
}
await this.logger.log(MESSAGES.attachPolicyNotice);
console.log(policy);
const addPolicy = await this.prompter.confirm({
message: MESSAGES.addPolicyConfirmation.replace(
"${QUEUE_NAME}",
queue.queueName,
),
});
if (addPolicy) {
await this.sqsClient.send(
new SetQueueAttributesCommand({
QueueUrl: queue.queueUrl,
Attributes: {
Policy: policy,
},
}),
);
queue.policy = policy;
} else {
await this.logger.log(
MESSAGES.policyNotAttachedNotice.replace(
"${QUEUE_NAME}",
queue.queueName,
),
);
}
}
}
async subscribeQueuesToTopic() {
for (const [index, queue] of this.queues.entries()) {
/**
* @type {import('@aws-sdk/client-sns').SubscribeCommandInput}
*/
const subscribeParams = {
TopicArn: this.topicArn,
Protocol: "sqs",
Endpoint: queue.queueArn,
};
let tones = [];
if (this.isFifo) {
if (index === 0) {
await this.logger.log(MESSAGES.fifoFilterNotice);
}
tones = await this.prompter.checkbox({
message: MESSAGES.fifoFilterSelect.replace(
"${QUEUE_NAME}",
queue.queueName,
),
choices: toneChoices,
});
if (tones.length) {
subscribeParams.Attributes = {
FilterPolicyScope: "MessageAttributes",
FilterPolicy: JSON.stringify({
tone: tones,
}),
};
}
}
const { SubscriptionArn } = await this.snsClient.send(
new SubscribeCommand(subscribeParams),
);
this.subscriptionArns.push(SubscriptionArn);
await this.logger.log(
MESSAGES.queueSubscribedNotice
.replace("${QUEUE_NAME}", queue.queueName)
.replace("${TOPIC_NAME}", this.topicName)
.replace("${TONES}", tones.length ? tones.join(", ") : "none"),
);
}
}
async publishMessages() {
const message = await this.prompter.input({
message: MESSAGES.publishMessagePrompt,
});
let groupId;
let deduplicationId;
let choices;
if (this.isFifo) {
await this.logger.log(MESSAGES.groupIdNotice);
groupId = await this.prompter.input({
message: MESSAGES.groupIdPrompt,
});
if (this.autoDedup === false) {
await this.logger.log(MESSAGES.deduplicationIdNotice);
deduplicationId = await this.prompter.input({
message: MESSAGES.deduplicationIdPrompt,
});
}
choices = await this.prompter.checkbox({
message: MESSAGES.messageAttributesPrompt,
choices: toneChoices,
});
}
await this.snsClient.send(
new PublishCommand({
TopicArn: this.topicArn,
Message: message,
...(groupId
? {
MessageGroupId: groupId,
}
: {}),
...(deduplicationId
? {
MessageDeduplicationId: deduplicationId,
}
: {}),
...(choices
? {
MessageAttributes: {
tone: {
DataType: "String.Array",
StringValue: JSON.stringify(choices),
},
},
}
: {}),
}),
);
const publishAnother = await this.prompter.confirm({
message: MESSAGES.publishAnother,
});
if (publishAnother) {
await this.publishMessages();
}
}
async receiveAndDeleteMessages() {
for (const queue of this.queues) {
const { Messages } = await this.sqsClient.send(
new ReceiveMessageCommand({
QueueUrl: queue.queueUrl,
}),
);
if (Messages) {
await this.logger.log(
MESSAGES.messagesReceivedNotice.replace(
"${QUEUE_NAME}",
queue.queueName,
),
);
console.log(Messages);
await this.sqsClient.send(
new DeleteMessageBatchCommand({
QueueUrl: queue.queueUrl,
Entries: Messages.map((message) => ({
Id: message.MessageId,
ReceiptHandle: message.ReceiptHandle,
})),
}),
);
} else {
await this.logger.log(
MESSAGES.noMessagesReceivedNotice.replace(
"${QUEUE_NAME}",
queue.queueName,
),
);
}
}
const deleteAndPoll = await this.prompter.confirm({
message: MESSAGES.deleteAndPollConfirmation,
});
if (deleteAndPoll) {
await this.receiveAndDeleteMessages();
}
}
async destroyResources() {
for (const subscriptionArn of this.subscriptionArns) {
await this.snsClient.send(
new UnsubscribeCommand({ SubscriptionArn: subscriptionArn }),
);
}
for (const queue of this.queues) {
await this.sqsClient.send(
new DeleteQueueCommand({ QueueUrl: queue.queueUrl }),
);
}
if (this.topicArn) {
await this.snsClient.send(
new DeleteTopicCommand({ TopicArn: this.topicArn }),
);
}
}
async start() {
console.clear();
try {
this.logger.logSeparator(MESSAGES.headerWelcome);
await this.welcome();
this.logger.logSeparator(MESSAGES.headerFifo);
await this.confirmFifo();
this.logger.logSeparator(MESSAGES.headerCreateTopic);
await this.createTopic();
this.logger.logSeparator(MESSAGES.headerCreateQueues);
await this.createQueues();
this.logger.logSeparator(MESSAGES.headerAttachPolicy);
await this.attachQueueIamPolicies();
this.logger.logSeparator(MESSAGES.headerSubscribeQueues);
await this.subscribeQueuesToTopic();
this.logger.logSeparator(MESSAGES.headerPublishMessage);
await this.publishMessages();
this.logger.logSeparator(MESSAGES.headerReceiveMessages);
await this.receiveAndDeleteMessages();
} catch (err) {
console.error(err);
} finally {
await this.destroyResources();
}
}
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の以下のトピックを参照してください。
+ [CreateQueue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/CreateQueueCommand)
+ [CreateTopic](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/CreateTopicCommand)
+ [DeleteMessageBatch](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/DeleteMessageBatchCommand)
+ [DeleteQueue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/DeleteQueueCommand)
+ [DeleteTopic](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/DeleteTopicCommand)
+ [GetQueueAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/GetQueueAttributesCommand)
+ [Publish](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/PublishCommand)
+ [ReceiveMessage](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/ReceiveMessageCommand)
+ [SetQueueAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/SetQueueAttributesCommand)
+ [Subscribe](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/SubscribeCommand)
+ [Unsubscribe](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/UnsubscribeCommand)
### API Gateway を使用して Lambda 関数を呼び出す
次のコード例は、Amazon API Gateway によって呼び出される AWS Lambda 関数を作成する方法を示しています。
**SDK for JavaScript (v3)**
Lambda JavaScript ランタイム API を使用して AWS Lambda 関数を作成する方法を示します。この例では、さまざまな AWS サービスを呼び出して、特定のユースケースを実行します。この例では、Amazon API Gateway によって呼び出される Lambda 関数を作成する方法を示します。この関数は、Amazon DynamoDB テーブルをスキャンして、Amazon Simple Notification Service (Amazon SNS) を使用して、従業員に年間の記念日を祝福するテキストメッセージを送信します。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/lambda-api-gateway) で完全な例を参照してください。
この例は、[AWS SDK for JavaScript v3 デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/api-gateway-invoking-lambda-example.html)でも使用できます。
**この例で使用されているサービス**
+ API ゲートウェイ
+ DynamoDB
+ Lambda
+ Amazon SNS
### スケジュールされたイベントを使用した Lambda 関数の呼び出し
次のコード例は、Amazon EventBridge スケジュールされたイベントによって呼び出される AWS Lambda 関数を作成する方法を示しています。
**SDK for JavaScript (v3)**
AWS Lambda 関数を呼び出す Amazon EventBridge スケジュールされたイベントを作成する方法を示します。cron 式を使用して Lambda 関数が呼び出されるタイミングをスケジュールするように EventBridge を設定します。この例では、Lambda JavaScript ランタイム API を使用して Lambda 関数を作成します。この例では、さまざまな AWS サービスを呼び出して、特定のユースケースを実行します。この例では、年間の記念日に従業員を祝福するモバイルテキストメッセージを従業員に送信するアプリを作成する方法を示します。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/lambda-scheduled-events) で完全な例を参照してください。
この例は、[AWS SDK for JavaScript v3 デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/scheduled-events-invoking-lambda-example.html)でも使用できます。
**この例で使用されているサービス**
+ CloudWatch Logs
+ DynamoDB
+ EventBridge
+ Lambda
+ Amazon SNS
## サーバーレスサンプル
### Amazon SNS トリガーから Lambda 関数を呼び出す
次のコード例は、SNS トピックからメッセージを受信することによってトリガーされるイベントを受け取る Lambda 関数を実装する方法を示しています。この関数はイベントパラメータからメッセージを取得し、各メッセージの内容を記録します。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。[サーバーレスサンプル](https://github.com/aws-samples/serverless-snippets/blob/main/integration-sns-to-lambda)リポジトリで完全な例を検索し、設定および実行する方法を確認してください。
JavaScript を使用した Lambda での SNS イベントの消費。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
exports.handler = async (event, context) => {
for (const record of event.Records) {
await processMessageAsync(record);
}
console.info("done");
};
async function processMessageAsync(record) {
try {
const message = JSON.stringify(record.Sns.Message);
console.log(`Processed message ${message}`);
await Promise.resolve(1); //Placeholder for actual async work
} catch (err) {
console.error("An error occurred");
throw err;
}
}
```
TypeScript を使用した Lambda での SNS イベントの消費。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { SNSEvent, Context, SNSHandler, SNSEventRecord } from "aws-lambda";
export const functionHandler: SNSHandler = async (
event: SNSEvent,
context: Context
): Promise => {
for (const record of event.Records) {
await processMessageAsync(record);
}
console.info("done");
};
async function processMessageAsync(record: SNSEventRecord): Promise {
try {
const message: string = JSON.stringify(record.Sns.Message);
console.log(`Processed message ${message}`);
await Promise.resolve(1); //Placeholder for actual async work
} catch (err) {
console.error("An error occurred");
throw err;
}
}
```
# SDK for JavaScript (v3) を使用した Amazon SQS の例
次のコード例は、Amazon SQS で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
*シナリオ*は、1 つのサービス内から、または他の AWS のサービスと組み合わせて複数の関数を呼び出し、特定のタスクを実行する方法を示すコード例です。
各例には完全なソースコードへのリンクが含まれており、コンテキスト内でコードを設定および実行する方法の手順を確認できます。
**Topics**
+ [はじめに](#get_started)
+ [アクション](#actions)
+ [シナリオ](#scenarios)
+ [サーバーレスサンプル](#serverless_examples)
## はじめに
### Hello Amazon SQS
次のコード例は、Amazon SQS の使用を開始する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS クライアントを初期化し、キューを一覧表示します。
```
import { SQSClient, paginateListQueues } from "@aws-sdk/client-sqs";
export const helloSqs = async () => {
// The configuration object (`{}`) is required. If the region and credentials
// are omitted, the SDK uses your local configuration if it exists.
const client = new SQSClient({});
// You can also use `ListQueuesCommand`, but to use that command you must
// handle the pagination yourself. You can do that by sending the `ListQueuesCommand`
// with the `NextToken` parameter from the previous request.
const paginatedQueues = paginateListQueues({ client }, {});
const queues = [];
for await (const page of paginatedQueues) {
if (page.QueueUrls?.length) {
queues.push(...page.QueueUrls);
}
}
const suffix = queues.length === 1 ? "" : "s";
console.log(
`Hello, Amazon SQS! You have ${queues.length} queue${suffix} in your account.`,
);
console.log(queues.map((t) => ` * ${t}`).join("\n"));
};
```
+ API の詳細については、**「AWS SDK for JavaScript API リファレンス」の「[ListQueues](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/ListQueuesCommand)」を参照してください。
## アクション
### `ChangeMessageVisibility`
次のコード例は、`ChangeMessageVisibility` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS メッセージを受信し、可視性タイムアウトを変更します。
```
import {
ReceiveMessageCommand,
ChangeMessageVisibilityCommand,
SQSClient,
} from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue_url";
const receiveMessage = (queueUrl) =>
client.send(
new ReceiveMessageCommand({
AttributeNames: ["SentTimestamp"],
MaxNumberOfMessages: 1,
MessageAttributeNames: ["All"],
QueueUrl: queueUrl,
WaitTimeSeconds: 1,
}),
);
export const main = async (queueUrl = SQS_QUEUE_URL) => {
const { Messages } = await receiveMessage(queueUrl);
const response = await client.send(
new ChangeMessageVisibilityCommand({
QueueUrl: queueUrl,
ReceiptHandle: Messages[0].ReceiptHandle,
VisibilityTimeout: 20,
}),
);
console.log(response);
return response;
};
```
+ API の詳細については、**AWS SDK for JavaScript API リファレンスの「[ChangeMessageVisibility](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/ChangeMessageVisibilityCommand)」を参照してください。
### `CreateQueue`
次のコード例は、`CreateQueue` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS 標準キューを作成します。
```
import { CreateQueueCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_NAME = "test-queue";
export const main = async (sqsQueueName = SQS_QUEUE_NAME) => {
const command = new CreateQueueCommand({
QueueName: sqsQueueName,
Attributes: {
DelaySeconds: "60",
MessageRetentionPeriod: "86400",
},
});
const response = await client.send(command);
console.log(response);
return response;
};
```
ロングポーリングでキューを作成します。
```
import { CreateQueueCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_NAME = "queue_name";
export const main = async (queueName = SQS_QUEUE_NAME) => {
const response = await client.send(
new CreateQueueCommand({
QueueName: queueName,
Attributes: {
// When the wait time for the ReceiveMessage API action is greater than 0,
// long polling is in effect. The maximum long polling wait time is 20
// seconds. Long polling helps reduce the cost of using Amazon SQS by,
// eliminating the number of empty responses and false empty responses.
// https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html
ReceiveMessageWaitTimeSeconds: "20",
},
}),
);
console.log(response);
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-using-queues.html#sqs-examples-using-queues-create-queue)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[CreateQueue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/CreateQueueCommand)」を参照してください。
### `DeleteMessage`
次のコード例は、`DeleteMessage` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS メッセージを受信および削除します。
```
import {
ReceiveMessageCommand,
DeleteMessageCommand,
SQSClient,
DeleteMessageBatchCommand,
} from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue_url";
const receiveMessage = (queueUrl) =>
client.send(
new ReceiveMessageCommand({
AttributeNames: ["SentTimestamp"],
MaxNumberOfMessages: 10,
MessageAttributeNames: ["All"],
QueueUrl: queueUrl,
WaitTimeSeconds: 20,
VisibilityTimeout: 20,
}),
);
export const main = async (queueUrl = SQS_QUEUE_URL) => {
const { Messages } = await receiveMessage(queueUrl);
if (!Messages) {
return;
}
if (Messages.length === 1) {
console.log(Messages[0].Body);
await client.send(
new DeleteMessageCommand({
QueueUrl: queueUrl,
ReceiptHandle: Messages[0].ReceiptHandle,
}),
);
} else {
await client.send(
new DeleteMessageBatchCommand({
QueueUrl: queueUrl,
Entries: Messages.map((message) => ({
Id: message.MessageId,
ReceiptHandle: message.ReceiptHandle,
})),
}),
);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DeleteMessage](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/DeleteMessageCommand)」を参照してください。
### `DeleteMessageBatch`
次のコード例は、`DeleteMessageBatch` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
```
import {
ReceiveMessageCommand,
DeleteMessageCommand,
SQSClient,
DeleteMessageBatchCommand,
} from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue_url";
const receiveMessage = (queueUrl) =>
client.send(
new ReceiveMessageCommand({
AttributeNames: ["SentTimestamp"],
MaxNumberOfMessages: 10,
MessageAttributeNames: ["All"],
QueueUrl: queueUrl,
WaitTimeSeconds: 20,
VisibilityTimeout: 20,
}),
);
export const main = async (queueUrl = SQS_QUEUE_URL) => {
const { Messages } = await receiveMessage(queueUrl);
if (!Messages) {
return;
}
if (Messages.length === 1) {
console.log(Messages[0].Body);
await client.send(
new DeleteMessageCommand({
QueueUrl: queueUrl,
ReceiptHandle: Messages[0].ReceiptHandle,
}),
);
} else {
await client.send(
new DeleteMessageBatchCommand({
QueueUrl: queueUrl,
Entries: Messages.map((message) => ({
Id: message.MessageId,
ReceiptHandle: message.ReceiptHandle,
})),
}),
);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DeleteMessageBatch](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/DeleteMessageBatchCommand)」を参照してください。
### `DeleteQueue`
次のコード例は、`DeleteQueue` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS キューを削除します。
```
import { DeleteQueueCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "test-queue-url";
export const main = async (queueUrl = SQS_QUEUE_URL) => {
const command = new DeleteQueueCommand({ QueueUrl: queueUrl });
const response = await client.send(command);
console.log(response);
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-using-queues.html#sqs-examples-using-queues-delete-queue)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DeleteQueue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/DeleteQueueCommand)」を参照してください。
### `GetQueueAttributes`
次のコード例は、`GetQueueAttributes` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
```
import { GetQueueAttributesCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue-url";
export const getQueueAttributes = async (queueUrl = SQS_QUEUE_URL) => {
const command = new GetQueueAttributesCommand({
QueueUrl: queueUrl,
AttributeNames: ["DelaySeconds"],
});
const response = await client.send(command);
console.log(response);
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '747a1192-c334-5682-a508-4cd5e8dc4e79',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// Attributes: { DelaySeconds: '1' }
// }
return response;
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[GetQueueAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/GetQueueAttributesCommand)」を参照してください。
### `GetQueueUrl`
次のコード例は、`GetQueueUrl` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS キューの URL を取得します。
```
import { GetQueueUrlCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_NAME = "test-queue";
export const main = async (queueName = SQS_QUEUE_NAME) => {
const command = new GetQueueUrlCommand({ QueueName: queueName });
const response = await client.send(command);
console.log(response);
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-using-queues.html#sqs-examples-using-queues-get-queue-url)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[GetQueueUrl](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/GetQueueUrlCommand)」を参照してください。
### `ListQueues`
次のコード例は、`ListQueues` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS キューを一覧表示します。
```
import { paginateListQueues, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
export const main = async () => {
const paginatedListQueues = paginateListQueues({ client }, {});
/** @type {string[]} */
const urls = [];
for await (const page of paginatedListQueues) {
const nextUrls = page.QueueUrls?.filter((qurl) => !!qurl) || [];
urls.push(...nextUrls);
for (const url of urls) {
console.log(url);
}
}
return urls;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-using-queues.html#sqs-examples-using-queues-listing-queues)」を参照してください。
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[ListQueues](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/ListQueuesCommand)」を参照してください。
### `ReceiveMessage`
次のコード例は、`ReceiveMessage` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS キューからメッセージを受信します。
```
import {
ReceiveMessageCommand,
DeleteMessageCommand,
SQSClient,
DeleteMessageBatchCommand,
} from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue_url";
const receiveMessage = (queueUrl) =>
client.send(
new ReceiveMessageCommand({
AttributeNames: ["SentTimestamp"],
MaxNumberOfMessages: 10,
MessageAttributeNames: ["All"],
QueueUrl: queueUrl,
WaitTimeSeconds: 20,
VisibilityTimeout: 20,
}),
);
export const main = async (queueUrl = SQS_QUEUE_URL) => {
const { Messages } = await receiveMessage(queueUrl);
if (!Messages) {
return;
}
if (Messages.length === 1) {
console.log(Messages[0].Body);
await client.send(
new DeleteMessageCommand({
QueueUrl: queueUrl,
ReceiptHandle: Messages[0].ReceiptHandle,
}),
);
} else {
await client.send(
new DeleteMessageBatchCommand({
QueueUrl: queueUrl,
Entries: Messages.map((message) => ({
Id: message.MessageId,
ReceiptHandle: message.ReceiptHandle,
})),
}),
);
}
};
```
ロングポーリングサポートを使用して Amazon SQS キューからメッセージを受信します。
```
import { ReceiveMessageCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue-url";
export const main = async (queueUrl = SQS_QUEUE_URL) => {
const command = new ReceiveMessageCommand({
AttributeNames: ["SentTimestamp"],
MaxNumberOfMessages: 1,
MessageAttributeNames: ["All"],
QueueUrl: queueUrl,
// The duration (in seconds) for which the call waits for a message
// to arrive in the queue before returning. If a message is available,
// the call returns sooner than WaitTimeSeconds. If no messages are
// available and the wait time expires, the call returns successfully
// with an empty list of messages.
// https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html#API_ReceiveMessage_RequestSyntax
WaitTimeSeconds: 20,
});
const response = await client.send(command);
console.log(response);
return response;
};
```
+ API の詳細については、**AWS SDK for JavaScript API リファレンスの「[ReceiveMessage](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/ReceiveMessageCommand)」を参照してください。
### `SendMessage`
次のコード例は、`SendMessage` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
Amazon SQS キューにメッセージを送信します。
```
import { SendMessageCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue_url";
export const main = async (sqsQueueUrl = SQS_QUEUE_URL) => {
const command = new SendMessageCommand({
QueueUrl: sqsQueueUrl,
DelaySeconds: 10,
MessageAttributes: {
Title: {
DataType: "String",
StringValue: "The Whistler",
},
Author: {
DataType: "String",
StringValue: "John Grisham",
},
WeeksOn: {
DataType: "Number",
StringValue: "6",
},
},
MessageBody:
"Information about current NY Times fiction bestseller for week of 12/11/2016.",
});
const response = await client.send(command);
console.log(response);
return response;
};
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-send-receive-messages.html#sqs-examples-send-receive-messages-sending)」を参照してください。
+ API の詳細については、AWS SDK for JavaScript API リファレンスの「[SendMessage](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/SendMessageCommand)」を参照してください。**
### `SetQueueAttributes`
次のコード例は、`SetQueueAttributes` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sqs#code-examples)での設定と実行の方法を確認してください。
```
import { SetQueueAttributesCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue-url";
export const main = async (queueUrl = SQS_QUEUE_URL) => {
const command = new SetQueueAttributesCommand({
QueueUrl: queueUrl,
Attributes: {
DelaySeconds: "1",
},
});
const response = await client.send(command);
console.log(response);
return response;
};
```
ロングポーリングを使用するように Amazon SQS キューを設定します。
```
import { SetQueueAttributesCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue_url";
export const main = async (queueUrl = SQS_QUEUE_URL) => {
const command = new SetQueueAttributesCommand({
Attributes: {
ReceiveMessageWaitTimeSeconds: "20",
},
QueueUrl: queueUrl,
});
const response = await client.send(command);
console.log(response);
return response;
};
```
デッドレターキューを設定します。
```
import { SetQueueAttributesCommand, SQSClient } from "@aws-sdk/client-sqs";
const client = new SQSClient({});
const SQS_QUEUE_URL = "queue_url";
const DEAD_LETTER_QUEUE_ARN = "dead_letter_queue_arn";
export const main = async (
queueUrl = SQS_QUEUE_URL,
deadLetterQueueArn = DEAD_LETTER_QUEUE_ARN,
) => {
const command = new SetQueueAttributesCommand({
Attributes: {
RedrivePolicy: JSON.stringify({
// Amazon SQS supports dead-letter queues (DLQ), which other
// queues (source queues) can target for messages that can't
// be processed (consumed) successfully.
// https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
deadLetterTargetArn: deadLetterQueueArn,
maxReceiveCount: "10",
}),
},
QueueUrl: queueUrl,
});
const response = await client.send(command);
console.log(response);
return response;
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[SetQueueAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/SetQueueAttributesCommand)」を参照してください。
## シナリオ
### Amazon Textract エクスプローラーアプリケーションを作成する
次のコード例は、インタラクティブアプリケーションで Amazon Textract の出力を調べる方法を示しています。
**SDK for JavaScript (v3)**
を使用して、Amazon Textract を使用してドキュメントイメージからデータを抽出し、インタラクティブなウェブページに表示する React アプリケーション AWS SDK for JavaScript を構築する方法を示します。この例はウェブブラウザで実行され、認証情報に認証された Amazon Cognito ID が必要です。Amazon Simple Storage Service (Amazon S3) をストレージに使用し、通知のために、Amazon Simple Notification Service (Amazon SNS) トピックにサブスクライブした Amazon Simple Queue Service (Amazon SQS) キューをポーリングします。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/textract-react) で完全な例を参照してください。
**この例で使用されているサービス**
+ Amazon Cognito ID
+ Amazon S3
+ Amazon SNS
+ Amazon SQS
+ Amazon Textract
### メッセージをキューに発行する
次のコード例は、以下の操作方法を示しています。
+ トピック (FIFO または非 FIFO) を作成します。
+ フィルターを適用するオプションを使用して、複数のキューをトピックにサブスクライブします。
+ メッセージをトピックに発行します。
+ 受信したメッセージのキューをポーリングします。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/wkflw-topics-queues#code-examples)での設定と実行の方法を確認してください。
これがこのシナリオのエントリーポイントです。
```
import { SNSClient } from "@aws-sdk/client-sns";
import { SQSClient } from "@aws-sdk/client-sqs";
import { TopicsQueuesWkflw } from "./TopicsQueuesWkflw.js";
import { Prompter } from "@aws-doc-sdk-examples/lib/prompter.js";
export const startSnsWorkflow = () => {
const snsClient = new SNSClient({});
const sqsClient = new SQSClient({});
const prompter = new Prompter();
const logger = console;
const wkflw = new TopicsQueuesWkflw(snsClient, sqsClient, prompter, logger);
wkflw.start();
};
```
上記のコードにより必要な依存関係が提供され、シナリオが開始されます。次のセクションには、この例の大部分が含まれています。
```
const toneChoices = [
{ name: "cheerful", value: "cheerful" },
{ name: "funny", value: "funny" },
{ name: "serious", value: "serious" },
{ name: "sincere", value: "sincere" },
];
export class TopicsQueuesWkflw {
// SNS topic is configured as First-In-First-Out
isFifo = true;
// Automatic content-based deduplication is enabled.
autoDedup = false;
snsClient;
sqsClient;
topicName;
topicArn;
subscriptionArns = [];
/**
* @type {{ queueName: string, queueArn: string, queueUrl: string, policy?: string }[]}
*/
queues = [];
prompter;
/**
* @param {import('@aws-sdk/client-sns').SNSClient} snsClient
* @param {import('@aws-sdk/client-sqs').SQSClient} sqsClient
* @param {import('../../libs/prompter.js').Prompter} prompter
* @param {import('../../libs/logger.js').Logger} logger
*/
constructor(snsClient, sqsClient, prompter, logger) {
this.snsClient = snsClient;
this.sqsClient = sqsClient;
this.prompter = prompter;
this.logger = logger;
}
async welcome() {
await this.logger.log(MESSAGES.description);
}
async confirmFifo() {
await this.logger.log(MESSAGES.snsFifoDescription);
this.isFifo = await this.prompter.confirm({
message: MESSAGES.snsFifoPrompt,
});
if (this.isFifo) {
this.logger.logSeparator(MESSAGES.headerDedup);
await this.logger.log(MESSAGES.deduplicationNotice);
await this.logger.log(MESSAGES.deduplicationDescription);
this.autoDedup = await this.prompter.confirm({
message: MESSAGES.deduplicationPrompt,
});
}
}
async createTopic() {
await this.logger.log(MESSAGES.creatingTopics);
this.topicName = await this.prompter.input({
message: MESSAGES.topicNamePrompt,
});
if (this.isFifo) {
this.topicName += ".fifo";
this.logger.logSeparator(MESSAGES.headerFifoNaming);
await this.logger.log(MESSAGES.appendFifoNotice);
}
const response = await this.snsClient.send(
new CreateTopicCommand({
Name: this.topicName,
Attributes: {
FifoTopic: this.isFifo ? "true" : "false",
...(this.autoDedup ? { ContentBasedDeduplication: "true" } : {}),
},
}),
);
this.topicArn = response.TopicArn;
await this.logger.log(
MESSAGES.topicCreatedNotice
.replace("${TOPIC_NAME}", this.topicName)
.replace("${TOPIC_ARN}", this.topicArn),
);
}
async createQueues() {
await this.logger.log(MESSAGES.createQueuesNotice);
// Increase this number to add more queues.
const maxQueues = 2;
for (let i = 0; i < maxQueues; i++) {
await this.logger.log(MESSAGES.queueCount.replace("${COUNT}", i + 1));
let queueName = await this.prompter.input({
message: MESSAGES.queueNamePrompt.replace(
"${EXAMPLE_NAME}",
i === 0 ? "good-news" : "bad-news",
),
});
if (this.isFifo) {
queueName += ".fifo";
await this.logger.log(MESSAGES.appendFifoNotice);
}
const response = await this.sqsClient.send(
new CreateQueueCommand({
QueueName: queueName,
Attributes: { ...(this.isFifo ? { FifoQueue: "true" } : {}) },
}),
);
const { Attributes } = await this.sqsClient.send(
new GetQueueAttributesCommand({
QueueUrl: response.QueueUrl,
AttributeNames: ["QueueArn"],
}),
);
this.queues.push({
queueName,
queueArn: Attributes.QueueArn,
queueUrl: response.QueueUrl,
});
await this.logger.log(
MESSAGES.queueCreatedNotice
.replace("${QUEUE_NAME}", queueName)
.replace("${QUEUE_URL}", response.QueueUrl)
.replace("${QUEUE_ARN}", Attributes.QueueArn),
);
}
}
async attachQueueIamPolicies() {
for (const [index, queue] of this.queues.entries()) {
const policy = JSON.stringify(
{
Statement: [
{
Effect: "Allow",
Principal: {
Service: "sns.amazonaws.com",
},
Action: "sqs:SendMessage",
Resource: queue.queueArn,
Condition: {
ArnEquals: {
"aws:SourceArn": this.topicArn,
},
},
},
],
},
null,
2,
);
if (index !== 0) {
this.logger.logSeparator();
}
await this.logger.log(MESSAGES.attachPolicyNotice);
console.log(policy);
const addPolicy = await this.prompter.confirm({
message: MESSAGES.addPolicyConfirmation.replace(
"${QUEUE_NAME}",
queue.queueName,
),
});
if (addPolicy) {
await this.sqsClient.send(
new SetQueueAttributesCommand({
QueueUrl: queue.queueUrl,
Attributes: {
Policy: policy,
},
}),
);
queue.policy = policy;
} else {
await this.logger.log(
MESSAGES.policyNotAttachedNotice.replace(
"${QUEUE_NAME}",
queue.queueName,
),
);
}
}
}
async subscribeQueuesToTopic() {
for (const [index, queue] of this.queues.entries()) {
/**
* @type {import('@aws-sdk/client-sns').SubscribeCommandInput}
*/
const subscribeParams = {
TopicArn: this.topicArn,
Protocol: "sqs",
Endpoint: queue.queueArn,
};
let tones = [];
if (this.isFifo) {
if (index === 0) {
await this.logger.log(MESSAGES.fifoFilterNotice);
}
tones = await this.prompter.checkbox({
message: MESSAGES.fifoFilterSelect.replace(
"${QUEUE_NAME}",
queue.queueName,
),
choices: toneChoices,
});
if (tones.length) {
subscribeParams.Attributes = {
FilterPolicyScope: "MessageAttributes",
FilterPolicy: JSON.stringify({
tone: tones,
}),
};
}
}
const { SubscriptionArn } = await this.snsClient.send(
new SubscribeCommand(subscribeParams),
);
this.subscriptionArns.push(SubscriptionArn);
await this.logger.log(
MESSAGES.queueSubscribedNotice
.replace("${QUEUE_NAME}", queue.queueName)
.replace("${TOPIC_NAME}", this.topicName)
.replace("${TONES}", tones.length ? tones.join(", ") : "none"),
);
}
}
async publishMessages() {
const message = await this.prompter.input({
message: MESSAGES.publishMessagePrompt,
});
let groupId;
let deduplicationId;
let choices;
if (this.isFifo) {
await this.logger.log(MESSAGES.groupIdNotice);
groupId = await this.prompter.input({
message: MESSAGES.groupIdPrompt,
});
if (this.autoDedup === false) {
await this.logger.log(MESSAGES.deduplicationIdNotice);
deduplicationId = await this.prompter.input({
message: MESSAGES.deduplicationIdPrompt,
});
}
choices = await this.prompter.checkbox({
message: MESSAGES.messageAttributesPrompt,
choices: toneChoices,
});
}
await this.snsClient.send(
new PublishCommand({
TopicArn: this.topicArn,
Message: message,
...(groupId
? {
MessageGroupId: groupId,
}
: {}),
...(deduplicationId
? {
MessageDeduplicationId: deduplicationId,
}
: {}),
...(choices
? {
MessageAttributes: {
tone: {
DataType: "String.Array",
StringValue: JSON.stringify(choices),
},
},
}
: {}),
}),
);
const publishAnother = await this.prompter.confirm({
message: MESSAGES.publishAnother,
});
if (publishAnother) {
await this.publishMessages();
}
}
async receiveAndDeleteMessages() {
for (const queue of this.queues) {
const { Messages } = await this.sqsClient.send(
new ReceiveMessageCommand({
QueueUrl: queue.queueUrl,
}),
);
if (Messages) {
await this.logger.log(
MESSAGES.messagesReceivedNotice.replace(
"${QUEUE_NAME}",
queue.queueName,
),
);
console.log(Messages);
await this.sqsClient.send(
new DeleteMessageBatchCommand({
QueueUrl: queue.queueUrl,
Entries: Messages.map((message) => ({
Id: message.MessageId,
ReceiptHandle: message.ReceiptHandle,
})),
}),
);
} else {
await this.logger.log(
MESSAGES.noMessagesReceivedNotice.replace(
"${QUEUE_NAME}",
queue.queueName,
),
);
}
}
const deleteAndPoll = await this.prompter.confirm({
message: MESSAGES.deleteAndPollConfirmation,
});
if (deleteAndPoll) {
await this.receiveAndDeleteMessages();
}
}
async destroyResources() {
for (const subscriptionArn of this.subscriptionArns) {
await this.snsClient.send(
new UnsubscribeCommand({ SubscriptionArn: subscriptionArn }),
);
}
for (const queue of this.queues) {
await this.sqsClient.send(
new DeleteQueueCommand({ QueueUrl: queue.queueUrl }),
);
}
if (this.topicArn) {
await this.snsClient.send(
new DeleteTopicCommand({ TopicArn: this.topicArn }),
);
}
}
async start() {
console.clear();
try {
this.logger.logSeparator(MESSAGES.headerWelcome);
await this.welcome();
this.logger.logSeparator(MESSAGES.headerFifo);
await this.confirmFifo();
this.logger.logSeparator(MESSAGES.headerCreateTopic);
await this.createTopic();
this.logger.logSeparator(MESSAGES.headerCreateQueues);
await this.createQueues();
this.logger.logSeparator(MESSAGES.headerAttachPolicy);
await this.attachQueueIamPolicies();
this.logger.logSeparator(MESSAGES.headerSubscribeQueues);
await this.subscribeQueuesToTopic();
this.logger.logSeparator(MESSAGES.headerPublishMessage);
await this.publishMessages();
this.logger.logSeparator(MESSAGES.headerReceiveMessages);
await this.receiveAndDeleteMessages();
} catch (err) {
console.error(err);
} finally {
await this.destroyResources();
}
}
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の以下のトピックを参照してください。
+ [CreateQueue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/CreateQueueCommand)
+ [CreateTopic](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/CreateTopicCommand)
+ [DeleteMessageBatch](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/DeleteMessageBatchCommand)
+ [DeleteQueue](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/DeleteQueueCommand)
+ [DeleteTopic](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/DeleteTopicCommand)
+ [GetQueueAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/GetQueueAttributesCommand)
+ [Publish](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/PublishCommand)
+ [ReceiveMessage](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/ReceiveMessageCommand)
+ [SetQueueAttributes](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/SetQueueAttributesCommand)
+ [Subscribe](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/SubscribeCommand)
+ [Unsubscribe](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sns/command/UnsubscribeCommand)
## サーバーレスサンプル
### Amazon SQS トリガーから Lambda 関数を呼び出す
次のコード例では、SQS キューからメッセージを受信することによってトリガーされるイベントを受け取る、Lambda 関数の実装方法を示しています。この関数はイベントパラメータからメッセージを取得し、各メッセージの内容を記録します。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。[サーバーレスサンプル](https://github.com/aws-samples/serverless-snippets/blob/main/integration-sqs-to-lambda)リポジトリで完全な例を見つけて、設定と実行の方法を確認してください。
JavaScript を使用した Lambda での SQS イベントの消費。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
exports.handler = async (event, context) => {
for (const message of event.Records) {
await processMessageAsync(message);
}
console.info("done");
};
async function processMessageAsync(message) {
try {
console.log(`Processed message ${message.body}`);
// TODO: Do interesting work based on the new message
await Promise.resolve(1); //Placeholder for actual async work
} catch (err) {
console.error("An error occurred");
throw err;
}
}
```
TypeScript を使用した Lambda での SQS イベントの消費。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { SQSEvent, Context, SQSHandler, SQSRecord } from "aws-lambda";
export const functionHandler: SQSHandler = async (
event: SQSEvent,
context: Context
): Promise => {
for (const message of event.Records) {
await processMessageAsync(message);
}
console.info("done");
};
async function processMessageAsync(message: SQSRecord): Promise {
try {
console.log(`Processed message ${message.body}`);
// TODO: Do interesting work based on the new message
await Promise.resolve(1); //Placeholder for actual async work
} catch (err) {
console.error("An error occurred");
throw err;
}
}
```
### Amazon SQS トリガーを使用した Lambda 関数でのバッチアイテム失敗のレポート
以下のコード例では、SQS キューからイベントを受け取る Lambda 関数のための、部分的なバッチレスポンスの実装方法を示しています。この関数は、レスポンスとしてバッチアイテムの失敗を報告し、対象のメッセージを後で再試行するよう Lambda に伝えます。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。[サーバーレスサンプル](https://github.com/aws-samples/serverless-snippets/tree/main/lambda-function-sqs-report-batch-item-failures)リポジトリで完全な例を見つけて、設定と実行の方法を確認してください。
JavaScript を使用した Lambda での SQS バッチアイテム失敗のレポート。
```
// Node.js 20.x Lambda runtime, AWS SDK for Javascript V3
export const handler = async (event, context) => {
const batchItemFailures = [];
for (const record of event.Records) {
try {
await processMessageAsync(record, context);
} catch (error) {
batchItemFailures.push({ itemIdentifier: record.messageId });
}
}
return { batchItemFailures };
};
async function processMessageAsync(record, context) {
if (record.body && record.body.includes("error")) {
throw new Error("There is an error in the SQS Message.");
}
console.log(`Processed message: ${record.body}`);
}
```
TypeScript を使用した Lambda での SQS バッチアイテム失敗のレポート。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { SQSEvent, SQSBatchResponse, Context, SQSBatchItemFailure, SQSRecord } from 'aws-lambda';
export const handler = async (event: SQSEvent, context: Context): Promise => {
const batchItemFailures: SQSBatchItemFailure[] = [];
for (const record of event.Records) {
try {
await processMessageAsync(record);
} catch (error) {
batchItemFailures.push({ itemIdentifier: record.messageId });
}
}
return {batchItemFailures: batchItemFailures};
};
async function processMessageAsync(record: SQSRecord): Promise {
if (record.body && record.body.includes("error")) {
throw new Error('There is an error in the SQS Message.');
}
console.log(`Processed message ${record.body}`);
}
```
# SDK for JavaScript (v3) を使用した Step Functions の例
次のコード例は、Step Functions で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `StartExecution`
次のコード例は、`StartExecution` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sfn#code-examples)での設定と実行の方法を確認してください。
```
import { SFNClient, StartExecutionCommand } from "@aws-sdk/client-sfn";
/**
* @param {{ sfnClient: SFNClient, stateMachineArn: string }} config
*/
export async function startExecution({ sfnClient, stateMachineArn }) {
const response = await sfnClient.send(
new StartExecutionCommand({
stateMachineArn,
}),
);
console.log(response);
// Example response:
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '202a9309-c16a-454b-adeb-c4d19afe3bf2',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// executionArn: 'arn:aws:states:us-east-1:000000000000:execution:MyStateMachine:aaaaaaaa-f787-49fb-a20c-1b61c64eafe6',
// startDate: 2024-01-04T15:54:08.362Z
// }
return response;
}
// Call function if run directly
import { fileURLToPath } from "node:url";
if (process.argv[1] === fileURLToPath(import.meta.url)) {
startExecution({ sfnClient: new SFNClient({}), stateMachineArn: "ARN" });
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[StartExecution](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sfn/command/StartExecutionCommand)」を参照してください。
# AWS STS SDK for JavaScript (v3) を使用した例
次のコード例は、 で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS STS。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `AssumeRole`
次のコード例は、`AssumeRole` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/sts#code-examples)での設定と実行の方法を確認してください。
クライアントを作成します。
```
import { STSClient } from "@aws-sdk/client-sts";
// Set the AWS Region.
const REGION = "us-east-1";
// Create an AWS STS service client object.
export const client = new STSClient({ region: REGION });
```
IAM ロールを割り当てます。
```
import { AssumeRoleCommand } from "@aws-sdk/client-sts";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Returns a set of temporary security credentials that you can use to
// access Amazon Web Services resources that you might not normally
// have access to.
const command = new AssumeRoleCommand({
// The Amazon Resource Name (ARN) of the role to assume.
RoleArn: "ROLE_ARN",
// An identifier for the assumed role session.
RoleSessionName: "session1",
// The duration, in seconds, of the role session. The value specified
// can range from 900 seconds (15 minutes) up to the maximum session
// duration set for the role.
DurationSeconds: 900,
});
const response = await client.send(command);
console.log(response);
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[AssumeRole](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sts/command/AssumeRoleCommand)」を参照してください。
# サポート SDK for JavaScript (v3) を使用した例
次のコード例は、 で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています サポート。
*基本* は、重要なオペレーションをサービス内で実行する方法を示すコード例です。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コンテキスト内でコードを設定および実行する方法の手順を確認できます。
**Topics**
+ [はじめに](#get_started)
+ [基本](#basics)
+ [アクション](#actions)
## はじめに
### こんにち サポートは
次のコード例は、 サポートの使用を開始する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
`main()` を呼び出してサンプルを実行します。
```
import {
DescribeServicesCommand,
SupportClient,
} from "@aws-sdk/client-support";
// Change the value of 'region' to your preferred AWS Region.
const client = new SupportClient({ region: "us-east-1" });
const getServiceCount = async () => {
try {
const { services } = await client.send(new DescribeServicesCommand({}));
return services.length;
} catch (err) {
if (err.name === "SubscriptionRequiredException") {
throw new Error(
"You must be subscribed to the AWS Support plan to use this feature.",
);
}
throw err;
}
};
export const main = async () => {
try {
const count = await getServiceCount();
console.log(`Hello, AWS Support! There are ${count} services available.`);
} catch (err) {
console.error("Failed to get service count: ", err.message);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*のの「[DescribeServices](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeServicesCommand)」を参照してください。
## 基本
### 基本を学ぶ
次のコード例は、以下の操作方法を示しています。
+ ケースの利用可能なサービスと重要度レベルを取得して表示します。
+ 選択したサービス、カテゴリ、重要度レベルを使用してサポートケースを作成する方法
+ 当日のオープンケースのリストを取得して表示する方法
+ 新しいケースに添付セットとコミュニケーションを追加する方法
+ ケースの新しい添付ファイルとコミュニケーションについて説明する方法
+ ケースを解決する方法
+ 当日の解決済みケースのリストを取得して表示します。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
ターミナルでインタラクティブシナリオを実行します。
```
import {
AddAttachmentsToSetCommand,
AddCommunicationToCaseCommand,
CreateCaseCommand,
DescribeAttachmentCommand,
DescribeCasesCommand,
DescribeCommunicationsCommand,
DescribeServicesCommand,
DescribeSeverityLevelsCommand,
ResolveCaseCommand,
SupportClient,
} from "@aws-sdk/client-support";
import * as inquirer from "@inquirer/prompts";
import { retry } from "@aws-doc-sdk-examples/lib/utils/util-timers.js";
const wrapText = (text, char = "=") => {
const rule = char.repeat(80);
return `${rule}\n ${text}\n${rule}\n`;
};
const client = new SupportClient({ region: "us-east-1" });
// Verify that the account has a Support plan.
export const verifyAccount = async () => {
const command = new DescribeServicesCommand({});
try {
await client.send(command);
} catch (err) {
if (err.name === "SubscriptionRequiredException") {
throw new Error(
"You must be subscribed to the AWS Support plan to use this feature.",
);
}
throw err;
}
};
/**
* Select a service from the list returned from DescribeServices.
*/
export const getService = async () => {
const { services } = await client.send(new DescribeServicesCommand({}));
const selectedService = await inquirer.select({
message:
"Select a service. Your support case will be created for this service. The list of services is truncated for readability.",
choices: services.slice(0, 10).map((s) => ({ name: s.name, value: s })),
});
return selectedService;
};
/**
* @param {{ categories: import('@aws-sdk/client-support').Category[]}} service
*/
export const getCategory = async (service) => {
const selectedCategory = await inquirer.select({
message: "Select a category.",
choices: service.categories.map((c) => ({ name: c.name, value: c })),
});
return selectedCategory;
};
// Get the available severity levels for the account.
export const getSeverityLevel = async () => {
const command = new DescribeSeverityLevelsCommand({});
const { severityLevels } = await client.send(command);
const selectedSeverityLevel = await inquirer.select({
message: "Select a severity level.",
choices: severityLevels.map((s) => ({ name: s.name, value: s })),
});
return selectedSeverityLevel;
};
/**
* Create a new support case
* @param {{
* selectedService: import('@aws-sdk/client-support').Service
* selectedCategory: import('@aws-sdk/client-support').Category
* selectedSeverityLevel: import('@aws-sdk/client-support').SeverityLevel
* }} selections
* @returns
*/
export const createCase = async ({
selectedService,
selectedCategory,
selectedSeverityLevel,
}) => {
const command = new CreateCaseCommand({
subject: "IGNORE: Test case",
communicationBody: "This is a test. Please ignore.",
serviceCode: selectedService.code,
categoryCode: selectedCategory.code,
severityCode: selectedSeverityLevel.code,
});
const { caseId } = await client.send(command);
return caseId;
};
// Get a list of open support cases created today.
export const getTodaysOpenCases = async () => {
const d = new Date();
const startOfToday = new Date(d.getFullYear(), d.getMonth(), d.getDate());
const command = new DescribeCasesCommand({
includeCommunications: false,
afterTime: startOfToday.toISOString(),
});
const { cases } = await client.send(command);
if (cases.length === 0) {
throw new Error(
"Unexpected number of cases. Expected more than 0 open cases.",
);
}
return cases;
};
// Create an attachment set.
export const createAttachmentSet = async () => {
const command = new AddAttachmentsToSetCommand({
attachments: [
{
fileName: "example.txt",
data: new TextEncoder().encode("some example text"),
},
],
});
const { attachmentSetId } = await client.send(command);
return attachmentSetId;
};
export const linkAttachmentSetToCase = async (attachmentSetId, caseId) => {
const command = new AddCommunicationToCaseCommand({
attachmentSetId,
caseId,
communicationBody: "Adding attachment set to case.",
});
await client.send(command);
};
// Get all communications for a support case.
export const getCommunications = async (caseId) => {
const command = new DescribeCommunicationsCommand({
caseId,
});
const { communications } = await client.send(command);
return communications;
};
/**
* @param {import('@aws-sdk/client-support').Communication[]} communications
*/
export const getFirstAttachment = (communications) => {
const firstCommWithAttachment = communications.find(
(c) => c.attachmentSet.length > 0,
);
return firstCommWithAttachment?.attachmentSet[0].attachmentId;
};
// Get an attachment.
export const getAttachment = async (attachmentId) => {
const command = new DescribeAttachmentCommand({
attachmentId,
});
const { attachment } = await client.send(command);
return attachment;
};
// Resolve the case matching the given case ID.
export const resolveCase = async (caseId) => {
const shouldResolve = await inquirer.confirm({
message: `Do you want to resolve ${caseId}?`,
});
if (shouldResolve) {
const command = new ResolveCaseCommand({
caseId: caseId,
});
await client.send(command);
return true;
}
return false;
};
/**
* Find a specific case in the list of provided cases by case ID.
* If the case is not found, and the results are paginated, continue
* paging through the results.
* @param {{
* caseId: string,
* cases: import('@aws-sdk/client-support').CaseDetails[]
* nextToken: string
* }} options
* @returns
*/
export const findCase = async ({ caseId, cases, nextToken }) => {
const foundCase = cases.find((c) => c.caseId === caseId);
if (foundCase) {
return foundCase;
}
if (nextToken) {
const response = await client.send(
new DescribeCasesCommand({
nextToken,
includeResolvedCases: true,
}),
);
return findCase({
caseId,
cases: response.cases,
nextToken: response.nextToken,
});
}
throw new Error(`${caseId} not found.`);
};
// Get all cases created today.
export const getTodaysResolvedCases = async (caseIdToWaitFor) => {
const d = new Date("2023-01-18");
const startOfToday = new Date(d.getFullYear(), d.getMonth(), d.getDate());
const command = new DescribeCasesCommand({
includeCommunications: false,
afterTime: startOfToday.toISOString(),
includeResolvedCases: true,
});
const { cases, nextToken } = await client.send(command);
await findCase({ cases, caseId: caseIdToWaitFor, nextToken });
return cases.filter((c) => c.status === "resolved");
};
const main = async () => {
let caseId;
try {
console.log(wrapText("Welcome to the AWS Support basic usage scenario."));
// Verify that the account is subscribed to support.
await verifyAccount();
// Provided a truncated list of services and prompt the user to select one.
const selectedService = await getService();
// Provided the categories for the selected service and prompt the user to select one.
const selectedCategory = await getCategory(selectedService);
// Provide the severity available severity levels for the account and prompt the user to select one.
const selectedSeverityLevel = await getSeverityLevel();
// Create a support case.
console.log("\nCreating a support case.");
caseId = await createCase({
selectedService,
selectedCategory,
selectedSeverityLevel,
});
console.log(`Support case created: ${caseId}`);
// Display a list of open support cases created today.
const todaysOpenCases = await retry(
{ intervalInMs: 1000, maxRetries: 15 },
getTodaysOpenCases,
);
console.log(
`\nOpen support cases created today: ${todaysOpenCases.length}`,
);
console.log(todaysOpenCases.map((c) => `${c.caseId}`).join("\n"));
// Create an attachment set.
console.log("\nCreating an attachment set.");
const attachmentSetId = await createAttachmentSet();
console.log(`Attachment set created: ${attachmentSetId}`);
// Add the attachment set to the support case.
console.log(`\nAdding attachment set to ${caseId}`);
await linkAttachmentSetToCase(attachmentSetId, caseId);
console.log(`Attachment set added to ${caseId}`);
// List the communications for a support case.
console.log(`\nListing communications for ${caseId}`);
const communications = await getCommunications(caseId);
console.log(
communications
.map(
(c) =>
`Communication created on ${c.timeCreated}. Has ${c.attachmentSet.length} attachments.`,
)
.join("\n"),
);
// Describe the first attachment.
console.log(`\nDescribing attachment ${attachmentSetId}`);
const attachmentId = getFirstAttachment(communications);
const attachment = await getAttachment(attachmentId);
console.log(
`Attachment is the file '${
attachment.fileName
}' with data: \n${new TextDecoder().decode(attachment.data)}`,
);
// Confirm that the support case should be resolved.
const isResolved = await resolveCase(caseId);
if (isResolved) {
// List the resolved cases and include the one previously created.
// Resolved cases can take a while to appear.
console.log(
"\nWaiting for case status to be marked as resolved. This can take some time.",
);
const resolvedCases = await retry(
{ intervalInMs: 20000, maxRetries: 15 },
() => getTodaysResolvedCases(caseId),
);
console.log("Resolved cases:");
console.log(resolvedCases.map((c) => c.caseId).join("\n"));
}
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の以下のトピックを参照してください。
+ [AddAttachmentsToSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/AddAttachmentsToSetCommand)
+ [AddCommunicationToCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/AddCommunicationToCaseCommand)
+ [CreateCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/CreateCaseCommand)
+ [DescribeAttachment](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeAttachmentCommand)
+ [DescribeCases](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeCasesCommand)
+ [DescribeCommunications](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeCommunicationsCommand)
+ [DescribeServices](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeServicesCommand)
+ [DescribeSeverityLevels](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeSeverityLevelsCommand)
+ [ResolveCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/ResolveCaseCommand)
## アクション
### `AddAttachmentsToSet`
次のコード例は、`AddAttachmentsToSet` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
```
import { AddAttachmentsToSetCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Create a new attachment set or add attachments to an existing set.
// Provide an 'attachmentSetId' value to add attachments to an existing set.
// Use AddCommunicationToCase or CreateCase to associate an attachment set with a support case.
const response = await client.send(
new AddAttachmentsToSetCommand({
// You can add up to three attachments per set. The size limit is 5 MB per attachment.
attachments: [
{
fileName: "example.txt",
data: new TextEncoder().encode("some example text"),
},
],
}),
);
// Use this ID in AddCommunicationToCase or CreateCase.
console.log(response.attachmentSetId);
return response;
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[AddAttachmentsToSet](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/AddAttachmentsToSetCommand)」を参照してください。
### `AddCommunicationToCase`
次のコード例は、`AddCommunicationToCase` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
```
import { AddCommunicationToCaseCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
let attachmentSetId;
try {
// Add a communication to a case.
const response = await client.send(
new AddCommunicationToCaseCommand({
communicationBody: "Adding an attachment.",
// Set value to an existing support case id.
caseId: "CASE_ID",
// Optional. Set value to an existing attachment set id to add attachments to the case.
attachmentSetId,
}),
);
console.log(response);
return response;
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[AddCommunicationToCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/AddCommunicationToCaseCommand)」を参照してください。
### `CreateCase`
次のコード例は、`CreateCase` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
```
import { CreateCaseCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Create a new case and log the case id.
// Important: This creates a real support case in your account.
const response = await client.send(
new CreateCaseCommand({
// The subject line of the case.
subject: "IGNORE: Test case",
// Use DescribeServices to find available service codes for each service.
serviceCode: "service-quicksight-end-user",
// Use DescribeSecurityLevels to find available severity codes for your support plan.
severityCode: "low",
// Use DescribeServices to find available category codes for each service.
categoryCode: "end-user-support",
// The main description of the support case.
communicationBody: "This is a test. Please ignore.",
}),
);
console.log(response.caseId);
return response;
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[CreateCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/CreateCaseCommand)」を参照してください。
### `DescribeAttachment`
次のコード例は、`DescribeAttachment` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
```
import { DescribeAttachmentCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Get the metadata and content of an attachment.
const response = await client.send(
new DescribeAttachmentCommand({
// Set value to an existing attachment id.
// Use DescribeCommunications or DescribeCases to find an attachment id.
attachmentId: "ATTACHMENT_ID",
}),
);
console.log(response.attachment?.fileName);
return response;
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DescribeAttachment](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeAttachmentCommand)」を参照してください。
### `DescribeCases`
次のコード例は、`DescribeCases` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
```
import { DescribeCasesCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Get all of the unresolved cases in your account.
// Filter or expand results by providing parameters to the DescribeCasesCommand. Refer
// to the TypeScript definition and the API doc for more information on possible parameters.
// https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-support/interfaces/describecasescommandinput.html
const response = await client.send(new DescribeCasesCommand({}));
const caseIds = response.cases.map((supportCase) => supportCase.caseId);
console.log(caseIds);
return response;
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DescribeCases](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeCasesCommand)」を参照してください。
### `DescribeCommunications`
次のコード例は、`DescribeCommunications` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
```
import { DescribeCommunicationsCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Get all communications for the support case.
// Filter results by providing parameters to the DescribeCommunicationsCommand. Refer
// to the TypeScript definition and the API doc for more information on possible parameters.
// https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-support/interfaces/describecommunicationscommandinput.html
const response = await client.send(
new DescribeCommunicationsCommand({
// Set value to an existing case id.
caseId: "CASE_ID",
}),
);
const text = response.communications.map((item) => item.body).join("\n");
console.log(text);
return response;
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DescribeCommunications](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeCommunicationsCommand)」を参照してください。
### `DescribeSeverityLevels`
次のコード例は、`DescribeSeverityLevels` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
```
import { DescribeSeverityLevelsCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
export const main = async () => {
try {
// Get the list of severity levels.
// The available values depend on the support plan for the account.
const response = await client.send(new DescribeSeverityLevelsCommand({}));
console.log(response.severityLevels);
return response;
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DescribeSeverityLevels](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/DescribeSeverityLevelsCommand)」を参照してください。
### `ResolveCase`
次のコード例は、`ResolveCase` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/support#code-examples)での設定と実行の方法を確認してください。
```
import { ResolveCaseCommand } from "@aws-sdk/client-support";
import { client } from "../libs/client.js";
const main = async () => {
try {
const response = await client.send(
new ResolveCaseCommand({
caseId: "CASE_ID",
}),
);
console.log(response.finalCaseStatus);
return response;
} catch (err) {
console.error(err);
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[ResolveCase](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/support/command/ResolveCaseCommand)」を参照してください。
# SDK for JavaScript (v3) を使用した Systems Manager の例
次のコード例は、Systems Manager で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*基本* は、重要なオペレーションをサービス内で実行する方法を示すコード例です。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コンテキスト内でコードを設定および実行する方法の手順を確認できます。
**Topics**
+ [はじめに](#get_started)
+ [基本](#basics)
+ [アクション](#actions)
## はじめに
### こんにちは、Systems Manager
次のコード例は、Systems Manager の使用を開始する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { paginateListDocuments, SSMClient } from "@aws-sdk/client-ssm";
// Call ListDocuments and display the result.
export const main = async () => {
const client = new SSMClient();
const listDocumentsPaginated = [];
console.log(
"Hello, AWS Systems Manager! Let's list some of your documents:\n",
);
try {
// The paginate function is a wrapper around the base command.
const paginator = paginateListDocuments({ client }, { MaxResults: 5 });
for await (const page of paginator) {
listDocumentsPaginated.push(...page.DocumentIdentifiers);
}
} catch (caught) {
console.error(`There was a problem saying hello: ${caught.message}`);
throw caught;
}
for (const { Name, DocumentFormat, CreatedDate } of listDocumentsPaginated) {
console.log(`${Name} - ${DocumentFormat} - ${CreatedDate}`);
}
};
// Call function if run directly.
import { fileURLToPath } from "node:url";
if (process.argv[1] === fileURLToPath(import.meta.url)) {
main();
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[ListDocuments](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListDocumentsCommand)」を参照してください。
## 基本
### 基本を学ぶ
次のコード例は、以下の操作方法を示しています。
+ メンテナンスウィンドウを作成します。
+ メンテナンスウィンドウのスケジュールを変更します。
+ ドキュメントを作成します。
+ 指定された EC2 インスタンスにコマンドを送信します。
+ 新しい OpsItem を作成します。
+ OpsItem を更新して解決します。
+ メンテナンスウィンドウ、OpsItem、ドキュメントを削除します。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import {
Scenario,
ScenarioAction,
ScenarioInput,
ScenarioOutput,
} from "@aws-doc-sdk-examples/lib/scenario/index.js";
import { fileURLToPath } from "node:url";
import {
CreateDocumentCommand,
CreateMaintenanceWindowCommand,
CreateOpsItemCommand,
DeleteDocumentCommand,
DeleteMaintenanceWindowCommand,
DeleteOpsItemCommand,
DescribeOpsItemsCommand,
DocumentAlreadyExists,
OpsItemStatus,
waitUntilCommandExecuted,
CancelCommandCommand,
paginateListCommandInvocations,
SendCommandCommand,
UpdateMaintenanceWindowCommand,
UpdateOpsItemCommand,
SSMClient,
} from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* @typedef {{
* ssmClient: import('@aws-sdk/client-ssm').SSMClient,
* documentName?: string
* maintenanceWindow?: string
* winId?: int
* ec2InstanceId?: string
* requestedDateTime?: Date
* opsItemId?: string
* askToDeleteResources?: boolean
* }} State
*/
const defaultMaintenanceWindow = "ssm-maintenance-window";
const defaultDocumentName = "ssmdocument";
// The timeout duration is highly dependent on the specific setup and environment necessary. This example handles only the most common error cases, and uses a much shorter duration than most productions systems would use.
const COMMAND_TIMEOUT_DURATION_SECONDS = 30; // 30 seconds
const pressEnter = new ScenarioInput("continue", "Press Enter to continue", {
type: "confirm",
});
const greet = new ScenarioOutput(
"greet",
`Welcome to the AWS Systems Manager SDK Getting Started scenario.
This program demonstrates how to interact with Systems Manager using the AWS SDK for JavaScript V3.
Systems Manager is the operations hub for your AWS applications and resources and a secure end-to-end management solution.
The program's primary functions include creating a maintenance window, creating a document, sending a command to a document,
listing documents, listing commands, creating an OpsItem, modifying an OpsItem, and deleting Systems Manager resources.
Upon completion of the program, all AWS resources are cleaned up.
Let's get started...`,
{ header: true },
);
const createMaintenanceWindow = new ScenarioOutput(
"createMaintenanceWindow",
"Step 1: Create a Systems Manager maintenance window.",
);
const getMaintenanceWindow = new ScenarioInput(
"maintenanceWindow",
"Please enter the maintenance window name:",
{ type: "input", default: defaultMaintenanceWindow },
);
export const sdkCreateMaintenanceWindow = new ScenarioAction(
"sdkCreateMaintenanceWindow",
async (/** @type {State} */ state) => {
try {
const response = await state.ssmClient.send(
new CreateMaintenanceWindowCommand({
Name: state.maintenanceWindow,
Schedule: "cron(0 10 ? * MON-FRI *)", //The schedule of the maintenance window in the form of a cron or rate expression.
Duration: 2, //The duration of the maintenance window in hours.
Cutoff: 1, //The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
AllowUnassociatedTargets: true, //Allow the maintenance window to run on managed nodes, even if you haven't registered those nodes as targets.
}),
);
state.winId = response.WindowId;
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while creating the maintenance window. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const modifyMaintenanceWindow = new ScenarioOutput(
"modifyMaintenanceWindow",
"Modify the maintenance window by changing the schedule.",
);
const sdkModifyMaintenanceWindow = new ScenarioAction(
"sdkModifyMaintenanceWindow",
async (/** @type {State} */ state) => {
try {
await state.ssmClient.send(
new UpdateMaintenanceWindowCommand({
WindowId: state.winId,
Schedule: "cron(0 0 ? * MON *)",
}),
);
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while modifying the maintenance window. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const createSystemsManagerActions = new ScenarioOutput(
"createSystemsManagerActions",
"Create a document that defines the actions that Systems Manager performs on your EC2 instance.",
);
const getDocumentName = new ScenarioInput(
"documentName",
"Please enter the document: ",
{ type: "input", default: defaultDocumentName },
);
const sdkCreateSSMDoc = new ScenarioAction(
"sdkCreateSSMDoc",
async (/** @type {State} */ state) => {
const contentData = `{
"schemaVersion": "2.2",
"description": "Run a simple shell command",
"mainSteps": [
{
"action": "aws:runShellScript",
"name": "runEchoCommand",
"inputs": {
"runCommand": [
"echo 'Hello, world!'"
]
}
}
]
}`;
try {
await state.ssmClient.send(
new CreateDocumentCommand({
Content: contentData,
Name: state.documentName,
DocumentType: "Command",
}),
);
} catch (caught) {
console.log(`Exception type: (${typeof caught})`);
if (caught instanceof DocumentAlreadyExists) {
console.log("Document already exists. Continuing...\n");
} else {
console.error(caught.message);
console.log(
`An error occurred while creating the document. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
}
},
);
const ec2HelloWorld = new ScenarioOutput(
"ec2HelloWorld",
`Now you have the option of running a command on an EC2 instance that echoes 'Hello, world!'. In order to run this command, you must provide the instance ID of a Linux EC2 instance. If you do not already have a running Linux EC2 instance in your account, you can create one using the AWS console. For information about creating an EC2 instance, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html.`,
);
const enterIdOrSkipEC2HelloWorld = new ScenarioInput(
"enterIdOrSkipEC2HelloWorld",
"Enter your EC2 InstanceId or press enter to skip this step: ",
{ type: "input", default: "" },
);
const sdkEC2HelloWorld = new ScenarioAction(
"sdkEC2HelloWorld",
async (/** @type {State} */ state) => {
try {
const response = await state.ssmClient.send(
new SendCommandCommand({
DocumentName: state.documentName,
InstanceIds: [state.ec2InstanceId],
TimeoutSeconds: COMMAND_TIMEOUT_DURATION_SECONDS,
}),
);
state.CommandId = response.Command.CommandId;
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while sending the command. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
{
skipWhen: (/** @type {State} */ state) =>
state.enterIdOrSkipEC2HelloWorld === "",
},
);
const sdkGetCommandTime = new ScenarioAction(
"sdkGetCommandTime",
async (/** @type {State} */ state) => {
const listInvocationsPaginated = [];
console.log(
"Let's get the time when the specific command was sent to the specific managed node.",
);
console.log(
`First, we'll wait for the command to finish executing. This may take up to ${COMMAND_TIMEOUT_DURATION_SECONDS} seconds.`,
);
const commandExecutedResult = waitUntilCommandExecuted(
{ client: state.ssmClient },
{
CommandId: state.CommandId,
InstanceId: state.ec2InstanceId,
},
);
// This is necessary because the TimeoutSeconds of SendCommandCommand is only for the delivery, not execution.
try {
await new Promise((_, reject) =>
setTimeout(
reject,
COMMAND_TIMEOUT_DURATION_SECONDS * 1000,
new Error("Command Timed Out"),
),
);
} catch (caught) {
if (caught.message === "Command Timed Out") {
commandExecutedResult.state = "TIMED_OUT";
} else {
throw caught;
}
}
if (commandExecutedResult.state !== "SUCCESS") {
console.log(
`The command with id: ${state.CommandId} did not execute in the allotted time. Canceling command.`,
);
state.ssmClient.send(
new CancelCommandCommand({
CommandId: state.CommandId,
}),
);
state.enterIdOrSkipEC2HelloWorld === "";
return;
}
for await (const page of paginateListCommandInvocations(
{ client: state.ssmClient },
{ CommandId: state.CommandId },
)) {
listInvocationsPaginated.push(...page.CommandInvocations);
}
/**
* @type {import('@aws-sdk/client-ssm').CommandInvocation}
*/
const commandInvocation = listInvocationsPaginated.shift(); // Because the call was made with CommandId, there's only one result, so shift it off.
state.requestedDateTime = commandInvocation.RequestedDateTime;
console.log(
`The command invocation happened at: ${state.requestedDateTime}.`,
);
},
{
skipWhen: (/** @type {State} */ state) =>
state.enterIdOrSkipEC2HelloWorld === "",
},
);
const createSSMOpsItem = new ScenarioOutput(
"createSSMOpsItem",
`Now we will create a Systems Manager OpsItem. An OpsItem is a feature provided by the Systems Manager service. It is a type of operational data item that allows you to manage and track various operational issues, events, or tasks within your AWS environment.
You can create OpsItems to track and manage operational issues as they arise. For example, you could create an OpsItem whenever your application detects a critical error or an anomaly in your infrastructure.`,
);
const sdkCreateSSMOpsItem = new ScenarioAction(
"sdkCreateSSMOpsItem",
async (/** @type {State} */ state) => {
try {
const response = await state.ssmClient.send(
new CreateOpsItemCommand({
Description: "Created by the System Manager Javascript API",
Title: "Disk Space Alert",
Source: "EC2",
Category: "Performance",
Severity: "2",
}),
);
state.opsItemId = response.OpsItemId;
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while creating the ops item. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const updateOpsItem = new ScenarioOutput(
"updateOpsItem",
(/** @type {State} */ state) =>
`Now we will update the OpsItem: ${state.opsItemId}`,
);
const sdkUpdateOpsItem = new ScenarioAction(
"sdkUpdateOpsItem",
async (/** @type {State} */ state) => {
try {
const _response = await state.ssmClient.send(
new UpdateOpsItemCommand({
OpsItemId: state.opsItemId,
Description: `An update to ${state.opsItemId}`,
}),
);
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while updating the ops item. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const getOpsItemStatus = new ScenarioOutput(
"getOpsItemStatus",
(/** @type {State} */ state) =>
`Now we will get the status of the OpsItem: ${state.opsItemId}`,
);
const sdkOpsItemStatus = new ScenarioAction(
"sdkGetOpsItemStatus",
async (/** @type {State} */ state) => {
try {
const response = await state.ssmClient.send(
new DescribeOpsItemsCommand({
OpsItemId: state.opsItemId,
}),
);
state.opsItemStatus = response.OpsItemStatus;
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while describing the ops item. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const resolveOpsItem = new ScenarioOutput(
"resolveOpsItem",
(/** @type {State} */ state) =>
`Now we will resolve the OpsItem: ${state.opsItemId}`,
);
const sdkResolveOpsItem = new ScenarioAction(
"sdkResolveOpsItem",
async (/** @type {State} */ state) => {
try {
const _response = await state.ssmClient.send(
new UpdateOpsItemCommand({
OpsItemId: state.opsItemId,
Status: OpsItemStatus.RESOLVED,
}),
);
} catch (caught) {
console.error(caught.message);
console.log(
`An error occurred while updating the ops item. Please fix the error and try again. Error message: ${caught.message}`,
);
throw caught;
}
},
);
const askToDeleteResources = new ScenarioInput(
"askToDeleteResources",
"Would you like to delete the Systems Manager resources created during this example run?",
{ type: "confirm" },
);
const confirmDeleteChoice = new ScenarioOutput(
"confirmDeleteChoice",
(/** @type {State} */ state) => {
if (state.askToDeleteResources) {
return "You chose to delete the resources.";
}
return "The Systems Manager resources will not be deleted. Please delete them manually to avoid charges.";
},
);
export const sdkDeleteResources = new ScenarioAction(
"sdkDeleteResources",
async (/** @type {State} */ state) => {
try {
await state.ssmClient.send(
new DeleteOpsItemCommand({
OpsItemId: state.opsItemId,
}),
);
console.log(`The ops item: ${state.opsItemId} was successfully deleted.`);
} catch (caught) {
console.log(
`There was a problem deleting the ops item: ${state.opsItemId}. Please delete it manually. Error: ${caught.message}`,
);
}
try {
await state.ssmClient.send(
new DeleteMaintenanceWindowCommand({
Name: state.maintenanceWindow,
WindowId: state.winId,
}),
);
console.log(
`The maintenance window: ${state.maintenanceWindow} was successfully deleted.`,
);
} catch (caught) {
console.log(
`There was a problem deleting the maintenance window: ${state.opsItemId}. Please delete it manually. Error: ${caught.message}`,
);
}
try {
await state.ssmClient.send(
new DeleteDocumentCommand({
Name: state.documentName,
}),
);
console.log(
`The document: ${state.documentName} was successfully deleted.`,
);
} catch (caught) {
console.log(
`There was a problem deleting the document: ${state.documentName}. Please delete it manually. Error: ${caught.message}`,
);
}
},
{ skipWhen: (/** @type {{}} */ state) => !state.askToDeleteResources },
);
const goodbye = new ScenarioOutput(
"goodbye",
"This concludes the Systems Manager Basics scenario for the AWS Javascript SDK v3. Thank you!",
);
const myScenario = new Scenario(
"SSM Basics",
[
greet,
pressEnter,
createMaintenanceWindow,
getMaintenanceWindow,
sdkCreateMaintenanceWindow,
modifyMaintenanceWindow,
pressEnter,
sdkModifyMaintenanceWindow,
createSystemsManagerActions,
getDocumentName,
sdkCreateSSMDoc,
ec2HelloWorld,
enterIdOrSkipEC2HelloWorld,
sdkEC2HelloWorld,
sdkGetCommandTime,
pressEnter,
createSSMOpsItem,
pressEnter,
sdkCreateSSMOpsItem,
updateOpsItem,
pressEnter,
sdkUpdateOpsItem,
getOpsItemStatus,
pressEnter,
sdkOpsItemStatus,
resolveOpsItem,
pressEnter,
sdkResolveOpsItem,
askToDeleteResources,
confirmDeleteChoice,
sdkDeleteResources,
goodbye,
],
{ ssmClient: new SSMClient({}) },
);
/** @type {{ stepHandlerOptions: StepHandlerOptions }} */
export const main = async (stepHandlerOptions) => {
await myScenario.run(stepHandlerOptions);
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
const { values } = parseArgs({
options: {
yes: {
type: "boolean",
short: "y",
},
},
});
main({ confirmAll: values.yes });
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の以下のトピックを参照してください。
+ [CreateDocument](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateDocumentCommand)
+ [CreateMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateMaintenanceWindowCommand)
+ [CreateOpsItem](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateOpsItemCommand)
+ [DeleteMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/DeleteMaintenanceWindowCommand)
+ [ListCommandInvocations](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListCommandInvocationsCommand)
+ [SendCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/SendCommandCommand)
+ [UpdateOpsItem](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/UpdateOpsItemCommand)
## アクション
### `CreateDocument`
次のコード例は、`CreateDocument` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { CreateDocumentCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Create an SSM document.
* @param {{ content: string, name: string, documentType?: DocumentType }}
*/
export const main = async ({ content, name, documentType }) => {
const client = new SSMClient({});
try {
const { documentDescription } = await client.send(
new CreateDocumentCommand({
Content: content, // The content for the new SSM document. The content must not exceed 64KB.
Name: name,
DocumentType: documentType, // Document format type can be JSON, YAML, or TEXT. The default format is JSON.
}),
);
console.log("Document created successfully.");
return { DocumentDescription: documentDescription };
} catch (caught) {
if (caught instanceof Error && caught.name === "DocumentAlreadyExists") {
console.warn(`${caught.message}. Did you provide a new document name?`);
} else {
throw caught;
}
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[CreateDocument](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateDocumentCommand)」を参照してください。
### `CreateMaintenanceWindow`
次のコード例は、`CreateMaintenanceWindow` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { CreateMaintenanceWindowCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Create an SSM maintenance window.
* @param {{ name: string, allowUnassociatedTargets: boolean, duration: number, cutoff: number, schedule: string, description?: string }}
*/
export const main = async ({
name,
allowUnassociatedTargets, // Allow the maintenance window to run on managed nodes, even if you haven't registered those nodes as targets.
duration, // The duration of the maintenance window in hours.
cutoff, // The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
schedule, // The schedule of the maintenance window in the form of a cron or rate expression.
description = undefined,
}) => {
const client = new SSMClient({});
try {
const { windowId } = await client.send(
new CreateMaintenanceWindowCommand({
Name: name,
Description: description,
AllowUnassociatedTargets: allowUnassociatedTargets, // Allow the maintenance window to run on managed nodes, even if you haven't registered those nodes as targets.
Duration: duration, // The duration of the maintenance window in hours.
Cutoff: cutoff, // The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
Schedule: schedule, // The schedule of the maintenance window in the form of a cron or rate expression.
}),
);
console.log(`Maintenance window created with Id: ${windowId}`);
return { WindowId: windowId };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide these values?`);
} else {
throw caught;
}
}
};
```
+ API の詳細については、AWS SDK for JavaScript API リファレンスの「[CreateMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateMaintenanceWindowCommand)」を参照してください。**
### `CreateOpsItem`
次のコード例は、`CreateOpsItem` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { CreateOpsItemCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Create an SSM OpsItem.
* @param {{ title: string, source: string, category?: string, severity?: string }}
*/
export const main = async ({
title,
source,
category = undefined,
severity = undefined,
}) => {
const client = new SSMClient({});
try {
const { opsItemArn, opsItemId } = await client.send(
new CreateOpsItemCommand({
Title: title,
Source: source, // The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
Category: category,
Severity: severity,
}),
);
console.log(`Ops item created with id: ${opsItemId}`);
return { OpsItemArn: opsItemArn, OpsItemId: opsItemId };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide these values?`);
} else {
throw caught;
}
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[CreateOpsItem](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateOpsItemCommand)」を参照してください。
### `DeleteDocument`
次のコード例は、`DeleteDocument` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { DeleteDocumentCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Delete an SSM document.
* @param {{ documentName: string }}
*/
export const main = async ({ documentName }) => {
const client = new SSMClient({});
try {
await client.send(new DeleteDocumentCommand({ Name: documentName }));
console.log(`Document '${documentName}' deleted.`);
return { Deleted: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide this value?`);
} else {
throw caught;
}
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DeleteDocument](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/DeleteDocumentCommand)」を参照してください。
### `DeleteMaintenanceWindow`
次のコード例は、`DeleteMaintenanceWindow` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { DeleteMaintenanceWindowCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Delete an SSM maintenance window.
* @param {{ windowId: string }}
*/
export const main = async ({ windowId }) => {
const client = new SSMClient({});
try {
await client.send(
new DeleteMaintenanceWindowCommand({ WindowId: windowId }),
);
console.log(`Maintenance window '${windowId}' deleted.`);
return { Deleted: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide this value?`);
} else {
throw caught;
}
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[DeleteMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/DeleteMaintenanceWindowCommand)」を参照してください。
### `DescribeOpsItems`
次のコード例は、`DescribeOpsItems` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import {
OpsItemFilterOperator,
OpsItemFilterKey,
paginateDescribeOpsItems,
SSMClient,
} from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Describe SSM OpsItems.
* @param {{ opsItemId: string }}
*/
export const main = async ({ opsItemId }) => {
const client = new SSMClient({});
try {
const describeOpsItemsPaginated = [];
for await (const page of paginateDescribeOpsItems(
{ client },
{
OpsItemFilters: {
Key: OpsItemFilterKey.OPSITEM_ID,
Operator: OpsItemFilterOperator.EQUAL,
Values: opsItemId,
},
},
)) {
describeOpsItemsPaginated.push(...page.OpsItemSummaries);
}
console.log("Here are the ops items:");
console.log(describeOpsItemsPaginated);
return { OpsItemSummaries: describeOpsItemsPaginated };
} catch (caught) {
if (caught instanceof Error && caught.name === "MissingParameter") {
console.warn(`${caught.message}. Did you provide this value?`);
}
throw caught;
}
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[DescribeOpsItems](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/DescribeOpsItemsCommand)」を参照してください。
### `ListCommandInvocations`
次のコード例は、`ListCommandInvocations` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { paginateListCommandInvocations, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* List SSM command invocations on an instance.
* @param {{ instanceId: string }}
*/
export const main = async ({ instanceId }) => {
const client = new SSMClient({});
try {
const listCommandInvocationsPaginated = [];
// The paginate function is a wrapper around the base command.
const paginator = paginateListCommandInvocations(
{ client },
{
InstanceId: instanceId,
},
);
for await (const page of paginator) {
listCommandInvocationsPaginated.push(...page.CommandInvocations);
}
console.log("Here is the list of command invocations:");
console.log(listCommandInvocationsPaginated);
return { CommandInvocations: listCommandInvocationsPaginated };
} catch (caught) {
if (caught instanceof Error && caught.name === "ValidationError") {
console.warn(`${caught.message}. Did you provide a valid instance ID?`);
}
throw caught;
}
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[ListCommandInvocations](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListCommandInvocationsCommand)」を参照してください。
### `SendCommand`
次のコード例は、`SendCommand` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { SendCommandCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Send an SSM command to a managed node.
* @param {{ documentName: string }}
*/
export const main = async ({ documentName }) => {
const client = new SSMClient({});
try {
await client.send(
new SendCommandCommand({
DocumentName: documentName,
}),
);
console.log("Command sent successfully.");
return { Success: true };
} catch (caught) {
if (caught instanceof Error && caught.name === "ValidationError") {
console.warn(`${caught.message}. Did you provide a valid document name?`);
} else {
throw caught;
}
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[SendCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/SendCommandCommand)」を参照してください。
### `UpdateMaintenanceWindow`
次のコード例は、`UpdateMaintenanceWindow` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { UpdateMaintenanceWindowCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Update an SSM maintenance window.
* @param {{ windowId: string, allowUnassociatedTargets?: boolean, duration?: number, enabled?: boolean, name?: string, schedule?: string }}
*/
export const main = async ({
windowId,
allowUnassociatedTargets = undefined, //Allow the maintenance window to run on managed nodes, even if you haven't registered those nodes as targets.
duration = undefined, //The duration of the maintenance window in hours.
enabled = undefined,
name = undefined,
schedule = undefined, //The schedule of the maintenance window in the form of a cron or rate expression.
}) => {
const client = new SSMClient({});
try {
const { opsItemArn, opsItemId } = await client.send(
new UpdateMaintenanceWindowCommand({
WindowId: windowId,
AllowUnassociatedTargets: allowUnassociatedTargets,
Duration: duration,
Enabled: enabled,
Name: name,
Schedule: schedule,
}),
);
console.log("Maintenance window updated.");
return { OpsItemArn: opsItemArn, OpsItemId: opsItemId };
} catch (caught) {
if (caught instanceof Error && caught.name === "ValidationError") {
console.warn(`${caught.message}. Are these values correct?`);
} else {
throw caught;
}
}
};
```
+ API の詳細については、*AWS SDK for JavaScript API リファレンス*の「[UpdateMaintenanceWindow](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/UpdateMaintenanceWindowCommand)」を参照してください。
### `UpdateOpsItem`
次のコード例は、`UpdateOpsItem` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples)での設定と実行の方法を確認してください。
```
import { UpdateOpsItemCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Update an SSM OpsItem.
* @param {{ opsItemId: string, status?: OpsItemStatus }}
*/
export const main = async ({
opsItemId,
status = undefined, // The OpsItem status. Status can be Open, In Progress, or Resolved
}) => {
const client = new SSMClient({});
try {
await client.send(
new UpdateOpsItemCommand({
OpsItemId: opsItemId,
Status: status,
}),
);
console.log("Ops item updated.");
return { Success: true };
} catch (caught) {
if (
caught instanceof Error &&
caught.name === "OpsItemLimitExceededException"
) {
console.warn(
`Couldn't create ops item because you have exceeded your open OpsItem limit. ${caught.message}.`,
);
} else {
throw caught;
}
}
};
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[UpdateOpsItem](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/UpdateOpsItemCommand)」を参照してください。
# SDK for JavaScript (v3) を使用した Amazon Textract の例
次のコード例は、Amazon Textract で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*シナリオ*は、1 つのサービス内から、または他の AWS のサービスと組み合わせて複数の関数を呼び出し、特定のタスクを実行する方法を示すコード例です。
各例には完全なソースコードへのリンクが含まれており、コンテキスト内でコードを設定および実行する方法の手順を確認できます。
**Topics**
+ [シナリオ](#scenarios)
## シナリオ
### Amazon Textract エクスプローラーアプリケーションを作成する
次のコード例は、インタラクティブアプリケーションで Amazon Textract の出力を調べる方法を示しています。
**SDK for JavaScript (v3)**
を使用して、Amazon Textract を使用してドキュメントイメージからデータを抽出し、インタラクティブなウェブページに表示する React アプリケーション AWS SDK for JavaScript を構築する方法を示します。この例はウェブブラウザで実行され、認証情報に認証された Amazon Cognito ID が必要です。Amazon Simple Storage Service (Amazon S3) をストレージに使用し、通知のために、Amazon Simple Notification Service (Amazon SNS) トピックにサブスクライブした Amazon Simple Queue Service (Amazon SQS) キューをポーリングします。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/textract-react) で完全な例を参照してください。
**この例で使用されているサービス**
+ Amazon Cognito ID
+ Amazon S3
+ Amazon SNS
+ Amazon SQS
+ Amazon Textract
### 顧客からのフィードバックを分析するアプリケーションの作成
次のコード例は、顧客のコメントカードを分析し、元の言語から翻訳し、顧客の感情を判断して、翻訳されたテキストから音声ファイルを生成するアプリケーションの作成方法を示しています。
**SDK for JavaScript (v3)**
このサンプルアプリケーションは、顧客フィードバックカードを分析し、保存します。具体的には、ニューヨーク市の架空のホテルのニーズを満たします。このホテルでは、お客様からのフィードバックをさまざまな言語で書かれた実際のコメントカードの形で受け取ります。そのフィードバックは、ウェブクライアントを通じてアプリにアップロードされます。コメントカードの画像をアップロードされると、次の手順が発生します。
+ テキストは Amazon Textract を使用して、画像から抽出されます。
+ Amazon Comprehend は、抽出したテキストの感情とその言語を分析します。
+ 抽出されたテキストは、Amazon Translate を使用して英語に翻訳されます。
+ Amazon Polly は抽出したテキストから音声ファイルを合成します。
完全なアプリは AWS CDK を使用してデプロイすることができます。ソースコードとデプロイ手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/feedback-sentiment-analyzer) のプロジェクトを参照してください。次の抜粋 AWS SDK for JavaScript は、Lambda 関数内で がどのように使用されるかを示しています。
```
import {
ComprehendClient,
DetectDominantLanguageCommand,
DetectSentimentCommand,
} from "@aws-sdk/client-comprehend";
/**
* Determine the language and sentiment of the extracted text.
*
* @param {{ source_text: string}} extractTextOutput
*/
export const handler = async (extractTextOutput) => {
const comprehendClient = new ComprehendClient({});
const detectDominantLanguageCommand = new DetectDominantLanguageCommand({
Text: extractTextOutput.source_text,
});
// The source language is required for sentiment analysis and
// translation in the next step.
const { Languages } = await comprehendClient.send(
detectDominantLanguageCommand,
);
const languageCode = Languages[0].LanguageCode;
const detectSentimentCommand = new DetectSentimentCommand({
Text: extractTextOutput.source_text,
LanguageCode: languageCode,
});
const { Sentiment } = await comprehendClient.send(detectSentimentCommand);
return {
sentiment: Sentiment,
language_code: languageCode,
};
};
```
```
import {
DetectDocumentTextCommand,
TextractClient,
} from "@aws-sdk/client-textract";
/**
* Fetch the S3 object from the event and analyze it using Amazon Textract.
*
* @param {import("@types/aws-lambda").EventBridgeEvent<"Object Created">} eventBridgeS3Event
*/
export const handler = async (eventBridgeS3Event) => {
const textractClient = new TextractClient();
const detectDocumentTextCommand = new DetectDocumentTextCommand({
Document: {
S3Object: {
Bucket: eventBridgeS3Event.bucket,
Name: eventBridgeS3Event.object,
},
},
});
// Textract returns a list of blocks. A block can be a line, a page, word, etc.
// Each block also contains geometry of the detected text.
// For more information on the Block type, see https://docs.aws.amazon.com/textract/latest/dg/API_Block.html.
const { Blocks } = await textractClient.send(detectDocumentTextCommand);
// For the purpose of this example, we are only interested in words.
const extractedWords = Blocks.filter((b) => b.BlockType === "WORD").map(
(b) => b.Text,
);
return extractedWords.join(" ");
};
```
```
import { PollyClient, SynthesizeSpeechCommand } from "@aws-sdk/client-polly";
import { S3Client } from "@aws-sdk/client-s3";
import { Upload } from "@aws-sdk/lib-storage";
/**
* Synthesize an audio file from text.
*
* @param {{ bucket: string, translated_text: string, object: string}} sourceDestinationConfig
*/
export const handler = async (sourceDestinationConfig) => {
const pollyClient = new PollyClient({});
const synthesizeSpeechCommand = new SynthesizeSpeechCommand({
Engine: "neural",
Text: sourceDestinationConfig.translated_text,
VoiceId: "Ruth",
OutputFormat: "mp3",
});
const { AudioStream } = await pollyClient.send(synthesizeSpeechCommand);
const audioKey = `${sourceDestinationConfig.object}.mp3`;
// Store the audio file in S3.
const s3Client = new S3Client();
const upload = new Upload({
client: s3Client,
params: {
Bucket: sourceDestinationConfig.bucket,
Key: audioKey,
Body: AudioStream,
ContentType: "audio/mp3",
},
});
await upload.done();
return audioKey;
};
```
```
import {
TranslateClient,
TranslateTextCommand,
} from "@aws-sdk/client-translate";
/**
* Translate the extracted text to English.
*
* @param {{ extracted_text: string, source_language_code: string}} textAndSourceLanguage
*/
export const handler = async (textAndSourceLanguage) => {
const translateClient = new TranslateClient({});
const translateCommand = new TranslateTextCommand({
SourceLanguageCode: textAndSourceLanguage.source_language_code,
TargetLanguageCode: "en",
Text: textAndSourceLanguage.extracted_text,
});
const { TranslatedText } = await translateClient.send(translateCommand);
return { translated_text: TranslatedText };
};
```
**この例で使用されているサービス**
+ Amazon Comprehend
+ Lambda
+ Amazon Polly
+ Amazon Textract
+ Amazon Translate
# SDK for JavaScript (v3) を使用した Amazon Transcribe の例
次のコード例は、Amazon Transcribe で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
*シナリオ*は、1 つのサービス内から、または他の AWS のサービスと組み合わせて複数の関数を呼び出し、特定のタスクを実行する方法を示すコード例です。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
+ [シナリオ](#scenarios)
## アクション
### `DeleteMedicalTranscriptionJob`
次のコード例は、`DeleteMedicalTranscriptionJob` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples)での設定と実行の方法を確認してください。
クライアントを作成します。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
医療分野の文字起こしジョブを削除します。
```
// Import the required AWS SDK clients and commands for Node.js
import { DeleteMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
MedicalTranscriptionJobName: "MEDICAL_JOB_NAME", // For example, 'medical_transciption_demo'
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new DeleteMedicalTranscriptionJobCommand(params),
);
console.log("Success - deleted");
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-medical-examples-section.html#transcribe-delete-medical-job)」を参照してください。
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[DeleteMedicalTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/DeleteMedicalTranscriptionJobCommand)」を参照してください。
### `DeleteTranscriptionJob`
次のコード例は、`DeleteTranscriptionJob` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples)での設定と実行の方法を確認してください。
文字起こしジョブを削除します。
```
// Import the required AWS SDK clients and commands for Node.js
import { DeleteTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
TranscriptionJobName: "JOB_NAME", // Required. For example, 'transciption_demo'
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new DeleteTranscriptionJobCommand(params),
);
console.log("Success - deleted");
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
クライアントを作成します。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-examples-section.html#transcribe-delete-job)」を参照してください。
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[DeleteTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/DeleteTranscriptionJobCommand)」を参照してください。
### `ListMedicalTranscriptionJobs`
次のコード例は、`ListMedicalTranscriptionJobs` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples)での設定と実行の方法を確認してください。
クライアントを作成します。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
医療分野の文字起こしジョブを一覧表示します。
```
// Import the required AWS SDK clients and commands for Node.js
import { StartMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
MedicalTranscriptionJobName: "MEDICAL_JOB_NAME", // Required
OutputBucketName: "OUTPUT_BUCKET_NAME", // Required
Specialty: "PRIMARYCARE", // Required. Possible values are 'PRIMARYCARE'
Type: "JOB_TYPE", // Required. Possible values are 'CONVERSATION' and 'DICTATION'
LanguageCode: "LANGUAGE_CODE", // For example, 'en-US'
MediaFormat: "SOURCE_FILE_FORMAT", // For example, 'wav'
Media: {
MediaFileUri: "SOURCE_FILE_LOCATION",
// The S3 object location of the input media file. The URI must be in the same region
// as the API endpoint that you are calling.For example,
// "https://transcribe-demo.s3-REGION.amazonaws.com/hello_world.wav"
},
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new StartMedicalTranscriptionJobCommand(params),
);
console.log("Success - put", data);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-medical-examples-section.html#transcribe-list-medical-jobs)」を参照してください。
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[ListMedicalTranscriptionJobs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/ListMedicalTranscriptionJobsCommand)」を参照してください。
### `ListTranscriptionJobs`
次のコード例は、`ListTranscriptionJobs` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples)での設定と実行の方法を確認してください。
文字起こしジョブを一覧表示します。
```
// Import the required AWS SDK clients and commands for Node.js
import { ListTranscriptionJobsCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
JobNameContains: "KEYWORD", // Not required. Returns only transcription
// job names containing this string
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new ListTranscriptionJobsCommand(params),
);
console.log("Success", data.TranscriptionJobSummaries);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
クライアントを作成します。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-examples-section.html#transcribe-list-jobs)」を参照してください。
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[ListTranscriptionJobs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/ListTranscriptionJobsCommand)」を参照してください。
### `StartMedicalTranscriptionJob`
次のコード例は、`StartMedicalTranscriptionJob` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples)での設定と実行の方法を確認してください。
クライアントを作成します。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
医療分野の文字起こしジョブを開始します。
```
// Import the required AWS SDK clients and commands for Node.js
import { StartMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
MedicalTranscriptionJobName: "MEDICAL_JOB_NAME", // Required
OutputBucketName: "OUTPUT_BUCKET_NAME", // Required
Specialty: "PRIMARYCARE", // Required. Possible values are 'PRIMARYCARE'
Type: "JOB_TYPE", // Required. Possible values are 'CONVERSATION' and 'DICTATION'
LanguageCode: "LANGUAGE_CODE", // For example, 'en-US'
MediaFormat: "SOURCE_FILE_FORMAT", // For example, 'wav'
Media: {
MediaFileUri: "SOURCE_FILE_LOCATION",
// The S3 object location of the input media file. The URI must be in the same region
// as the API endpoint that you are calling.For example,
// "https://transcribe-demo.s3-REGION.amazonaws.com/hello_world.wav"
},
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new StartMedicalTranscriptionJobCommand(params),
);
console.log("Success - put", data);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-medical-examples-section.html#transcribe-start-medical-transcription)」を参照してください。
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[StartMedicalTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/StartMedicalTranscriptionJobCommand)」を参照してください。
### `StartTranscriptionJob`
次のコード例は、`StartTranscriptionJob` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples)での設定と実行の方法を確認してください。
文字起こしジョブを開始します。
```
// Import the required AWS SDK clients and commands for Node.js
import { StartTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
TranscriptionJobName: "JOB_NAME",
LanguageCode: "LANGUAGE_CODE", // For example, 'en-US'
MediaFormat: "SOURCE_FILE_FORMAT", // For example, 'wav'
Media: {
MediaFileUri: "SOURCE_LOCATION",
// For example, "https://transcribe-demo.s3-REGION.amazonaws.com/hello_world.wav"
},
OutputBucketName: "OUTPUT_BUCKET_NAME",
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new StartTranscriptionJobCommand(params),
);
console.log("Success - put", data);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
クライアントを作成します。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
+ 詳細については、「[AWS SDK for JavaScript デベロッパーガイド](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-examples-section.html#transcribe-start-transcription)」を参照してください。
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[StartTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/StartTranscriptionJobCommand)」を参照してください。
## シナリオ
### Amazon Transcribe ストリーミングアプリケーションを構築する
次のコード例は、ライブ音声をリアルタイムで記録、転写、翻訳し、結果を E メールで送信するアプリケーションを構築する方法を示しています。
**SDK for JavaScript (v3)**
Amazon Transcribe を使用して、ライブ音声をリアルタイムで記録、転写、翻訳し、Amazon Simple Email Service (Amazon SES) を使用して結果を E メールで送信するアプリケーションを構築する方法について説明します。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/transcribe-streaming-app) で完全な例を参照してください。
**この例で使用されているサービス**
+ Amazon Comprehend
+ Amazon SES
+ Amazon Transcribe
+ Amazon Translate
# SDK for JavaScript (v3) を使用した Amazon Translate の例
次のコード例は、Amazon Translate で AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*シナリオ*は、1 つのサービス内から、または他の AWS のサービスと組み合わせて複数の関数を呼び出し、特定のタスクを実行する方法を示すコード例です。
各例には完全なソースコードへのリンクが含まれており、コンテキスト内でコードを設定および実行する方法の手順を確認できます。
**Topics**
+ [シナリオ](#scenarios)
## シナリオ
### Amazon Transcribe ストリーミングアプリケーションを構築する
次のコード例は、ライブ音声をリアルタイムで記録、転写、翻訳し、結果を E メールで送信するアプリケーションを構築する方法を示しています。
**SDK for JavaScript (v3)**
Amazon Transcribe を使用して、ライブ音声をリアルタイムで記録、転写、翻訳し、Amazon Simple Email Service (Amazon SES) を使用して結果を E メールで送信するアプリケーションを構築する方法について説明します。
完全なソースコードとセットアップおよび実行の手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/transcribe-streaming-app) で完全な例を参照してください。
**この例で使用されているサービス**
+ Amazon Comprehend
+ Amazon SES
+ Amazon Transcribe
+ Amazon Translate
### Amazon Lex チャットボットを構築する
次のコード例は、ウェブサイトの訪問者を引き付けるチャットボットの作成方法を示しています。
**SDK for JavaScript (v3)**
Amazon Lex API を使用して、ウェブアプリケーション内にチャットボットを作成し、Web サイトの訪問者と交流する方法を説明します。
完全なソースコードとセットアップと実行の手順については、 デ AWS SDK for JavaScript ベロッパーガイドの[Amazon Lexチャットボットの構築](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/lex-bot-example.html)」の完全な例を参照してください。
**この例で使用されているサービス**
+ Amazon Comprehend
+ Amazon Lex
+ Amazon Translate
### 顧客からのフィードバックを分析するアプリケーションの作成
次のコード例は、顧客のコメントカードを分析し、元の言語から翻訳し、顧客の感情を判断して、翻訳されたテキストから音声ファイルを生成するアプリケーションの作成方法を示しています。
**SDK for JavaScript (v3)**
このサンプルアプリケーションは、顧客フィードバックカードを分析し、保存します。具体的には、ニューヨーク市の架空のホテルのニーズを満たします。このホテルでは、お客様からのフィードバックをさまざまな言語で書かれた実際のコメントカードの形で受け取ります。そのフィードバックは、ウェブクライアントを通じてアプリにアップロードされます。コメントカードの画像をアップロードされると、次の手順が発生します。
+ テキストは Amazon Textract を使用して、画像から抽出されます。
+ Amazon Comprehend は、抽出したテキストの感情とその言語を分析します。
+ 抽出されたテキストは、Amazon Translate を使用して英語に翻訳されます。
+ Amazon Polly は抽出したテキストから音声ファイルを合成します。
完全なアプリは AWS CDK を使用してデプロイすることができます。ソースコードとデプロイ手順については、[GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/feedback-sentiment-analyzer) のプロジェクトを参照してください。次の抜粋 AWS SDK for JavaScript は、Lambda 関数内で がどのように使用されるかを示しています。
```
import {
ComprehendClient,
DetectDominantLanguageCommand,
DetectSentimentCommand,
} from "@aws-sdk/client-comprehend";
/**
* Determine the language and sentiment of the extracted text.
*
* @param {{ source_text: string}} extractTextOutput
*/
export const handler = async (extractTextOutput) => {
const comprehendClient = new ComprehendClient({});
const detectDominantLanguageCommand = new DetectDominantLanguageCommand({
Text: extractTextOutput.source_text,
});
// The source language is required for sentiment analysis and
// translation in the next step.
const { Languages } = await comprehendClient.send(
detectDominantLanguageCommand,
);
const languageCode = Languages[0].LanguageCode;
const detectSentimentCommand = new DetectSentimentCommand({
Text: extractTextOutput.source_text,
LanguageCode: languageCode,
});
const { Sentiment } = await comprehendClient.send(detectSentimentCommand);
return {
sentiment: Sentiment,
language_code: languageCode,
};
};
```
```
import {
DetectDocumentTextCommand,
TextractClient,
} from "@aws-sdk/client-textract";
/**
* Fetch the S3 object from the event and analyze it using Amazon Textract.
*
* @param {import("@types/aws-lambda").EventBridgeEvent<"Object Created">} eventBridgeS3Event
*/
export const handler = async (eventBridgeS3Event) => {
const textractClient = new TextractClient();
const detectDocumentTextCommand = new DetectDocumentTextCommand({
Document: {
S3Object: {
Bucket: eventBridgeS3Event.bucket,
Name: eventBridgeS3Event.object,
},
},
});
// Textract returns a list of blocks. A block can be a line, a page, word, etc.
// Each block also contains geometry of the detected text.
// For more information on the Block type, see https://docs.aws.amazon.com/textract/latest/dg/API_Block.html.
const { Blocks } = await textractClient.send(detectDocumentTextCommand);
// For the purpose of this example, we are only interested in words.
const extractedWords = Blocks.filter((b) => b.BlockType === "WORD").map(
(b) => b.Text,
);
return extractedWords.join(" ");
};
```
```
import { PollyClient, SynthesizeSpeechCommand } from "@aws-sdk/client-polly";
import { S3Client } from "@aws-sdk/client-s3";
import { Upload } from "@aws-sdk/lib-storage";
/**
* Synthesize an audio file from text.
*
* @param {{ bucket: string, translated_text: string, object: string}} sourceDestinationConfig
*/
export const handler = async (sourceDestinationConfig) => {
const pollyClient = new PollyClient({});
const synthesizeSpeechCommand = new SynthesizeSpeechCommand({
Engine: "neural",
Text: sourceDestinationConfig.translated_text,
VoiceId: "Ruth",
OutputFormat: "mp3",
});
const { AudioStream } = await pollyClient.send(synthesizeSpeechCommand);
const audioKey = `${sourceDestinationConfig.object}.mp3`;
// Store the audio file in S3.
const s3Client = new S3Client();
const upload = new Upload({
client: s3Client,
params: {
Bucket: sourceDestinationConfig.bucket,
Key: audioKey,
Body: AudioStream,
ContentType: "audio/mp3",
},
});
await upload.done();
return audioKey;
};
```
```
import {
TranslateClient,
TranslateTextCommand,
} from "@aws-sdk/client-translate";
/**
* Translate the extracted text to English.
*
* @param {{ extracted_text: string, source_language_code: string}} textAndSourceLanguage
*/
export const handler = async (textAndSourceLanguage) => {
const translateClient = new TranslateClient({});
const translateCommand = new TranslateTextCommand({
SourceLanguageCode: textAndSourceLanguage.source_language_code,
TargetLanguageCode: "en",
Text: textAndSourceLanguage.extracted_text,
});
const { TranslatedText } = await translateClient.send(translateCommand);
return { translated_text: TranslatedText };
};
```
**この例で使用されているサービス**
+ Amazon Comprehend
+ Lambda
+ Amazon Polly
+ Amazon Textract
+ Amazon Translate