Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
textract-dg-124	textract-dg.pdf	124	"string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } StartExpenseAnalysis 532 Amazon Textract Request Parameters The request accepts the following data in JSON format. ClientRequestToken Developer Guide The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9-_]+$ Required: No DocumentLocation The location of the document to be processed. Type: DocumentLocation object Required: Yes JobTag An identiﬁer you specify that's included in the completion notiﬁcation published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notiﬁcation corresponds to (such as a tax form or a receipt). Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_.\-:]+ Required: No KMSKeyId The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of StartExpenseAnalysis 533 Amazon Textract Developer Guide the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: No NotiﬁcationChannel The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to. Type: NotiﬁcationChannel object Required: No OutputConﬁg Sets if the output will go to a customer deﬁned bucket. By default, Amazon Textract will save the results internally to be accessed by the GetExpenseAnalysis operation. Type: OutputConﬁg object Required: No Response Syntax { "JobId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. StartExpenseAnalysis 534 Amazon Textract JobId Developer Guide A unique identiﬁer for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9-_]+$ Errors AccessDeniedException You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 BadDocumentException Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see Quotas in Amazon Textract. HTTP Status Code: 400 DocumentTooLargeException The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF ﬁles. HTTP Status Code: 400 IdempotentParameterMismatchException A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is diﬀerent from the previous call to the operation. HTTP Status Code: 400 InternalServerError Amazon Textract experienced a service issue. Try your call again. StartExpenseAnalysis 535 Amazon Textract HTTP Status Code: 500 InvalidKMSKeyException Developer Guide Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 InvalidParameterException An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 InvalidS3ObjectException Amazon Textract is unable to access the S3 object that's speciﬁed in the request. for more information, Conﬁgure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3 HTTP Status Code: 400 LimitExceededException An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. HTTP Status Code: 400 ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ThrottlingException Amazon Textract is temporarily unable to process the request. Try your call again. StartExpenseAnalysis 536 Amazon Textract Developer Guide HTTP Status Code: 500 UnsupportedDocumentException The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for
textract-dg-125	textract-dg.pdf	125	400 ThrottlingException Amazon Textract is temporarily unable to process the request. Try your call again. StartExpenseAnalysis 536 Amazon Textract Developer Guide HTTP Status Code: 500 UnsupportedDocumentException The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartExpenseAnalysis 537 Amazon Textract StartLendingAnalysis Developer Guide Starts the classiﬁcation and analysis of an input document. StartLendingAnalysis initiates the classiﬁcation and analysis of a packet of lending documents. StartLendingAnalysis operates on a document ﬁle located in an Amazon S3 bucket. StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the ﬁle name of the document. StartLendingAnalysis returns a job identiﬁer (JobId) that you use to get the results of the operation. When the text analysis is ﬁnished, Amazon Textract publishes a completion status to the Amazon Simple Notiﬁcation Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, ﬁrst check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis. If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the speciﬁed preﬁx in a directory labeled with the job-id. In the directory there are 3 sub-directories: • detailedResponse (contains the GetLendingAnalysis response) • summaryResponse (for the GetLendingAnalysisSummary response) • splitDocuments (documents split across logical boundaries) Request Syntax { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", StartLendingAnalysis 538 Amazon Textract Developer Guide "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } Request Parameters The request accepts the following data in JSON format. ClientRequestToken The idempotent token that you use to identify the start request. If you use the same token with multiple StartLendingAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9-_]+$ Required: No DocumentLocation The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations. The input document can be an image ﬁle in JPEG or PNG format. It can also be a ﬁle in PDF format. Type: DocumentLocation object Required: Yes JobTag An identiﬁer that you specify to be included in the completion notiﬁcation published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notiﬁcation corresponds to (such as a tax form or a receipt). StartLendingAnalysis 539 Amazon Textract Type: String Developer Guide Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9_.\-:]+ Required: No KMSKeyId The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ Required: No NotiﬁcationChannel The Amazon Simple Notiﬁcation Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation. Type: NotiﬁcationChannel object Required: No OutputConﬁg Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the preﬁx on the output ﬁle. OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the ﬁle preﬁx of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3. StartLendingAnalysis 540 Amazon Textract Developer Guide Decryption of
textract-dg-126	textract-dg.pdf	126	which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the ﬁle preﬁx of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3. StartLendingAnalysis 540 Amazon Textract Developer Guide Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy. For more information on data privacy, see the Data Privacy FAQ. Type: OutputConﬁg object Required: No Response Syntax { "JobId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. JobId A unique identiﬁer for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9-_]+$ Errors AccessDeniedException You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. StartLendingAnalysis 541 Amazon Textract HTTP Status Code: 400 BadDocumentException Developer Guide Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see Quotas in Amazon Textract. HTTP Status Code: 400 DocumentTooLargeException The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF ﬁles. HTTP Status Code: 400 IdempotentParameterMismatchException A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is diﬀerent from the previous call to the operation. HTTP Status Code: 400 InternalServerError Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 InvalidKMSKeyException Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 InvalidParameterException An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 StartLendingAnalysis 542 Amazon Textract InvalidS3ObjectException Developer Guide Amazon Textract is unable to access the S3 object that's speciﬁed in the request. for more information, Conﬁgure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3 HTTP Status Code: 400 LimitExceededException An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. HTTP Status Code: 400 ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ThrottlingException Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 UnsupportedDocumentException The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface StartLendingAnalysis 543 Developer Guide Amazon Textract • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 StartLendingAnalysis 544 Amazon Textract TagResource Adds one or more tags to the speciﬁed resource. Developer Guide Request Syntax { "ResourceARN": "string", "Tags": { "string" : "string" } } Request Parameters The request accepts the following data in JSON format. ResourceARN The Amazon Resource Name (ARN) that speciﬁes the resource to be tagged. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes Tags A set of tags (key-value pairs) that you want to assign to the resource. Type: String to string map Map Entries: Minimum number of 0
textract-dg-127	textract-dg.pdf	127	for Python • AWS SDK for Ruby V3 StartLendingAnalysis 544 Amazon Textract TagResource Adds one or more tags to the speciﬁed resource. Developer Guide Request Syntax { "ResourceARN": "string", "Tags": { "string" : "string" } } Request Parameters The request accepts the following data in JSON format. ResourceARN The Amazon Resource Name (ARN) that speciﬁes the resource to be tagged. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes Tags A set of tags (key-value pairs) that you want to assign to the resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: Yes TagResource 545 Amazon Textract Response Elements Developer Guide If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors AccessDeniedException You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 InternalServerError Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 InvalidParameterException An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ResourceNotFoundException Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ServiceQuotaExceededException Returned when a request cannot be completed as it would exceed a maximum service quota. HTTP Status Code: 400 TagResource 546 Amazon Textract ThrottlingException Developer Guide Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ValidationException Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 TagResource 547 Amazon Textract UntagResource Developer Guide Removes any tags with the speciﬁed keys from the speciﬁed resource. Request Syntax { "ResourceARN": "string", "TagKeys": [ "string" ] } Request Parameters The request accepts the following data in JSON format. ResourceARN The Amazon Resource Name (ARN) that speciﬁes the resource to be untagged. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes TagKeys Speciﬁes the tags to be removed from the resource speciﬁed by the ResourceARN. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. UntagResource 548 Amazon Textract Errors AccessDeniedException Developer Guide You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 InternalServerError Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 InvalidParameterException An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ResourceNotFoundException Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ThrottlingException Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ValidationException Indicates that a request was not valid. Check request for proper formatting. UntagResource 549 Amazon Textract HTTP Status Code: 400 See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for
textract-dg-128	textract-dg.pdf	128	again. HTTP Status Code: 500 ValidationException Indicates that a request was not valid. Check request for proper formatting. UntagResource 549 Amazon Textract HTTP Status Code: 400 See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UntagResource 550 Amazon Textract UpdateAdapter Developer Guide Update the conﬁguration for an adapter. FeatureTypes conﬁgurations cannot be updated. At least one new parameter must be speciﬁed as an argument. Request Syntax { "AdapterId": "string", "AdapterName": "string", "AutoUpdate": "string", "Description": "string" } Request Parameters The request accepts the following data in JSON format. AdapterId A string containing a unique ID for the adapter that will be updated. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: Yes AdapterName The new name to be applied to the adapter. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [a-zA-Z0-9-_]+ Required: No AutoUpdate The new auto-update status to be applied to the adapter. Type: String UpdateAdapter 551 Amazon Textract Developer Guide Valid Values: ENABLED \| DISABLED Required: No Description The new description to be applied to the adapter. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\\+\,\-\./:;=\?@\[\\\]\^_`\{\\|\}~><]+$ Required: No Response Syntax { "AdapterId": "string", "AdapterName": "string", "AutoUpdate": "string", "CreationTime": number, "Description": "string", "FeatureTypes": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AdapterId A string containing a unique ID for the adapter that has been updated. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. AdapterName A string containing the name of the adapter that has been updated. UpdateAdapter 552 Amazon Textract Type: String Developer Guide Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [a-zA-Z0-9-_]+ AutoUpdate The auto-update status of the adapter that has been updated. Type: String Valid Values: ENABLED \| DISABLED CreationTime An object specifying the creation time of the the adapter that has been updated. Type: Timestamp Description A string containing the description of the adapter that has been updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\\+\,\-\./:;=\?@\[\\\]\^_`\{\\|\}~><]+$ FeatureTypes List of the targeted feature types for the updated adapter. Type: Array of strings Valid Values: TABLES \| FORMS \| QUERIES \| SIGNATURES \| LAYOUT Errors AccessDeniedException You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. UpdateAdapter 553 Developer Guide Amazon Textract HTTP Status Code: 400 ConﬂictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 400 InternalServerError Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 InvalidParameterException An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ResourceNotFoundException Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ThrottlingException Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ValidationException Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 UpdateAdapter 554 Amazon Textract See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Data Types The following data types are supported: • Adapter • AdapterOverview • AdaptersConﬁg • AdapterVersionDatasetConﬁg • AdapterVersionEvaluationMetric • AdapterVersionOverview • AnalyzeIDDetections • Block • BoundingBox • DetectedSignature • Document • DocumentGroup • DocumentLocation Data Types 555 Amazon Textract • DocumentMetadata • EvaluationMetric • ExpenseCurrency • ExpenseDetection • ExpenseDocument • ExpenseField • ExpenseGroupProperty • ExpenseType • Extraction • Geometry • HumanLoopActivationOutput • HumanLoopConﬁg • HumanLoopDataAttributes • IdentityDocument • IdentityDocumentField • LendingDetection • LendingDocument • LendingField • LendingResult • LendingSummary • LineItemFields • LineItemGroup • NormalizedValue •
textract-dg-129	textract-dg.pdf	129	for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Data Types The following data types are supported: • Adapter • AdapterOverview • AdaptersConﬁg • AdapterVersionDatasetConﬁg • AdapterVersionEvaluationMetric • AdapterVersionOverview • AnalyzeIDDetections • Block • BoundingBox • DetectedSignature • Document • DocumentGroup • DocumentLocation Data Types 555 Amazon Textract • DocumentMetadata • EvaluationMetric • ExpenseCurrency • ExpenseDetection • ExpenseDocument • ExpenseField • ExpenseGroupProperty • ExpenseType • Extraction • Geometry • HumanLoopActivationOutput • HumanLoopConﬁg • HumanLoopDataAttributes • IdentityDocument • IdentityDocumentField • LendingDetection • LendingDocument • LendingField • LendingResult • LendingSummary • LineItemFields • LineItemGroup • NormalizedValue • NotiﬁcationChannel • OutputConﬁg • PageClassiﬁcation • Point • Prediction • QueriesConﬁg • Query Data Types Developer Guide 556 Amazon Textract • Relationship • S3Object • SignatureDetection • SplitDocument • UndetectedSignature • Warning Developer Guide Data Types 557 Amazon Textract Adapter Developer Guide An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously. Contents AdapterId A unique identiﬁer for the adapter resource. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: Yes Version A string that identiﬁes the version of the adapter. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Pages Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter. • If a page is not speciﬁed, it is set to ["1"] by default. • The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - . No whitespace is allowed. • When using to indicate all pages, it must be the only element in the list. • You can use page intervals, such as ["1-3", "1-1", "4-"]. Where indicates last page of document. • Speciﬁed pages must be greater than 0 and less than or equal to the number of pages in the document. Type: Array of strings Adapter 558 Amazon Textract Developer Guide Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 9. Pattern: ^[0-9\*\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Adapter 559 Amazon Textract AdapterOverview Developer Guide Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types. Contents AdapterId A unique identiﬁer for the adapter resource. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: No AdapterName A string naming the adapter resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [a-zA-Z0-9-_]+ Required: No CreationTime The date and time that the adapter was created. Type: Timestamp Required: No FeatureTypes The feature types that the adapter is operating on. Type: Array of strings Valid Values: TABLES \| FORMS \| QUERIES \| SIGNATURES \| LAYOUT AdapterOverview 560 Amazon Textract Required: No See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AdapterOverview 561 Amazon Textract AdaptersConﬁg Developer Guide Contains information about adapters used when analyzing a document, with each adapter speciﬁed using an AdapterId and version Contents Adapters A list of adapters to be used when analyzing the speciﬁed document. Type: Array of Adapter objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AdaptersConﬁg 562 Amazon Textract Developer Guide AdapterVersionDatasetConﬁg The dataset conﬁguration options for a given version of an adapter. Can include an Amazon S3 bucket if speciﬁed. Contents ManifestS3Object The S3 bucket name and ﬁle name that identiﬁes the document. The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations. For Amazon Textract to process a ﬁle in an S3 bucket, the user must have permission to access the S3 bucket and ﬁle. Type: S3Object object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AdapterVersionDatasetConﬁg 563 Amazon Textract Developer Guide AdapterVersionEvaluationMetric Contains information on the metrics used to evalute the peformance of a given adapter version.
textract-dg-130	textract-dg.pdf	130	contains the document must match the Region that you use for Amazon Textract operations. For Amazon Textract to process a ﬁle in an S3 bucket, the user must have permission to access the S3 bucket and ﬁle. Type: S3Object object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AdapterVersionDatasetConﬁg 563 Amazon Textract Developer Guide AdapterVersionEvaluationMetric Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for baseline model performance and individual adapter version perfromance. Contents AdapterVersion The F1 score, precision, and recall metrics for the baseline model. Type: EvaluationMetric object Required: No Baseline The F1 score, precision, and recall metrics for the baseline model. Type: EvaluationMetric object Required: No FeatureType Indicates the feature type being analyzed by a given adapter version. Type: String Valid Values: TABLES \| FORMS \| QUERIES \| SIGNATURES \| LAYOUT Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AdapterVersionEvaluationMetric 564 Amazon Textract Developer Guide AdapterVersionOverview Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status. Contents AdapterId A unique identiﬁer for the adapter associated with a given adapter version. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: No AdapterVersion An identiﬁed for a given adapter version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No CreationTime The date and time that a given adapter version was created. Type: Timestamp Required: No FeatureTypes The feature types that the adapter version is operating on. Type: Array of strings Valid Values: TABLES \| FORMS \| QUERIES \| SIGNATURES \| LAYOUT Required: No AdapterVersionOverview 565 Amazon Textract Status Developer Guide Contains information on the status of a given adapter version. Type: String Valid Values: ACTIVE \| AT_RISK \| DEPRECATED \| CREATION_ERROR \| CREATION_IN_PROGRESS Required: No StatusMessage A message explaining the status of a given adapter vesion. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\*\+\,\-\./:;=\?@\[\\\]\^_`\{\\|\}~><]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AdapterVersionOverview 566 Amazon Textract AnalyzeIDDetections Developer Guide Used to contain the information detected by an AnalyzeID operation. Contents Text Text of either the normalized ﬁeld or value associated with it. Type: String Required: Yes Conﬁdence The conﬁdence score of the detected text. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No NormalizedValue Only returned for dates, returns the type of value detected and the date written in a more machine readable way. Type: NormalizedValue object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AnalyzeIDDetections 567 Amazon Textract Block Developer Guide A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the ﬁelds, tables, and selection elements that are detected in the document. An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses. For more information, see How Amazon Textract Works. Contents BlockType The type of text item that's recognized. In operations for text detection, the following types are returned: • PAGE - Contains a list of the LINE Block objects that are detected on a document page. • WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. • LINE - A string of tab-delimited, contiguous words that are detected on a document page. In text analysis operations, the following types are returned: • PAGE - Contains a list of child Block objects that are detected on a document page. • KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the
textract-dg-131	textract-dg.pdf	131	the LINE Block objects that are detected on a document page. • WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. • LINE - A string of tab-delimited, contiguous words that are detected on a document page. In text analysis operations, the following types are returned: • PAGE - Contains a list of child Block objects that are detected on a document page. • KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType ﬁeld to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object. • WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. • LINE - A string of tab-delimited, contiguous words that are detected on a document page. • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each. Block 568 Amazon Textract Developer Guide • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the ﬁrst row of a table. • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table. • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell. • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells. • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element. • SIGNATURE - The location and conﬁdence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell. • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer. • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and conﬁdence score. The following BlockTypes are only returned for Amazon Textract Layout. • LAYOUT_TITLE - The main title of the document. • LAYOUT_HEADER - Text located in the top margin of the document. • LAYOUT_FOOTER - Text located in the bottom margin of the document. • LAYOUT_SECTION_HEADER - The titles of sections within a document. • LAYOUT_PAGE_NUMBER - The page number of the documents. • LAYOUT_LIST - Any information grouped together in list form. • LAYOUT_FIGURE - Indicates the location of an image in a document. • LAYOUT_TABLE - Indicates the location of a table in the document. • LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document. • LAYOUT_TEXT - Text that is present typically as a part of paragraphs in documents. Type: String Block 569 Amazon Textract Developer Guide Valid Values: KEY_VALUE_SET \| PAGE \| LINE \| WORD \| TABLE \| CELL \| SELECTION_ELEMENT \| MERGED_CELL \| TITLE \| QUERY \| QUERY_RESULT \| SIGNATURE \| TABLE_TITLE \| TABLE_FOOTER \| LAYOUT_TEXT \| LAYOUT_TITLE \| LAYOUT_HEADER \| LAYOUT_FOOTER \| LAYOUT_SECTION_HEADER \| LAYOUT_PAGE_NUMBER \| LAYOUT_LIST \| LAYOUT_FIGURE \| LAYOUT_TABLE \| LAYOUT_KEY_VALUE Required: No ColumnIndex The column in which a table cell appears. The ﬁrst column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. Type: Integer Valid Range: Minimum value of 0. Required: No ColumnSpan The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection. Type: Integer Valid Range: Minimum value of 0. Required: No Conﬁdence The conﬁdence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No EntityTypes The type of entity. Block 570 Amazon Textract Developer Guide The following entity types can be returned by FORMS analysis: • KEY - An identiﬁer for a ﬁeld on the document. • VALUE - The ﬁeld text. The following entity types can be returned by TABLES analysis: • COLUMN_HEADER - Identiﬁes a cell that is a header of a column. • TABLE_TITLE - Identiﬁes a cell that is a title within the table. • TABLE_SECTION_TITLE - Identiﬁes a cell that is a
textract-dg-132	textract-dg.pdf	132	the recognized text. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No EntityTypes The type of entity. Block 570 Amazon Textract Developer Guide The following entity types can be returned by FORMS analysis: • KEY - An identiﬁer for a ﬁeld on the document. • VALUE - The ﬁeld text. The following entity types can be returned by TABLES analysis: • COLUMN_HEADER - Identiﬁes a cell that is a header of a column. • TABLE_TITLE - Identiﬁes a cell that is a title within the table. • TABLE_SECTION_TITLE - Identiﬁes a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section. • TABLE_FOOTER - Identiﬁes a cell that is a footer of a table. • TABLE_SUMMARY - Identiﬁes a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table. • STRUCTURED_TABLE - Identiﬁes a table with column headers where the content of each row corresponds to the headers. • SEMI_STRUCTURED_TABLE - Identiﬁes a non-structured table. EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection. Type: Array of strings Valid Values: KEY \| VALUE \| COLUMN_HEADER \| TABLE_TITLE \| TABLE_FOOTER \| TABLE_SECTION_TITLE \| TABLE_SUMMARY \| STRUCTURED_TABLE \| SEMI_STRUCTURED_TABLE Required: No Geometry The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a ﬁner-grain polygon for more accurate spatial information. Type: Geometry object Required: No Id The identiﬁer for the recognized text. The identiﬁer is only unique for a single operation. Type: String Block 571 Amazon Textract Pattern: .\S. Required: No Page Developer Guide The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1. Type: Integer Valid Range: Minimum value of 0. Required: No Query Type: Query object Required: No Relationships A list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. Type: Array of Relationship objects Required: No RowIndex The row in which a table cell is located. The ﬁrst row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. Type: Integer Valid Range: Minimum value of 0. Required: No Block 572 Amazon Textract RowSpan Developer Guide The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection. Type: Integer Valid Range: Minimum value of 0. Required: No SelectionStatus The selection status of a selection element, such as an option button or check box. Type: String Valid Values: SELECTED \| NOT_SELECTED Required: No Text The word or line of text that's recognized by Amazon Textract. Type: String Required: No TextType The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text. Type: String Valid Values: HANDWRITING \| PRINTED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Block 573 Amazon Textract • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide Block 574 Amazon Textract BoundingBox Developer Guide The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). The top and left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200). The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. Contents Height The height of the bounding box as a ratio of the overall document page height. Type: Float Required: No Left The left coordinate of the
textract-dg-133	textract-dg.pdf	133	top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200). The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. Contents Height The height of the bounding box as a ratio of the overall document page height. Type: Float Required: No Left The left coordinate of the bounding box as a ratio of overall document page width. Type: Float Required: No Top The top coordinate of the bounding box as a ratio of overall document page height. Type: Float Required: No Width The width of the bounding box as a ratio of the overall document page width. BoundingBox 575 Amazon Textract Type: Float Required: No See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BoundingBox 576 Amazon Textract DetectedSignature Developer Guide A structure that holds information regarding a detected signature on a page. Contents Page The page a detected signature was found on. Type: Integer Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DetectedSignature 577 Amazon Textract Document Developer Guide The input document, either as bytes or as an S3 object. You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local ﬁle system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document ﬁle bytes if you're using an AWS SDK to call Amazon Textract API operations. You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded. The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations. If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must ﬁrst upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property. For Amazon Textract to process an S3 object, the user must have permission to access the S3 object. Contents Bytes A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format. If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes ﬁeld. Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 10485760. Required: No S3Object Identiﬁes an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB. Document 578 Amazon Textract Type: S3Object object Required: No See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Document 579 Amazon Textract DocumentGroup Developer Guide Summary information about documents grouped by the same document type. Contents DetectedSignatures A list of the detected signatures found in a document group. Type: Array of DetectedSignature objects Required: No SplitDocuments An array that contains information about the pages of a document, deﬁned by logical boundary. Type: Array of SplitDocument objects Required: No Type The type of document that Amazon Textract has detected. See Analyze Lending Response Objects for a list of all types returned by Textract. Type: String Pattern: .\S. Required: No UndetectedSignatures A list of any expected signatures not found in a document group. Type: Array of UndetectedSignature objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: DocumentGroup 580 Amazon Textract • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide DocumentGroup 581 Amazon Textract DocumentLocation Developer Guide The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations. The input document can be an image ﬁle in JPEG or
textract-dg-134	textract-dg.pdf	134	Pattern: .\S. Required: No UndetectedSignatures A list of any expected signatures not found in a document group. Type: Array of UndetectedSignature objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: DocumentGroup 580 Amazon Textract • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide DocumentGroup 581 Amazon Textract DocumentLocation Developer Guide The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations. The input document can be an image ﬁle in JPEG or PNG format. It can also be a ﬁle in PDF format. Contents S3Object The Amazon S3 bucket that contains the input document. Type: S3Object object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DocumentLocation 582 Developer Guide Amazon Textract DocumentMetadata Information about the input document. Contents Pages The number of pages that are detected in the document. Type: Integer Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DocumentMetadata 583 Amazon Textract EvaluationMetric Developer Guide The evaluation metrics (F1 score, Precision, and Recall) for an adapter version. Contents F1Score The F1 score for an adapter version. Type: Float Required: No Precision The Precision score for an adapter version. Type: Float Required: No Recall The Recall score for an adapter version. Type: Float Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EvaluationMetric 584 Developer Guide Amazon Textract ExpenseCurrency Returns the kind of currency detected. Contents Code Currency code for detected currency. the current supported codes are: • USD • EUR • GBP • CAD • INR • JPY • CHF • AUD • CNY • BZR • SEK • HKD Type: String Required: No Conﬁdence Percentage conﬁdeence in the detected currency. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No ExpenseCurrency 585 Amazon Textract See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExpenseCurrency 586 Amazon Textract ExpenseDetection Developer Guide An object used to store information about the Value or Label detected by Amazon Textract. Contents Conﬁdence The conﬁdence in detection, as a percentage Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No Geometry Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Type: Geometry object Required: No Text The word or line of text recognized by Amazon Textract Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExpenseDetection 587 Amazon Textract ExpenseDocument Developer Guide The structure holding all the information returned by AnalyzeExpense Contents Blocks This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text. Type: Array of Block objects Required: No ExpenseIndex Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on. Type: Integer Valid Range: Minimum value of 0. Required: No LineItemGroups Information detected on each table of a document, seperated into LineItems. Type: Array of LineItemGroup objects Required: No SummaryFields Any information found outside of a table by Amazon Textract. Type: Array of ExpenseField objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: ExpenseDocument 588 Amazon Textract • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide ExpenseDocument 589 Amazon Textract ExpenseField Developer Guide Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection Contents Currency Shows the kind of currency, both the code and conﬁdence associated with any monatary value detected. Type: ExpenseCurrency object Required: No GroupProperties Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address. Type: Array of ExpenseGroupProperty objects Required:
textract-dg-135	textract-dg.pdf	135	AWS SDKs, see the following: ExpenseDocument 588 Amazon Textract • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide ExpenseDocument 589 Amazon Textract ExpenseField Developer Guide Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection Contents Currency Shows the kind of currency, both the code and conﬁdence associated with any monatary value detected. Type: ExpenseCurrency object Required: No GroupProperties Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address. Type: Array of ExpenseGroupProperty objects Required: No LabelDetection The explicitly stated label of a detected element. Type: ExpenseDetection object Required: No PageNumber The page number the value was detected on. Type: Integer Valid Range: Minimum value of 0. Required: No Type The implied label of a detected element. Present alongside LabelDetection for explicit elements. ExpenseField 590 Amazon Textract Type: ExpenseType object Required: No ValueDetection Developer Guide The value of a detected element. Present in explicit and implicit elements. Type: ExpenseDetection object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExpenseField 591 Amazon Textract Developer Guide ExpenseGroupProperty Shows the group that a certain key belongs to. This helps diﬀerentiate between names and addresses for diﬀerent organizations, that can be hard to determine via JSON response. Contents Id Provides a group Id number, which will be the same for each in the group. Type: String Required: No Types Informs you on whether the expense group is a name or an address. Type: Array of strings Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExpenseGroupProperty 592 Amazon Textract ExpenseType Developer Guide An object used to store information about the Type detected by Amazon Textract. Contents Conﬁdence The conﬁdence of accuracy, as a percentage. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No Text The word or line of text detected by Amazon Textract. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExpenseType 593 Amazon Textract Extraction Developer Guide Contains information extracted by an analysis operation after using StartLendingAnalysis. Contents ExpenseDocument The structure holding all the information returned by AnalyzeExpense Type: ExpenseDocument object Required: No IdentityDocument The structure that lists each document processed in an AnalyzeID operation. Type: IdentityDocument object Required: No LendingDocument Holds the structured data returned by AnalyzeDocument for lending documents. Type: LendingDocument object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Extraction 594 Amazon Textract Geometry Developer Guide Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Contents BoundingBox An axis-aligned coarse representation of the location of the recognized item on the document page. Type: BoundingBox object Required: No Polygon Within the bounding box, a ﬁne-grained polygon around the recognized item. Type: Array of Point objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Geometry 595 Amazon Textract Developer Guide HumanLoopActivationOutput Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review. Contents HumanLoopActivationConditionsEvaluationResults Shows the result of condition evaluations, including those conditions which activated a human review. Type: String Length Constraints: Maximum length of 10240. Required: No HumanLoopActivationReasons Shows if and why human review was needed. Type: Array of strings Array Members: Minimum number of 1 item. Required: No HumanLoopArn The Amazon Resource Name (ARN) of the HumanLoop created. Type: String Length Constraints: Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ HumanLoopActivationOutput 596 Amazon Textract • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide HumanLoopActivationOutput 597 Amazon Textract HumanLoopConﬁg Developer Guide Sets up the human review workﬂow the document will be sent to if one of the conditions is met. You can also set certain attributes of
textract-dg-136	textract-dg.pdf	136	of 1 item. Required: No HumanLoopArn The Amazon Resource Name (ARN) of the HumanLoop created. Type: String Length Constraints: Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ HumanLoopActivationOutput 596 Amazon Textract • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide HumanLoopActivationOutput 597 Amazon Textract HumanLoopConﬁg Developer Guide Sets up the human review workﬂow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review. Contents FlowDeﬁnitionArn The Amazon Resource Name (ARN) of the ﬂow deﬁnition. Type: String Length Constraints: Maximum length of 256. Required: Yes HumanLoopName The name of the human workﬂow used for this image. This should be kept unique within a region. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9](-[a-z0-9]) Required: Yes DataAttributes Sets attributes of the input data. Type: HumanLoopDataAttributes object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ HumanLoopConﬁg 598 Amazon Textract • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide HumanLoopConﬁg 599 Amazon Textract Developer Guide HumanLoopDataAttributes Allows you to set attributes of the image. Currently, you can declare an image as free of personally identiﬁable information and adult content. Contents ContentClassiﬁers Sets whether the input image is free of personally identiﬁable information or adult content. Type: Array of strings Array Members: Maximum number of 256 items. Valid Values: FreeOfPersonallyIdentifiableInformation \| FreeOfAdultContent Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HumanLoopDataAttributes 600 Amazon Textract IdentityDocument Developer Guide The structure that lists each document processed in an AnalyzeID operation. Contents Blocks Individual word recognition, as returned by document detection. Type: Array of Block objects Required: No DocumentIndex Denotes the placement of a document in the IdentityDocument list. The ﬁrst document is marked 1, the second 2 and so on. Type: Integer Valid Range: Minimum value of 0. Required: No IdentityDocumentFields The structure used to record information extracted from identity documents. Contains both normalized ﬁeld and value of the extracted text. Type: Array of IdentityDocumentField objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IdentityDocument 601 Amazon Textract Developer Guide IdentityDocument 602 Amazon Textract Developer Guide IdentityDocumentField Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively. Contents Type Used to contain the information detected by an AnalyzeID operation. Type: AnalyzeIDDetections object Required: No ValueDetection Used to contain the information detected by an AnalyzeID operation. Type: AnalyzeIDDetections object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IdentityDocumentField 603 Amazon Textract LendingDetection The results extracted for a lending document. Contents Conﬁdence Developer Guide The conﬁdence level for the text of a detected value in a lending document. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No Geometry Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Type: Geometry object Required: No SelectionStatus The selection status of a selection element, such as an option button or check box. Type: String Valid Values: SELECTED \| NOT_SELECTED Required: No Text The text extracted for a detected value in a lending document. Type: String Required: No LendingDetection 604 Amazon Textract See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LendingDetection 605 Amazon Textract LendingDocument Developer Guide Holds the structured data returned by AnalyzeDocument for lending documents. Contents LendingFields An array of LendingField objects. Type: Array of LendingField objects Required: No SignatureDetections A list of signatures detected in a lending document. Type: Array of SignatureDetection objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LendingDocument 606 Amazon Textract LendingField Developer Guide Holds
textract-dg-137	textract-dg.pdf	137	Java V2 • AWS SDK for Ruby V3 LendingDetection 605 Amazon Textract LendingDocument Developer Guide Holds the structured data returned by AnalyzeDocument for lending documents. Contents LendingFields An array of LendingField objects. Type: Array of LendingField objects Required: No SignatureDetections A list of signatures detected in a lending document. Type: Array of SignatureDetection objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LendingDocument 606 Amazon Textract LendingField Developer Guide Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry. Contents KeyDetection The results extracted for a lending document. Type: LendingDetection object Required: No Type The type of the lending document. Type: String Required: No ValueDetections An array of LendingDetection objects. Type: Array of LendingDetection objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LendingField 607 Amazon Textract LendingResult Developer Guide Contains the detections for each page analyzed through the Analyze Lending API. Contents Extractions An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections . Type: Array of Extraction objects Required: No Page The page number for a page, with regard to whole submission. Type: Integer Valid Range: Minimum value of 0. Required: No PageClassiﬁcation The classiﬁer result for a given page. Type: PageClassiﬁcation object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LendingResult 608 Amazon Textract LendingSummary Developer Guide Contains information regarding DocumentGroups and UndetectedDocumentTypes. Contents DocumentGroups Contains an array of all DocumentGroup objects. Type: Array of DocumentGroup objects Required: No UndetectedDocumentTypes UndetectedDocumentTypes. Type: Array of strings Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LendingSummary 609 Amazon Textract LineItemFields Developer Guide A structure that holds information about the diﬀerent lines found in a document's tables. Contents LineItemExpenseFields ExpenseFields used to show information from detected lines on a table. Type: Array of ExpenseField objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LineItemFields 610 Amazon Textract LineItemGroup Developer Guide A grouping of tables which contain LineItems, with each table identiﬁed by the table's LineItemGroupIndex. Contents LineItemGroupIndex The number used to identify a speciﬁc table in a document. The ﬁrst table encountered will have a LineItemGroupIndex of 1, the second 2, etc. Type: Integer Valid Range: Minimum value of 0. Required: No LineItems The breakdown of information on a particular line of a table. Type: Array of LineItemFields objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LineItemGroup 611 Amazon Textract NormalizedValue Developer Guide Contains information relating to dates in a document, including the type of value, and the value. Contents Value The value of the date, written as Year-Month-DayTHour:Minute:Second. Type: String Required: No ValueType The normalized type of the value detected. In this case, DATE. Type: String Valid Values: DATE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NormalizedValue 612 Amazon Textract NotiﬁcationChannel Developer Guide The Amazon Simple Notiﬁcation Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation. Contents RoleArn The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Required: Yes SNSTopicArn The Amazon SNS topic that Amazon Textract posts the completion status to. Type: String Length Constraints: Minimum length of 20. Maximum length of 1024. Pattern: (^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$) Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NotiﬁcationChannel 613 Amazon Textract
textract-dg-138	textract-dg.pdf	138	of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Required: Yes SNSTopicArn The Amazon SNS topic that Amazon Textract posts the completion status to. Type: String Length Constraints: Minimum length of 20. Maximum length of 1024. Pattern: (^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$) Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NotiﬁcationChannel 613 Amazon Textract OutputConﬁg Developer Guide Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the preﬁx on the output ﬁle. OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the ﬁle preﬁx of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3. Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy. For more information on data privacy, see the Data Privacy FAQ. Contents S3Bucket The name of the bucket your output will go to. Type: String Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [0-9A-Za-z\.\-_]* Required: Yes S3Preﬁx The preﬁx of the object key that the output will be saved to. When not enabled, the preﬁx will be “textract_output". Type: String OutputConﬁg 614 Amazon Textract Developer Guide Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OutputConﬁg 615 Amazon Textract PageClassiﬁcation Developer Guide The class assigned to a Page object detected in an input document. Contains information regarding the predicted type/class of a document's page and the page number that the Page object was detected on. Contents PageNumber The page number the value was detected on, relative to Amazon Textract's starting position. Type: Array of Prediction objects Required: Yes PageType The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object. Type: Array of Prediction objects Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PageClassiﬁcation 616 Amazon Textract Point Developer Guide The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page. An array of Point objects, Polygon, is returned as part of the Geometry object that's returned in a Block object. A Polygon object represents a ﬁne-grained polygon around detected text, a key- value pair, a table, a table cell, or a selection element. Contents X Y The value of the X coordinate for a point on a Polygon. Type: Float Required: No The value of the Y coordinate for a point on a Polygon. Type: Float Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Point 617 Amazon Textract Prediction Developer Guide Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the conﬁdence in the predicted value. Contents Conﬁdence Amazon Textract's conﬁdence in its predicted value. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No Value The predicted value of a detected object. Type: String Pattern: .\S. Required: No See Also For more information about using this API
textract-dg-139	textract-dg.pdf	139	one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Point 617 Amazon Textract Prediction Developer Guide Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the conﬁdence in the predicted value. Contents Conﬁdence Amazon Textract's conﬁdence in its predicted value. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No Value The predicted value of a detected object. Type: String Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Prediction 618 Developer Guide Amazon Textract QueriesConﬁg Contents Queries Type: Array of Query objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 QueriesConﬁg 619 Amazon Textract Query Developer Guide Each query contains the question you want to ask in the Text and the alias you want to associate. Contents Text Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?" Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\\+\,\-\./:;=\?@\[\\\]\^_`\{\\|\}~><]+$ Required: Yes Alias Alias attached to the query, for ease of location. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\\+\,\-\./:;=\?@\[\\\]\^_`\{\\|\}~><]+$ Required: No Pages Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter. • If a page is not speciﬁed, it is set to ["1"] by default. • The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - . No whitespace is allowed. • When using to indicate all pages, it must be the only element in the list. • You can use page intervals, such as [“1-3”, “1-1”, “4-”]. Where indicates last page of document. Query 620 Amazon Textract Developer Guide • Speciﬁed pages must be greater than 0 and less than or equal to the number of pages in the document. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 9. Pattern: ^[0-9\\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Query 621 Amazon Textract Relationship Developer Guide Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships. For more information, see Block. The Type element provides the type of the relationship for all blocks in the IDs array. Contents Ids An array of IDs for related blocks. You can get the type of the relationship from the Type element. Type: Array of strings Pattern: .\S.* Required: No Type The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned. • VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key- value pair. • CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type. • MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table. • ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block. • TABLE - A list of IDs that identify associated TABLE block types. • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table. • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table. Type: String Valid Values: VALUE \| CHILD \| COMPLEX_FEATURES \| MERGED_CELL \| TITLE \| ANSWER \| TABLE \| TABLE_TITLE \| TABLE_FOOTER Relationship 622 Amazon Textract Required: No See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Relationship 623 Amazon Textract S3Object Developer Guide The S3 bucket name and ﬁle name that identiﬁes the document. The AWS Region for the S3 bucket that contains
textract-dg-140	textract-dg.pdf	140	identify the TABLE_FOOTER block types in a table. Type: String Valid Values: VALUE \| CHILD \| COMPLEX_FEATURES \| MERGED_CELL \| TITLE \| ANSWER \| TABLE \| TABLE_TITLE \| TABLE_FOOTER Relationship 622 Amazon Textract Required: No See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Relationship 623 Amazon Textract S3Object Developer Guide The S3 bucket name and ﬁle name that identiﬁes the document. The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations. For Amazon Textract to process a ﬁle in an S3 bucket, the user must have permission to access the S3 bucket and ﬁle. Contents Bucket The name of the S3 bucket. Note that the # character is not valid in the ﬁle name. Type: String Length Constraints: Minimum length of 3. Maximum length of 255. Pattern: [0-9A-Za-z\.\-_]* Required: No Name The ﬁle name of the input document. Image ﬁles may be in PDF, TIFF, JPEG, or PNG format. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .\S. Required: No Version If the bucket has versioning enabled, you can specify the object version. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: .\S. S3Object 624 Amazon Textract Required: No See Also Developer Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3Object 625 Amazon Textract SignatureDetection Information regarding a detected signature on a page. Contents Conﬁdence Developer Guide The conﬁdence, from 0 to 100, in the predicted values for a detected signature. Type: Float Valid Range: Minimum value of 0. Maximum value of 100. Required: No Geometry Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements. Type: Geometry object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SignatureDetection 626 Amazon Textract SplitDocument Developer Guide Contains information about the pages of a document, deﬁned by logical boundary. Contents Index The index for a given document in a DocumentGroup of a speciﬁc Type. Type: Integer Valid Range: Minimum value of 0. Required: No Pages An array of page numbers for a for a given document, ordered by logical boundary. Type: Array of integers Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SplitDocument 627 Amazon Textract UndetectedSignature Developer Guide A structure containing information about an undetected signature on a page where it was expected but not found. Contents Page The page where a signature was expected but not found. Type: Integer Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UndetectedSignature 628 Amazon Textract Warning Developer Guide A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection). Contents ErrorCode The error code for the warning. Type: String Required: No Pages A list of the pages that the warning applies to. Type: Array of integers Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Warning 629 Amazon Textract Developer Guide Quotas in Amazon Textract The following sections provide information about quotas, formerly referred to as limits, when using Amazon Textract. There are two kinds of quotas. Set quotas, which can be viewed in the section Set Quotas in Amazon Textract, cannot be changed. Default quotas, discussed in the section Default Quotas, can be viewed or changed via the Service quotas console. You can also view the current Amazon Textract default quotas on the Amazon Textract endpoints and service quotas. Set Quotas in Amazon Textract The following is a list of set quotas in Amazon Textract, which cannot be changed. For information about limitations in default quotas you can change, see the section Default Quotas in Amazon Textract. Limit Description
textract-dg-141	textract-dg.pdf	141	Textract. There are two kinds of quotas. Set quotas, which can be viewed in the section Set Quotas in Amazon Textract, cannot be changed. Default quotas, discussed in the section Default Quotas, can be viewed or changed via the Service quotas console. You can also view the current Amazon Textract default quotas on the Amazon Textract endpoints and service quotas. Set Quotas in Amazon Textract The following is a list of set quotas in Amazon Textract, which cannot be changed. For information about limitations in default quotas you can change, see the section Default Quotas in Amazon Textract. Limit Description Accepted File Formats Operations support JPEG, PNG, PDF, and TIFF ﬁles. (JPEG 2000-encoded images within PDFs are supported). File Size and Page Count Limits For synchronous operations, JPEG, PNG, PDF, and TIFF ﬁles have a limit of 10 MB in memory. PDF and TIFF ﬁles also have PDF Speciﬁc Limits a limit of 1 page. For asynchronous operations, JPEG and PNG ﬁles have a limit of 10 MB in memory. PDF and TIFF ﬁles have a limit of 500 MB in memory and a limit of 3,000 pages. The maximum height and width is 40 inches and 2880 points. PDFs cannot be password protected. PDFs can contain JPEG 2000 formatted images. Document Rotation and Image Size Amazon Textract supports all in-plane document rotations, for example 45-degree in-plane rotation. Amazon Textract supports images with a resolution less than or equal to 10000 pixels on all sides. Set Quotas 630 Amazon Textract Limit Description Developer Guide Query Speciﬁc Limits Amazon Textract supports up to 15 queries per page for synchronous operations and up to 30 queries per page for asynchronous operations. Text Alignment Languages Character Size Character Type Text can be text aligned horizontally within the document. Horizontally arrayed text can be read regardless of the degree of rotation of a document. Amazon Textract does not support vertical text (text written vertically, as is common in languages like Japanese and Chinese) alignment within the document. Amazon Textract supports English, French, German, Italian, Portuguese, and Spanish text detection. Amazon Textract will not return the language detected in its output. Query detection is only available in English document detection. The minimum height for text to be detected is 15 pixels. At 150 DPI, this would be the same as 8 point font. Amazon Textract supports both handwritten and printed character recognition. Handwritten character recognition is only supported in English. Characters Amazon Textract detects the following characters: • a-z • A-Z • 0-9 • ä Ä ö Ö ü Ü ç Ç é É â Â ê Ê î Î ô Ô û Û à À è È ù Ù ë Ë ï Ï ü Ü á Á é É í Í ó Ó ú Ú ü Ü ñ Ñ ì Ì ò Ò ã Ã õ Õ • ! " # $ % ' & ( ) * + , - . / : ; = ? @ [ \ ] ^ _ ` { \| } ~ > < ° € £ ¥ ₹ ß ẞ ¿ ¡ € £ ¥ ₹ ø Ø œ Œ © ® ™ § ¹ ² ³ ' AnalyzeID Speciﬁc Limits AnalyzeID only supports US passports, and US driver's licenses. Set Quotas 631 Amazon Textract Limit Description Developer Guide Adapter Speciﬁc Limits • Accepted dataset conﬁguration for adapter training - Training: 5-2500, Test: 5-1000, • Training/testing ﬁle format and size: JPG, PNG, PDF, TIFF. • Maximum size of training/testing ﬁle is 10MB. • Maximum size of annotation/pre-labeling ﬁle is 25MB. • Maximum length of pre-labeling ﬁle array is 15. • Max query response length - 128 characters • Max number of queries per page - 30 Modifying Default Quotas in Amazon Textract Your console account has default quotas for Amazon Textract operations. These are a set of Region-speciﬁc quotas that you can modify. Default quotas can be viewed or changed via the Service Quotas console. You can also view the current Amazon Textract default quotas on the Amazon Textract endpoints and service quotas. Types of Quotas There are two types of quotas for Amazon Textract. • Transactions Per Second (TPS) (Synchronous and Asynchronous) • Concurrent Jobs (Asynchronous Only) • Adapters TPS TPS quotas determine how often you can request that Textract process a new document. TPS quotas are unique to API, Synchronous or Asynchronous operations, and Region. Synchronous TPS Synchronous operations are used for processing single-page documents and receiving near real- time responses for Textract include AnalyzeDocument, DetectDocumentText, AnalyzeExpense, and AnalyzeID. For more information, see Processing Documents Synchronously. Modifying Default Quotas 632 Amazon Textract Developer Guide For the following Synchronous APIs, Maximum Transactions Per Second (TPS) describes the maximum number of transactions (API calls) you can perform with your account in a given region: • AnalyzeDocument •
textract-dg-142	textract-dg.pdf	142	Only) • Adapters TPS TPS quotas determine how often you can request that Textract process a new document. TPS quotas are unique to API, Synchronous or Asynchronous operations, and Region. Synchronous TPS Synchronous operations are used for processing single-page documents and receiving near real- time responses for Textract include AnalyzeDocument, DetectDocumentText, AnalyzeExpense, and AnalyzeID. For more information, see Processing Documents Synchronously. Modifying Default Quotas 632 Amazon Textract Developer Guide For the following Synchronous APIs, Maximum Transactions Per Second (TPS) describes the maximum number of transactions (API calls) you can perform with your account in a given region: • AnalyzeDocument • DetectDocumentText • AnalyzeExpense • AnalyzeID Asynchronous TPS Amazon Textract provides non-real time, asynchronous operations for the processing of larger, multipage documents. There are two types of asynchronous processing operations: Start operations and Get operations. Start operations are used to request that Textract process a document, while Get operations are used to obtain the status and results of document processing. Quotas for both Start and Get operations are measured in TPS. For more information about asynchronous processing, see Processing Documents Asynchronously. For the following, Start and Get APIs, Maximum Transactions Per Second (TPS) describes the maximum number of transactions (API calls) you can perform with your account in a given region: Start • StartDocumentAnalysis • StartDocumentTextDetection • StartExpenseAnalysis Get • GetDocumentAnalysis • GetDocumentTextDetection • GetExpenseAnalysis Concurrent Jobs Concurrent job limit deﬁnes how many jobs can be run in parallel at a given time. The Concurrent Job limits apply only to asynchronous operations, and is unique to individual operations. Types of Quotas 633 Amazon Textract Developer Guide The following APIs have quotas deﬁning the Maximum Number of Concurrent Jobs that your account can create in a given region: • AnalyzeDocument • DetectDocumentText • DetectDocumentExpense Adapters The Adapter Quotas deﬁne the following limits for adapter training. Use the Service Quotas console to raise a service quota increase request. • Maximum number of adapters - Total number of adapters allowed. You can have a several adapter versions under a single adapter • Maximum AdapterVersions created per month - Number of successful adapter versions that can be created per AWS account per month. This will be reset at the start of every month. • Maximum in-progress AdapterVersions (analogous to adapter training) per account. Calculate quota increase Amazon Textract has a product speciﬁc Service Quotas Calculator to estimate your quota needs. You can use the Textract Service Quotas Calculator to estimate the quota values that will satisfy your use case. It is accessible from the Amazon Textract console. This section will outline the process of calculating a quota to suit your needs with the Quotas Calculator. To use the Textract Service Quotas Calculator 1. Selecting Regions Select your account's region The service calculator can estimate quotas in any region, and diﬀerent regions have diﬀerent default quotas. As such, make sure you match your account's region to the region you're Calculate quota increase 634 Amazon Textract Developer Guide calculating for. If you want to calculate a quota for a diﬀerent region, change your account's region in the console ﬁrst. 2. Processing type Select Synchronous or Asynchronous. Synchronous and Asynchronous operations have diﬀerent limits in Amazon Textract. Determine which type of operation that you intend to use the most, and select that operation type for calculations. Generally, synchronous operations are used for single page document processing, where asynchronous processing covers multipage documents. For example, if your use case is processing single page customer receipts, you'll select Synchronous 3. Use case type Select the operation best suited for your use case. Diﬀerent operations extract diﬀerent kinds of data, so select the operation most suited to your use case. For more information on the data extracted by diﬀerent operations, see Identifying Your Amazon Textract Use Case. For example, if your use case is primarily related to processing receipts, you'll select Expense Analysis from the list of operations. 4. Usage values Calculate quota increase 635 Amazon Textract Developer Guide Specify your usage values. When determining requirements, keep in mind whether your type of operation. For Synchronous operations, specify the maximum number of pages you want to process in a given timeframe, either hours or days. Note For asynchronous operations you also can enter the expected number of hours processing will require, and the average number of pages in the processed documents. For example, if you process an average of a million receipts a day, you'll enter 1,000,000 into the Documents to be processed tab to estimate the quota value needed. 5. Review results Calculate quota increase 636 Amazon Textract Developer Guide Check step 3 of the calculator page and review the calculator's output. The calculator pulls your current quotas information and compares them to the quotas required for your use case. This will tell you if your current quotas are too
textract-dg-143	textract-dg.pdf	143	can enter the expected number of hours processing will require, and the average number of pages in the processed documents. For example, if you process an average of a million receipts a day, you'll enter 1,000,000 into the Documents to be processed tab to estimate the quota value needed. 5. Review results Calculate quota increase 636 Amazon Textract Developer Guide Check step 3 of the calculator page and review the calculator's output. The calculator pulls your current quotas information and compares them to the quotas required for your use case. This will tell you if your current quotas are too low for your processing needs. If this is the case, you can click on the link provided by the calculator which will directly link you to a quota increase request for the operation you estimated for in the region you selected in Service quotas. Note If you are calculating for asynchronous, you will see multiple quotas estimated. You will need to click the link for each quota to request an increase for each one, if an increase is required. Following with our example throughout these steps, you would require a TPS of 12 to process all one million receipts in a day. As such, you'll need to request an increase from the default TPS of 5. Best Practices for Service Quota Increase Requests When requesting an increase to a default quota, there are several recommended best practices to follow. These include smooth spiky traﬃc, conﬁguring retries, and conﬁguring exponential backoﬀ and jitters. • Estimate your optimal quota values using the Textract Service Quota Calculator. Best Practices for Service Quota Increase Requests 637 Amazon Textract Developer Guide • Smoothening spiky traﬃc. Spiky traﬃc aﬀects throughput. To get maximum throughput for the allotted transactions per second (TPS), use a queueing serverless architecture or another mechanism to “smooth” traﬃc so it is more consistent. • Conﬁgure retries. Follow the guidelines at Error handling to conﬁgure retries for the errors that allow them • Conﬁgure exponential backoﬀ and jitter. By conﬁguring exponential backoﬀ and jitter for retries, you can improve throughput. See Error retries and exponential backoﬀ in AWS. • Start with samples that apply best practices, like the IDP CDK Samples using CDK Constructs. Change Default Quota As an alternative to raising a request directly from the calculator, you can also use the Service quotas console. This can be done from the Service quotas console, and may be processed automatically. Under some circumstances, such as a particularly large increase, the request will be processed manually and additional information may be required. To raise a service quota increase request 1. Log in to Management Console and navigate to the Service quotas console and select “Textract” under services 2. 3. Select the desired quota and click “Request Quota Increase” on the subsequent page Enter in the desired quota value and click “Request”. If you used the Service Quotas Calculator, you can copy the quota value from your calculations into the request. 4. After requesting a quota increase, refresh the page to see the quota status update. Note Some increases in quota values may need manual review. Quota Modiﬁcation Eﬀects The following table lists the diﬀerent types of quotas and the eﬀects modifying them will have. Change Default Quota 638 Amazon Textract Developer Guide Quota Value to Increase Eﬀect of Increase Synchronous operation TPS Increases how often you can request that Textract process a new document using a given synchronous operation, measured in transactions per second Asynchronous Start operation TPS Increases how often you can request that Textract begin the asynchronous processing of an input document, measured in transactions per second Asynchronous Get operation TPS Increases how often you can request that Textract return the results of a given asynchronous analysis job, measured in transactions per second Asynchronous Concurrent jobs Increases the total number of documents that you can have processing in parallel. Quota Modiﬁcation Eﬀects 639 Amazon Textract Developer Guide Document History for Amazon Textract The following table describes important changes in each release of the Amazon Textract Developer Guide. For notiﬁcation about updates to this documentation, you can subscribe to an RSS feed. • Latest documentation update: May 4th, 2022 Change Description Date Queries Support Added Confused Deputy Amazon Textract now supports the use of queries alongside the AnalyzeDo cument and GetDocume ntAnalysis operations. Have included pages detailing how to secure and prevent the Confused Deputy problem in Amazon Textract. April 21, 2022 March 29, 2022 Update for table detection and analysis Amazon Textract now supports merged cells and March 16, 2022 Integrating code examples from AWS Docs SDK Code Examples GitHub repo One Page PDF Support column headers for table responses. Amazon Textract guide now contains additional code examples. Renamed previous examples section to Tutorials. Amazon Textract now supports synchronous processing of single
textract-dg-144	textract-dg.pdf	144	Support Added Confused Deputy Amazon Textract now supports the use of queries alongside the AnalyzeDo cument and GetDocume ntAnalysis operations. Have included pages detailing how to secure and prevent the Confused Deputy problem in Amazon Textract. April 21, 2022 March 29, 2022 Update for table detection and analysis Amazon Textract now supports merged cells and March 16, 2022 Integrating code examples from AWS Docs SDK Code Examples GitHub repo One Page PDF Support column headers for table responses. Amazon Textract guide now contains additional code examples. Renamed previous examples section to Tutorials. Amazon Textract now supports synchronous processing of single page PDF documents and supports PDF documents containing JPEG 2000 encoded images. January 30, 2022 January 14, 2022 640 Amazon Textract Developer Guide Identity Document Support Amazon Textract now supports synchronous extraction of data from identity documents. December 1, 2021 AnalyzeExpense Async and TIFF Support Added Amazon Textract now supports the asynchronous October 26, 2021 Privatelink Support Added AnalyzeExpense Added Text Detection Improvements Form Extraction Update Table Extraction Update analysis of invoice and receipt documents, as well as the use of TIFF ﬁles. Amazon Textract now supports Amazon Virtual Private Cloud Endpoints via AWS PrivateLink. Amazon Textract now supports the synchrono us analysis of invoice and receipt documents using the AnalyzeExpense API. Amazon Textract now has accuracy enhancements for the handwriting extraction feature. Amazon Textract now has accuracy enhancements for the forms extraction feature. Amazon Textract now has accuracy enhancements for the detection of outer boundaries, row and column boundaries, and content of tables. October 4, 2021 July 27, 2021 July 8, 2021 June 23, 2021 April 8, 2021 641 Amazon Textract Augmented AI Support Developer Guide December 3, 2019 Amazon Textract now supports Amazon Augmented AI for implementing human review. New service and guide Amazon Textract is now available for general use. May 29, 2019 Support for selection elements Release of Amazon Textract Amazon Textract can now detect selection elements (radio buttons and check boxes). This is the ﬁrst release of the documentation for Amazon Textract. April 24, 2019 November 28, 2018 642
tgwnm-001	tgwnm.pdf	1	AWS Global Networks for Transit Gateways User Guide AWS Network Manager Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Network Manager AWS Global Networks for Transit Gateways User Guide AWS Network Manager: AWS Global Networks for Transit Gateways User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS Network Manager AWS Global Networks for Transit Gateways User Guide Table of Contents What is AWS Global Networks for Transit Gateways? ................................................................... 1 Global networks concepts .......................................................................................................................... 1 Home Region ............................................................................................................................................ 1 PrivateLink support ...................................................................................................................................... 2 IPv6 support .................................................................................................................................................. 3 Region availability ........................................................................................................................................ 3 How to get started with global networks for transit gateways .......................................................... 5 Pricing ............................................................................................................................................................. 5 How global networks work ............................................................................................................. 6 Register transit gateways ........................................................................................................................... 6 Multi-Region and multi-account network .......................................................................................... 7 Deﬁne and associate your on-premises network ................................................................................... 8 Supported resource types ........................................................................................................................... 9 Get started ..................................................................................................................................... 11 Prerequisites ................................................................................................................................................ 11 Step 1: Create a global network ............................................................................................................. 11 Step 2: Register your transit gateway ................................................................................................... 12 Step 3: (Optional) Deﬁne and associate your on-premises network resources .............................. 12 Step 4: (Optional) Enable multi-account access .................................................................................. 13 Step 5: View and monitor your global network .................................................................................. 14 Scenarios ........................................................................................................................................ 15 AWS-only multi-Region and multi-account global network ............................................................. 15 Single device with a single VPN connection ........................................................................................ 16 Device with multiple VPN connections ................................................................................................. 17 Multi-device and multi-link site .............................................................................................................. 19 SD-WAN connecting to AWS ................................................................................................................... 20 Connection between devices ................................................................................................................... 21 Modify a global network .............................................................................................................. 23 Multi-account .............................................................................................................................................. 24 Prerequisites ........................................................................................................................................... 24 Manage multiple accounts .................................................................................................................. 25 Enable trusted access ........................................................................................................................... 29 Disabled trusted access ....................................................................................................................... 30 Register a delegated administrator .................................................................................................. 31 iii AWS Network Manager AWS Global Networks for Transit Gateways User Guide Deregister a delegated administrator ............................................................................................... 32 Manage IAM role deployments .......................................................................................................... 32 Troubleshoot self-managed roles ...................................................................................................... 33 Global networks ......................................................................................................................................... 35 Create a global network ...................................................................................................................... 36 View a global network ......................................................................................................................... 37 Update a global network .................................................................................................................... 37 Delete a global network ...................................................................................................................... 38 Transit gateway registrations .................................................................................................................. 38 Transit gateway limitations ................................................................................................................ 38 Register a transit gateway .................................................................................................................. 39 View registered transit gateways ...................................................................................................... 40 Deregister a transit gateway .............................................................................................................. 40 Sites and links ............................................................................................................................................. 41 Sites ......................................................................................................................................................... 41 Links ......................................................................................................................................................... 41 Create a site ........................................................................................................................................... 41 View site details .................................................................................................................................... 42 Update a site ......................................................................................................................................... 43 Delete a site ........................................................................................................................................... 44 Add a link ............................................................................................................................................... 44 Edit a link ............................................................................................................................................... 45 Delete a link ........................................................................................................................................... 45 Devices .......................................................................................................................................................... 46 Add a device .......................................................................................................................................... 47 Delete a device ...................................................................................................................................... 48 Edit a device ........................................................................................................................................... 48 View device details ............................................................................................................................... 49 Connections ................................................................................................................................................. 55 Create a connection ............................................................................................................................. 55 Update a connection ............................................................................................................................ 56 Delete a connection ............................................................................................................................. 57 Gateway associations ................................................................................................................................. 57 Customer gateway associations ......................................................................................................... 57 Transit Gateway Connect peer associations .................................................................................... 58 Associate a customer gateway with a device .................................................................................. 58 iv AWS Network Manager AWS Global Networks for Transit Gateways User Guide Disassociate a customer gateway association from a device ....................................................... 59 Add a Connect peer association ........................................................................................................ 60 Disassociate a Connect peer from a device ..................................................................................... 62 Resource tags .............................................................................................................................................. 63 Supported resources ............................................................................................................................ 63 Tagging restrictions .............................................................................................................................. 63 Transit gateway network and transit gateway dashboards ........................................................ 65 Access transit gateway network dashboards ........................................................................................ 65 Overview ................................................................................................................................................. 66 Geography .............................................................................................................................................. 68 Topology tree ......................................................................................................................................... 72 Events ...................................................................................................................................................... 75 Monitoring .............................................................................................................................................. 76 Route analyzer ....................................................................................................................................... 77 Access transit gateway dashboards ........................................................................................................ 79 Overview ................................................................................................................................................. 79 Topology tree ......................................................................................................................................... 81 Events ...................................................................................................................................................... 83 Monitoring .............................................................................................................................................. 76 On-premises associations .................................................................................................................... 86 Connect peer associations .................................................................................................................. 86 Route Analyzer ............................................................................................................................... 88 Route Analyzer basics ............................................................................................................................... 88 Perform a route analysis .......................................................................................................................... 89 Example: Route analysis for peered transit gateways ........................................................................ 90 Example: Route analysis with a middlebox conﬁguration ................................................................. 91 Metrics and events ........................................................................................................................ 94 Monitor with CloudWatch metrics .......................................................................................................... 94 View CloudWatch metrics for on-premises resources ................................................................... 95 View global network CloudWatch metrics ...................................................................................... 96 Monitor with EventBridge ........................................................................................................................ 97 Get started ............................................................................................................................................. 98 Topology change events ................................................................................................................... 100 Routing update events ...................................................................................................................... 111 Status update events ......................................................................................................................... 114 Log API calls using CloudTrail ............................................................................................................... 118 v AWS Network Manager AWS Global Networks for Transit Gateways User Guide Global network information in CloudTrail .................................................................................... 119 Identity and access management ............................................................................................... 121 How Network Manager works with IAM ............................................................................................. 122 Actions .................................................................................................................................................. 122 Resources .............................................................................................................................................. 122 Condition keys ..................................................................................................................................... 122 Example policies ....................................................................................................................................... 123 Service-linked role ................................................................................................................................... 127 Permissions
tgwnm-002	tgwnm.pdf	2	.......................................................................................................... 94 View CloudWatch metrics for on-premises resources ................................................................... 95 View global network CloudWatch metrics ...................................................................................... 96 Monitor with EventBridge ........................................................................................................................ 97 Get started ............................................................................................................................................. 98 Topology change events ................................................................................................................... 100 Routing update events ...................................................................................................................... 111 Status update events ......................................................................................................................... 114 Log API calls using CloudTrail ............................................................................................................... 118 v AWS Network Manager AWS Global Networks for Transit Gateways User Guide Global network information in CloudTrail .................................................................................... 119 Identity and access management ............................................................................................... 121 How Network Manager works with IAM ............................................................................................. 122 Actions .................................................................................................................................................. 122 Resources .............................................................................................................................................. 122 Condition keys ..................................................................................................................................... 122 Example policies ....................................................................................................................................... 123 Service-linked role ................................................................................................................................... 127 Permissions granted by the service-linked role ........................................................................... 128 Create the service-linked role .......................................................................................................... 128 Edit the service-linked role .............................................................................................................. 128 Delete the service-linked role .......................................................................................................... 128 Supported Regions ............................................................................................................................. 129 AWS managed policies ........................................................................................................................... 129 NetworkAdministrator ....................................................................................................................... 129 AWSNetworkManagerReadOnlyAccess ........................................................................................... 130 AWSNetworkManagerServiceRolePolicy ........................................................................................ 130 Policy updates ..................................................................................................................................... 130 Multi-account access roles ..................................................................................................................... 132 CloudWatch-CrossAccountSharingRole .......................................................................................... 133 IAMRoleForAWSNetworkManagerCrossAccountResourceAccess ............................................... 133 Permission templates ....................................................................................................................... 135 ................................................................................................................................................................ 142 Quotas .......................................................................................................................................... 143 General quotas ......................................................................................................................................... 143 Document history ........................................................................................................................ 144 vi AWS Network Manager AWS Global Networks for Transit Gateways User Guide What is AWS Global Networks for Transit Gateways? AWS Global Networks for Transit Gateways enables you to create one or more global networks and then centrally manage those global networks across AWS accounts, Regions, and on-premises locations. Note If you want to create a core network within one of your global networks you'll use AWS Cloud WAN to create, manage, and monitor that core network. For more information on creating a global network with a core network, see the AWS Cloud WAN User Guide. Global networks concepts The following are the key concepts when using global networks to manage transit gateways. • Global network — A single, private network that acts as the high-level container for your network objects. A global network can contain both AWS Transit Gateways and, if you're using AWS Cloud WAN, other Cloud WAN core networks. You can see these through the AWS Network Manager console. • Device — Represents a physical or a virtual appliance in an on-premises network, data center, AWS Cloud, or other cloud providers. • Connection — Represents connectivity between two devices. The connection can be between a physical or virtual appliance and a third-party virtual appliance inside a VPC, or it can be between physical appliances in an on-premises network. • Link — Represents a single internet connection from a site. • Site — Represents a physical on-premises location. It could be a branch, oﬃce, store, campus, or a data center. Home Region The home Region is the AWS Region where data related to your use of your AWS Global Networks for Transit Gateways global network is aggregated and stored. Global networks aggregates and stores this information in the home Region to provide you with a central dashboard with visualized Global networks concepts 1 AWS Network Manager AWS Global Networks for Transit Gateways User Guide insights into your global network. Currently, global networks only supports US West (Oregon) as the home Region. Important • Global networks aggregates and stores regional usage data associated with the transit gateways speciﬁed from the AWS Regions you're using to the US West (Oregon) Region. • Global networks aggregates and stores regional usage data associated with the transit gateways from the AWS GovCloud (US) Regions to the AWS GovCloud (US-West) Region. • Once established, you can't change the home Region. We aggregate and store this regional usage data from the AWS Regions you are using to US West (Oregon) using Amazon Simple Queue Service (SQS) and Amazon Simple Storage Service (S3). This data includes but is not limited to: • Topology data for registered transit gateways • Event data for transit gateways and VPNs • Transit gateway IDs for registering transit gateways into a global network • (Optional) Location data related to your device and site registrations • (Optional) Provider and link data related to your link registrations • (Optional) IP address and CIDR ranges used in transit gateway Connect peers All movement and data aggregation occurs over a secure and encrypted channel and stored with encryption at rest. AWS Global Networks for Transit Gateways uses Amazon Location Service to create maps of your global network. For more information about Amazon Location Service, see Amazon Location Service. AWS PrivateLink support Network Manager supports AWS PrivateLink to create private connectivity between Network Manager and your VPCs. Using PrivateLink, you can establish secure and private connectivity without the need for using an internet gateway or any NAT devices to communicate with your VPCs. PrivateLink support 2 AWS Network Manager AWS Global Networks for Transit Gateways User Guide While there is no price charge for using Network Manager, there is a price charge for using PrivateLink. See for more information. Note •
tgwnm-003	tgwnm.pdf	3	to create maps of your global network. For more information about Amazon Location Service, see Amazon Location Service. AWS PrivateLink support Network Manager supports AWS PrivateLink to create private connectivity between Network Manager and your VPCs. Using PrivateLink, you can establish secure and private connectivity without the need for using an internet gateway or any NAT devices to communicate with your VPCs. PrivateLink support 2 AWS Network Manager AWS Global Networks for Transit Gateways User Guide While there is no price charge for using Network Manager, there is a price charge for using PrivateLink. See for more information. Note • PrivateLink only supports IPv6 dual-stack endpoints. • Support for PrivateLink through Network Manager is currently available only in the us- west-2 and us-gov-west-1 Regions. For more information on PrivateLink, see the AWS PrivateLink Guide. IPv6 support Network Manager supports Internet Protocol version 6 (IPv6) on dual-stack endpoints. Backwards compatibility is supported for IPv4 endpoints. For example, networkmanager.us- west-2.api.aws. Region availability AWS Global Networks for Transit Gateways is available in the following AWS Regions: AWS Region af-south-1 ap-east-1 ap-northeast-1 ap-northeast-2 ap-northeast-3 ap-south-1 ap-south-2 Description Africa (Cape Town) Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Tokyo) Asia Paciﬁc (Seoul) Asia Paciﬁc (Osaka) Asia Paciﬁc (Mumbai) Asia Paciﬁc (Hyderabad) ap-southeast-1 Asia Paciﬁc (Singapore) IPv6 support 3 AWS Network Manager AWS Global Networks for Transit Gateways User Guide AWS Region ap-southeast-2 ap-southeast-3 ap-southeast-4 ap-southeast-5 ca-central-1 ca-west-1 eu-central-1 eu-central-2 eu-north-1 eu-south-1 eu-south-2 eu-west-1 eu-west-2 eu-west-3 il-central-1 me-central-1 me-south-1 sa-east-1 us-east-1 us-east-2 Description Asia Paciﬁc (Sydney) Asia Paciﬁc (Jakarta) Asia Paciﬁc (Melbourne) Asia Paciﬁc (Malaysia) Canada (Central) Canada West (Calgary) Europe (Frankfurt) Europe (Zurich) Europe (Stockholm) Europe (Milan) Europe (Spain) Europe (Ireland) Europe (London) Europe (Paris) Israel (Tel Aviv) Middle East (UAE) Middle East (Bahrain) South America (São Paulo) US East (N. Virginia) US East (Ohio) Region availability 4 AWS Network Manager AWS Region us-west-1 us-west-2 us-gov-east-1 us-gov-west-1 AWS Global Networks for Transit Gateways User Guide Description US West (N. California) US West (Oregon) AWS GovCloud (US-East) AWS GovCloud (US-West) How to get started with global networks for transit gateways Use the following resources to help you use global networks: • How AWS Global Networks for Transit Gateways works • Get started • the section called “Access transit gateway network dashboards” Pricing There are no additional fees for using global networks to manage transit gateways networks. You are charged the standard fees for the network resources that you manage in your global network (such as transit gateways). For more information about pricing, see AWS Transit Gateway pricing. How to get started with global networks for transit gateways 5 AWS Network Manager AWS Global Networks for Transit Gateways User Guide How AWS Global Networks for Transit Gateways works To use global networks for transit gateways, you ﬁrst create a global network to represent your network. Initially, the global network is empty. You then register your existing transit gateways and deﬁne your on-premises resources in the global network. This enables you to visualize and monitor your AWS resources and your on-premises networks through the global networks dashboard on the AWS Network Manager console. After you create your global network, you can monitor your networks through this dashboard. You can view network activity and health using Amazon CloudWatch metrics and Amazon CloudWatch Events. The global networks dashboard can help you identify whether issues in your network are caused by AWS resources, your on-premises resources, or the connections between them. global networks does not create, modify, or delete your transit gateways and their attachments. To work with transit gateways, use the Amazon VPC console and the Amazon EC2 APIs. Contents • Register transit gateways • Deﬁne and associate your on-premises network • Supported resource types Register transit gateways You can register transit gateways that are in the same AWS account as your global network. When you register a transit gateway, the following transit gateway attachments are automatically included in your global network: • VPCs • Site-to-Site VPN connections • AWS Direct Connect gateways • Transit Gateway Connect • Transit gateway peering connections Register transit gateways 6 AWS Network Manager AWS Global Networks for Transit Gateways User Guide When you register a transit gateway that has a peering attachment, you can view the peer transit gateway in your global network, but you cannot view its attachments. If you own the peer transit gateway, you can register it in your global network to view its attachments. If you delete a transit gateway, it's automatically deregistered from your global network. Multi-Region and multi-account network You can create a global network that includes transit gateways in multiple AWS Regions and accounts. This enables you to monitor the global health of your AWS network. In the following diagram, the global network includes a transit gateway in the us-east-2 Region from Account A and a transit gateway
tgwnm-004	tgwnm.pdf	4	the peer transit gateway in your global network, but you cannot view its attachments. If you own the peer transit gateway, you can register it in your global network to view its attachments. If you delete a transit gateway, it's automatically deregistered from your global network. Multi-Region and multi-account network You can create a global network that includes transit gateways in multiple AWS Regions and accounts. This enables you to monitor the global health of your AWS network. In the following diagram, the global network includes a transit gateway in the us-east-2 Region from Account A and a transit gateway in the us-west-2 Region from Account B. Each transit gateway has VPC and VPN attachments. You can use the Network Manager console to view and monitor both of the transit gateways and their attachments. Multi-Region and multi-account network 7 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Deﬁne and associate your on-premises network To represent your on-premises network, you add devices, links, and sites to your global network. A site represents the physical location of your branch, oﬃce, store, campus, or data center. When you add a site, you can specify the location information, including the physical address and coordinates. A device represents the physical or virtual appliance that establishes connectivity with a transit gateway over an IPsec tunnel. A link represents a single outbound internet connection used by a device, for example, a 20-Mbps broadband link. When you create a device, you can specify its physical location, and the site where it's located. A device can have a more speciﬁc location than the site, for example, a building in a campus or a ﬂoor in a building. When you create a link, you create it for a speciﬁc site. You can then associate a device with a link. To connect your on-premises network to your AWS resources, associate a customer gateway that's in your global network with the device. If you've created a device to represent a virtual appliance sitting inside your VPC, and you've established a Connect peer from your virtual appliance to your AWS Transit Gateway, associate a Connect peer with the device to connect your virtual appliance network to your AWS resources. In the following diagram, the on-premises network is connected to a transit gateway through a Site-to-Site VPN connection. Deﬁne and associate your on-premises network 8 AWS Network Manager AWS Global Networks for Transit Gateways User Guide You can have multiple devices in a site, which you can associate a device with multiple links. For examples, see AWS Global Networks for Transit Gateways scenarios. You can work with one of our Partners in the AWS Partner Network (APN) to provision and connect your on-premises networks. For more information, see AWS Network Manager. Supported resource types After you register a transit gateway, you can view and monitor the resources in your global network. Amazon VPC resources Resource Transit gateway Related resources • Transit gateway attachment • Transit gateway route table Transit gateway attachment • Direct Connect gateway • Transit gateway • Transit gateway attachment • Transit Gateway Connect peer • VPC • VPN connection Transit gateway route table • Transit gateway Transit Gateway Connect peer • Device • Transit gateway attachment AWS VPN resources Resource Customer gateway Related resources • Device • VPN connection VPN connection • Customer gateway Supported resource types 9 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • Transit gateway attachment AWS Direct Connect resources Resource Related resources Direct Connect connection • Virtual interface Direct Connect gateway • Transit gateway attachment Virtual interface AWS Network Manager resources Resource Connection Device Link Site • Virtual interface • Direct Connect connection • Direct Connect gateway Related resources • Device • Connection • Customer gateway • Link • Site • Transit Gateway Connect peer • Device • Site • Device • Link Supported resource types 10 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Get started with AWS Global Networks for Transit Gateways The following tasks help you become familiar with AWS Global Networks for Transit Gateways. For more information about how AWS Global Networks for Transit Gateways works, see How global networks work. In this example, you create a global network and register your transit gateway with the global network. You can also deﬁne and associate your on-premises network resources with the global network. Tasks • Prerequisites • Step 1: Create a global network • Step 2: Register your transit gateway • Step 3: (Optional) Deﬁne and associate your on-premises network resources • Step 4: (Optional) Enable multi-account access • Step 5: View and monitor your global network Prerequisites Before you begin, ensure that you have a transit gateway with attachments in your account or in any account within your organization. For more information, see
tgwnm-005	tgwnm.pdf	5	example, you create a global network and register your transit gateway with the global network. You can also deﬁne and associate your on-premises network resources with the global network. Tasks • Prerequisites • Step 1: Create a global network • Step 2: Register your transit gateway • Step 3: (Optional) Deﬁne and associate your on-premises network resources • Step 4: (Optional) Enable multi-account access • Step 5: View and monitor your global network Prerequisites Before you begin, ensure that you have a transit gateway with attachments in your account or in any account within your organization. For more information, see Getting Started with Transit Gateways. The transit gateway can be in the same AWS account as the global network or in a diﬀerent AWS account within the organization. Step 1: Create a global network Create a global network as a container for your transit gateway. To create a global network 1. Open the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. Prerequisites 11 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 2. Under Connectivity, choose Global Networks. 3. Choose Create global network. 4. Enter a name and description for the global network, and choose Create global network. Step 2: Register your transit gateway Register a transit gateway in your global network. To register the transit gateway 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit gateways, and then choose Register transit gateway. From the Select account dropdown list, choose the account that you want to register the transit gateway from. A list of transit gateways from that account appear in the Select transit gateway to register section. 6. Select one or more transit gateways from the list, and then choose Register transit gateway. Step 3: (Optional) Deﬁne and associate your on-premises network resources You can deﬁne your on-premises network by creating sites, links, and devices to represent objects in your network. For more information, see the following procedures: • Create a site using AWS Network Manager • Adding a link • Add a device using AWS Network Manager You associate the device with a speciﬁc site, and with one or more links. For more information, see the section called “Associate or disassociate a device link”. Step 2: Register your transit gateway 12 AWS Network Manager AWS Global Networks for Transit Gateways User Guide On your transit gateway you can • Create a Site-to-Site VPN connection attachment. For more information, see the section called “Customer gateway associations”. • Create a transit gateway Connect attachment, and then associate the Connect peer with the device. For more information, see the section called “Add a Connect peer association”. You can also work with one of our Partners in the AWS Partner Network (APN) to provision and connect your on-premises network. For more information, see AWS Network Manager. Step 4: (Optional) Enable multi-account access Enable multi-account access to register transit gateways from multiple accounts, allowing you to view and manage transit gateways and associated resources from those registered accounts in your global network. Onboarding to AWS Organizations is a prerequisite for enabling multi-account access for Network Manager. 1. Create your organization using AWS Organizations. If you've already done this skip this step. For more information on creating an organization using AWS Organizations, see Creating and managing an organization in the AWS Organizations User Guide. 2. Enable multi-account on the Network Manager console. This enables trusted access for Network Manager and allows for registering delegated administrators. For more information enabling trusted access and registering delegated administrators, see Multi-account in AWS Global Networks for Transit Gateways. 3. Create your global network. For more information on creating a global network, see Create a global network using AWS Network Manager. 4. Register transit gateways. With multi-account enabled, you can register transit gateways from multiple accounts to your global network. For more information about registering transit gateways, see Transit gateway registrations in AWS Global Networks for Transit Gateways. Step 4: (Optional) Enable multi-account access 13 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Step 5: View and monitor your global network The Network Manager console provides a dashboard for you to view and monitor both your transit gateway network objects in your global network. To access the dashboard for your global network 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. The Overview page provides an inventory of the objects in your global network for your transit gateway network. For more information about the pages in the dashboard, see the section called “Access transit gateway network dashboards”. Step 5: View and monitor your
tgwnm-006	tgwnm.pdf	6	The Network Manager console provides a dashboard for you to view and monitor both your transit gateway network objects in your global network. To access the dashboard for your global network 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. The Overview page provides an inventory of the objects in your global network for your transit gateway network. For more information about the pages in the dashboard, see the section called “Access transit gateway network dashboards”. Step 5: View and monitor your global network 14 AWS Network Manager AWS Global Networks for Transit Gateways User Guide AWS Global Networks for Transit Gateways scenarios The following are common use cases and scenarios for using AWS Global Networks for Transit Gateways to manage your transit gateways. Contents • AWS-only multi-Region and multi-account global network • Single device with a single VPN connection • Device with multiple VPN connections • Multi-device and multi-link site • SD-WAN connecting to AWS • Connection between devices AWS-only multi-Region and multi-account global network In this scenario, your AWS network consists of three transit gateways. You own transit gateways tgw-1 and tgw-3. Transit gateway tgw-1 has a peering attachment with transit gateway tgw-2 that's in a diﬀerent AWS account. Your entire network is within AWS, and does not consist of on- premises resources. AWS-only multi-Region and multi-account global network 15 AWS Network Manager AWS Global Networks for Transit Gateways User Guide For this scenario, do the following in Network Manager: • Create a global network. For more information, see Create a global network using AWS Network Manager. • Register the transit gateways tgw-1 and tgw-3 with your global network. For more information, see Register a transit gateway using AWS Network Manager. When you register tgw-1, the transit gateway peering attachment is included in the global network, and you can see information about tgw-2. However, any attachments for tgw-2 are not included in your global network. To see attachments for tgw-2, you must enable multi-account access. • This enables trusted access for global networks and allows for registering delegated administrators. For more information enabling trusted access and registering delegated administrators, see Multi-account in AWS Global Networks for Transit Gateways. • Register the tgw-2 transit gateway with your global network. For more information, see Transit gateway registrations in AWS Global Networks for Transit Gateways. Single device with a single VPN connection In the following scenario, your global network consists of a single site with a single device and link. The site is connected to your AWS network through a Site-to-Site VPN attachment on a transit gateway. Your transit gateway also has two VPC attachments. Single device with a single VPN connection 16 AWS Network Manager AWS Global Networks for Transit Gateways User Guide For this scenario, do the following in Network Manager: • Create a global network. For more information, see Create a global network using AWS Network Manager. • Register the transit gateway. For more information, see Register a transit gateway using AWS Network Manager. • Create a site, device, and link. For more information, see the section called “Sites and links” and the section called “Devices”. • Associate the device with the site and with the link. For more information, see the section called “Associate or disassociate a device link”. • Associate the customer gateway (for the transit gateway Site-to-Site VPN attachment) with the device, and optionally, the link. For more information, see the section called “Customer gateway associations”. Device with multiple VPN connections In the following scenario, your on-premises network consists of a device with two Site-to-Site VPN connections to AWS. The device is associated with two customer gateways on two diﬀerent transit Device with multiple VPN connections 17 AWS Network Manager AWS Global Networks for Transit Gateways User Guide gateways. Each VPN connection uses a separate link. To indicate which link applies to which VPN connection, you associate the customer gateway with both the device and the corresponding link. For this scenario, do the following in global networks: • Create a global network. For more information, see Create a global network using AWS Network Manager. • Register the transit gateways. For more information, see Register a transit gateway using AWS Network Manager. • Create a site, device, and link. For more information, see the section called “Sites and links” and the section called “Devices”. />. • Associate the device with the site and both links. For more information, see the section called “Associate or disassociate a device link”. • Associate each customer gateway with the device and the corresponding link. For more information, see the section called “Customer gateway associations”. Device with multiple VPN connections 18 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Multi-device
tgwnm-007	tgwnm.pdf	7	transit gateways. For more information, see Register a transit gateway using AWS Network Manager. • Create a site, device, and link. For more information, see the section called “Sites and links” and the section called “Devices”. />. • Associate the device with the site and both links. For more information, see the section called “Associate or disassociate a device link”. • Associate each customer gateway with the device and the corresponding link. For more information, see the section called “Customer gateway associations”. Device with multiple VPN connections 18 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Multi-device and multi-link site In the following scenario, your on-premises network consists of a site with two devices and two separate Site-to-Site VPN connections to AWS. For example, in a single building or campus, you might have multiple devices connected to AWS resources. Each device is associated with a customer gateway that's attached to your transit gateway. Your AWS network is also connected to your on-premises network though an AWS Direct Connect gateway, which is an attachment on your transit gateway. For this scenario, do the following in global networks: • Create a global network. For more information, see Create a global network using AWS Network Manager. • Register the transit gateway. For more information, see Register a transit gateway using AWS Network Manager. Multi-device and multi-link site 19 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • Create one site, two devices, and two links. For more information, see the section called “Sites and links” and the section called “Devices”. • Associate each device with the corresponding link. For more information, see the section called “Associate or disassociate a device link”. • Associate each customer gateway with the corresponding device and link. For more information, see the section called “Customer gateway associations”. SD-WAN connecting to AWS In the following example, your on-premises network consists of two sites. The Chicago site has two devices and the New York site has one device. Your AWS network consists of two transit gateways. All devices are associated with customer gateways (Site-to-Site VPN attachments) on both transit gateways. Your on-premises network is managed using SD-WAN. The SD-WAN controller creates Site-to-Site VPN connections to the transit gateways, and creates the device, site, and link resources in Network Manager. This automates connectivity and enables you to get a full view of your network in global networks. The SD-WAN controller can also use global networks events and metrics to enhance its dashboard. SD-WAN connecting to AWS 20 AWS Network Manager AWS Global Networks for Transit Gateways User Guide For more information about Partners who can help you set up your Site-to-Site VPN connections, see AWS Network Manager. Connection between devices In the following scenario, your AWS network consists of a transit gateway with a Connect attachment to a VPC that contains a virtual appliance on an EC2 instance. A Connect peer (GRE tunnel) is established between the transit gateway and the appliance. The appliance is connected to a physical device in your on-premises network through a connection. Connection between devices 21 AWS Network Manager AWS Global Networks for Transit Gateways User Guide For this scenario, do the following in global networks: • Create a global network. For more information, see Create a global network using AWS Network Manager. • Register the transit gateway. For more information, see Register a transit gateway using AWS Network Manager. • Create a site, device, and link for your on-premises network. For more information, see the section called “Sites and links” and the section called “Devices”. • Associate the device with the site and with the link. For more information, see the section called “Associate or disassociate a device link”. • Create a device for the EC2 virtual device. For visualization in the global networks console, specify the AWS location of the device (for example, the Availability Zone). For more information, see the section called “Devices”. • Create a connection between the on-premises device and the virtual device. For more information, see the section called “Associate or disassociae an on-premises link”. • Associate the Connect peer with the on-premises device. For more information, see the section called “Associate or disassociate a Connect peer”. Connection between devices 22 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Modify a global network using AWS Network Manager After setting up a global network you further modify it by performing a number of tasks. Tasks you can perform to enhance your global network include: • Monitor and manage global network resources from other AWS accounts. AWS Global Networks for Transit Gateways supports multi-account access. If enabled, multi- account allows you to manage, monitor, and view dashboards of resources from AWS accounts shared with your account. • Register a transit gateway Register existing
tgwnm-008	tgwnm.pdf	8	a Connect peer”. Connection between devices 22 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Modify a global network using AWS Network Manager After setting up a global network you further modify it by performing a number of tasks. Tasks you can perform to enhance your global network include: • Monitor and manage global network resources from other AWS accounts. AWS Global Networks for Transit Gateways supports multi-account access. If enabled, multi- account allows you to manage, monitor, and view dashboards of resources from AWS accounts shared with your account. • Register a transit gateway Register existing transit gateways in your global network. When you register a transit gateway all transit gateway attachments are automatically included in the registration. A transit gateway must ﬁrst be created before it can be registered. For more information about transit gateways and creating one, see Transit gateways in the Amazon VPC Transit Gateways User Guide. • Create sites and links, and connect devices Add representations of physical devices and sites to your global network. You can then create a link that associates a device and a site. • Create customer gateway associations Create associations between two devices or between a device and a transit gateway Connect peer. • Access global network dashboards AWS Global Networks for Transit Gateways includes separate transit gateway network and transit gateway dashboards. On these dashboards you can view logical trees and geographic maps of your networks, which includes attachments, sites and devices. You can also view monitoring and events dashboards, allowing you to view Amazon CloudWatch metrics and to set threshold alarms on these metrics. If your account is set up for multi-account, you can manage global network resources from multiple AWS accounts. For more information on multi-account, see the section called “Multi-account”. Contents 23 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • Multi-account in AWS Global Networks for Transit Gateways • Global networks in AWS Global Networks for Transit Gateways • Transit gateway registrations in AWS Global Networks for Transit Gateways • Sites and links in AWS Global Networks for Transit Gateways • Devices in AWS Global Networks for Transit Gateways • Connections in AWS Global Networks for Transit Gateways • Gateway associations in AWS Global Networks for Transit Gateways • Resource tags in AWS Global Networks for Transit Gateways Multi-account in AWS Global Networks for Transit Gateways With AWS Global Networks for Transit Gateways, you can manage, monitor, and view dashboards of global network resources from multiple AWS accounts associated with a single organization using AWS Network Manager. For more information about setting up multi-account, see Manage multiple accounts in global networks using AWS Organizations below. Important • We strongly recommended that you use the global networks console for enabling multi-account settings with global networks, because the console automatically creates all required roles and permissions for multi-account access. Choosing an alternative approach requires an advanced level of expertise, and opens the multi-account set up for your global network to be more prone to error. • Multi-account is not available in the AWS GovCloud (US-West) and the AWS GovCloud (US-East) Regions. Prerequisites To enable multi-account, you ﬁrst set up an account in AWS Organizations. This ﬁrst account becomes the management account. Using this account, you can then add other accounts as member accounts to your organization. For more information about how multi-account support works, see Creating and managing an organization in the AWS Organizations User Guide. Multi-account 24 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Manage multiple accounts in global networks using AWS Organizations AWS Global Networks for Transit Gateways allows you to centrally manage, monitor, and visualize network resources from multiple accounts within an organization in a single global network. To manage resources from multiple accounts in global networks, you ﬁrst set up an organization using AWS Organizations. The ﬁrst account that you use to create an organization becomes the management account. Using this account, you can add other accounts as member accounts to your organization. From the management account, you can designate one or more accounts within the orgaization as delegated administrator accounts by registering them using the global networks console. For more information about setting up an organization, see Creating and managing an organization in the AWS Organizations User Guide. To enable multi-account access in the global networks console, you ﬁrst enable trusted access for the Network Manager service, and then register a delegated administrator account for your organization. Important • We strongly recommended that you use the global networks console for enabling multi-account settings with global networks, because the console automatically creates all required roles and permissions for multi-account access. Choosing an alternative approach requires an advanced level of expertise, and opens the multi-account set up for your global network to be more
tgwnm-009	tgwnm.pdf	9	setting up an organization, see Creating and managing an organization in the AWS Organizations User Guide. To enable multi-account access in the global networks console, you ﬁrst enable trusted access for the Network Manager service, and then register a delegated administrator account for your organization. Important • We strongly recommended that you use the global networks console for enabling multi-account settings with global networks, because the console automatically creates all required roles and permissions for multi-account access. Choosing an alternative approach requires an advanced level of expertise, and opens the multi-account set up for your global network to be more prone to error. • Multi-account is not available in the AWS GovCloud (US-West) and the AWS GovCloud (US-East) Regions. With multi-account support, you can create a single global network for any of your AWS accounts, and then register transit gateways from those accounts using the global networks console. Multi- account is supported in all AWS Regions where global networks is supported. For more information about multi-account, see Multi-account in AWS Global Networks for Transit Gateways. Trusted access Trusted access creates AWSServiceAccess for global networks and AWS CloudFormation StackSets with AWS Organizations. Enabling trusted access provides required permissions for AWS Organizations to deploy service-linked roles (SLRs) to all member accounts within your organization. Manage multiple accounts 25 AWS Network Manager Enable trusted access AWS Global Networks for Transit Gateways User Guide When you enable trusted access from the global networks console, you select a one-time permission level (IAMRoleForAWSNetworkManagerCrossAccountResourceAccess) as either administrator or read-only for each of the management and delegated administrator accounts. • Admin — Assign this permission if the delegated administrator and management accounts need to be able to modify resources from other accounts in the global network while using the global networks console switch role. • Read-only — Assign this permission if the delegated administrator and management accounts only need to review information about resources from other accounts in the global network while using the global networks console switch role, but don't need to make any changes. The global networks console manages all of this when calling the Network Manager API. When you enable trusted access, the following roles are deployed in your organization using AWS CloudFormation StackSets and AWS Identity and Access Management (IAM) services: • The Network Manager SLR (AWSServiceRoleForNetworkManager) to all member accounts • The AWS CloudFormation StackSets member SLR (AWSServiceRoleForCloudFormationStackSetsOrgMember) to all member accounts • The Network Manager SLR (AWSServiceRoleForNetworkManager) to the management account • The AWS CloudFormation StackSets admin (AWSServiceRoleForCloudFormationStackSetsOrgAdmin) SLR to the management account • The Amazon CloudWatch sharing role (CloudWatch-CrossAccountSharingRole) to all member accounts • The global networks console switch role (IAMRoleForAWSNetworkManagerCrossAccountResourceAccess) to all member accounts • The Amazon CloudWatch monitoring role (AWSServiceRoleForCloudWatchCrossAccount) to the management account For more information about enabling trusted access, see Enable trusted access in an AWS global network. Manage multiple accounts 26 AWS Network Manager Disable trusted access Note AWS Global Networks for Transit Gateways User Guide Disabling trusted access through the global networks console removes AWSServiceAccess for global networks with AWS Organizations. Disabling trusted access removes global networks access to perform tasks within your organization. AWS Organizations won't allow you to disable an organization's trusted access for the Network Manager service if there are any delegated administrators that haven't been deregistered from that organization. • Disabling trusted access through the global networks console won't remove AWSServiceAccess for AWS CloudFormation StackSets with AWS Organizations. You can manually remove the service access for AWS CloudFormation StackSets by using the AWS CloudFormation StackSet console or by using the Organizations API/CLI. For more information on disabling trusted access for AWS CloudFormation StackSets, see Disable trusted access with AWS CloudFormation StackSets in the AWS Organizations User Guide. • Disabling trusted access won't remove any SLRs that were deployed when enabling trusted access. When you disable trusted access, the following are aﬀected in global networks: • All transit gateways owned by other accounts in your organization. You won't be able to see transit gateways or their attached resources from other accounts in your organization that were registered to your global network. • IAM roles deployed in all member accounts managed by the Network Manager service. Disabling trusted access doesn't remove accounts, transit gateways, or resources but does deregister them from other delegated administrator's global networks. These can be added back in as needed by re-enabling trusted access. For more information about the DeleteStackSet API, see DeleteStackSet in the AWS CloudFormation API Reference. For more information about disabling trusted access, see Disable trusted access in an AWS global network. Manage multiple accounts 27 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Delegated administrators Member accounts in your organization with delegated administrator access are able to leverage service-linked roles and assume IAM roles for access across multiple accounts. Only member accounts
tgwnm-010	tgwnm.pdf	10	gateways, or resources but does deregister them from other delegated administrator's global networks. These can be added back in as needed by re-enabling trusted access. For more information about the DeleteStackSet API, see DeleteStackSet in the AWS CloudFormation API Reference. For more information about disabling trusted access, see Disable trusted access in an AWS global network. Manage multiple accounts 27 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Delegated administrators Member accounts in your organization with delegated administrator access are able to leverage service-linked roles and assume IAM roles for access across multiple accounts. Only member accounts that are part of your AWS Organizations can be registered as delegated administrators. Your organization can have up to ten registered delegated administrators. Before you register a delegated administrator, you must enable global networks trusted access for your organization. For more information, see Enable trusted access in an AWS global network. Important Using your AWS Organizations management account to manage your global network in global networks is not recommended because the required service-linked roles are not propagated to this account. For more information on service-linked roles, see the section called “Service-linked role”. Register delegated administrators After it's registered, a delegated administrator has the same permissions as the management account. A delegated administrator for the Network Manager service can leverage the SLRs in the member accounts that were deployed when trusted access was enabled and can view transit gateways from other member accounts and can register them to your global network. This allows transit gateways and associated resources to appear in your global network topology. In addition AWS CloudFormation StackSets is updated to include the delegated administrator accounts in the trusted relationship of the deployed IAM roles in the member accounts. For information about registering a delegated administrator, see Register an administrator for multi-account in an AWS global network. Deregister delegated administrators Deregistering a delegated administrator removes that account's permission to leverage SLRs and assume IAM roles in other member accounts that were set up using AWS Organizations. After it's deregistered, the delegated administrator no longer has the same permissions as the management account. The following occurs: • A delegated administrator is no longer able to leverage the deployed SLRs in the member accounts that were deployed when trusted access was enabled. Manage multiple accounts 28 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • All registered transit gateways from other member accounts are deregistered from any global network for the speciﬁc delegated administrator. The network topology is updated to no longer show resources from other member accounts. • AWS CloudFormation StackSets are updated with the removal of the delegated administrator account. That account is no longer able to assume any IAM roles deployed in other member accounts. For information about deregistering a delegated administrator, see Deregister an administrator from multi-account in an AWS global network. Multi-account tasks • Enable trusted access in an AWS global network • Disable trusted access in an AWS global network • Register an administrator for multi-account in an AWS global network • Deregister an administrator from multi-account in an AWS global network • Manage IAM multi-account role deployments in an AWS global network • Troubleshoot multi-account self-managed roles in an AWS global network Enable trusted access in an AWS global network Enabling trust is a one-time task that deploys the required service-linked roles (SLRs) and custom Identity and Access Management (IAM) roles to all accounts in your organization that can be assumed by the management account or delegated administrators for access across multiple accounts. For more information about trusted access, see Trusted access. To enable multi-account trusted access 1. Log into the global networks console at https://console.aws.amazon.com/networkmanager/ home/, using the AWS Organizations management account. 2. Choose Get started. 3. 4. In the navigation pane, choose Enable trusted access. From the Permission level dropdown list in Enable trusted access, choose the Permission level for the Network Manager console switch role IAMRoleForAWSNetworkManagerCrossAccountResourceAccess. This role is deployed to all member accounts and is assumed by the delegated administrator or management account Enable trusted access 29 AWS Network Manager AWS Global Networks for Transit Gateways User Guide when accessing resources from other accounts using the global networks console. You can choose only one permission level for all accounts. Permission can be one of the following: • Read-only — Assign this permission if the delegated administrator and management accounts only need to review information about resources from other accounts in the global network while using the console switch role, but don't need to make any changes. • Admin — Assign this permission if the delegated administrator and management accounts need to be able to modify resources from other accounts in the global network while using the global networks console switch role. 5. Choose Enable trusted access. Depending
tgwnm-011	tgwnm.pdf	11	networks console. You can choose only one permission level for all accounts. Permission can be one of the following: • Read-only — Assign this permission if the delegated administrator and management accounts only need to review information about resources from other accounts in the global network while using the console switch role, but don't need to make any changes. • Admin — Assign this permission if the delegated administrator and management accounts need to be able to modify resources from other accounts in the global network while using the global networks console switch role. 5. Choose Enable trusted access. Depending on your organization size, it might take a few minutes or more to enable trusted access. During this time the State shown in the Trusted access section displays Enabling in progress. When access is enabled, the State changes to Enabled. Additionally, the IAM role deployments status section at the bottom of the page displays the status of the IAM roles being deployed to member accounts of the organization. 6. After trusted access is enabled, you can register delegated administrators. Disable trusted access in an AWS global network Disabling trusted access removes the trust relationship between the Network Manager service access and your organization. Network Manager is no longer able to perform actions within your organization or access information about your organization. Trusted access remains for AWS CloudFormation StackSets in the event that your organization is using that service outside of Network Manager. For more information on disabling AWS CloudFormation StackSets, see Disabling trusted access with AWS CloudFormation Stacksets in the AWS Organizations User Guide. Transit gateways from other accounts are deregistered from global networks owned by the management account and can no longer provide access to their attached resources. For more information about disabling trusted access, see Disable trusted access. You must ﬁrst deregister all delegated administrators before you can disable trusted access. If you have registered delegated administrators, you will be prompted to deregister them during the disable trusted access process. You can enable trusted access again after disabling it. However you will need to set up the list of delegated administrators again. Disabled trusted access 30 AWS Network Manager AWS Global Networks for Transit Gateways User Guide To disable trusted access 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/ with the management account. 2. Under Connectivity, choose Global Networks. 3. 4. 5. In the navigation pane, choose Settings. In the Trusted Access section, choose Disable trusted access. If you have any registered delegated administrators, you can deregister them by choosing Deregister delegated administrators. 6. Choose Disable trusted access on the conﬁrmation dialog box to conﬁrm that you want to disable trusted access. Depending on the size of your organization, it might take several minutes or longer to disable trusted access. The State displays Disabling in progress. During this time you won't be able to re-enable trusted access. When ﬁnished, the Status changes to Disabled. Register an administrator for multi-account in an AWS global network Use the AWS Global Networks for Transit Gateways console to register delegated administrators. You can register up to ten delegated administrators. Delegated administrators can assume the SLR and IAM roles deployed while enabling trusted access for access across multiple accounts. For more information about delegated administrators, see Delegated administrators. To register a delegated administrator 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/ with the management account. 2. Under Connectivity, choose Global Networks. 3. 4. 5. In the navigation pane, choose Settings. In the Delegated Administrators section, choose Register delegated administrator. From the AWS account ID dropdown list, choose one or more AWS Organizations accounts that you want to delegate administrator permissions to. 6. Choose Register delegated administrator. 7. When the delegated administrator is registered, you can then register transit gateways from any transit gateways from any account within your organization to the global network in the Register a delegated administrator 31 AWS Network Manager AWS Global Networks for Transit Gateways User Guide delegated administrator account. For more information about registering transit gateways in the global network of a delegated administrator account, see Transit gateway registrations in AWS Global Networks for Transit Gateways. Deregister an administrator from multi-account in an AWS global network Deregistering delegated administrators removes that account's permission to manage global networks for your organization. All registered transit gateways from other member accounts are deregistered from the speciﬁc delegated administrator's global networks. For more information about how deregistering delegated administrators works, see Deregister delegated administrators. To deregister a delegated administrator 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/ with the management account. 2. Under Connectivity, choose Global Networks. 3. 4. In the navigation pane, choose Settings. In the Delegated Administrators section, choose one or more accounts that you want to deregister. Depending on your organization size and the number of
tgwnm-012	tgwnm.pdf	12	Deregistering delegated administrators removes that account's permission to manage global networks for your organization. All registered transit gateways from other member accounts are deregistered from the speciﬁc delegated administrator's global networks. For more information about how deregistering delegated administrators works, see Deregister delegated administrators. To deregister a delegated administrator 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/ with the management account. 2. Under Connectivity, choose Global Networks. 3. 4. In the navigation pane, choose Settings. In the Delegated Administrators section, choose one or more accounts that you want to deregister. Depending on your organization size and the number of delegated administrators you're deregistering, this could take several minutes. During this time you won't be able to register any new delegated administrators. Manage IAM multi-account role deployments in an AWS global network The IAM role deployments status section displays the current role deployments status for all member accounts set up in your account. • Member account ID — The account ID for the account set up in AWS Organizations. This includes member accounts and members that have been registered as delegated administrators. • CloudWatch role status — The status of the account's Amazon CloudWatch role. If you enable multi-account using the Network Manager console, this is StackSets-managed if deployed successfully. Otherwise, this is Self-managed. Deregister a delegated administrator 32 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • Console role status — The status of the account's Network Manager console role. If you enable multi-account using the Network Manager console, this is StackSets-managed if deployed successfully. Otherwise, this is Self-managed. • Review required — This applies only to Self-managed roles. A review is required to ensure that the permissions set up for the account are correct. For more information, see Multi-account access roles for AWS Global Networks for Transit Gateways. If you make changes to your role policies, or if you've updated a self-managed role, you can deploy the updated policy to your AWS Organizations accounts. To retry the IAM role deployment status 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/ with the management account. 2. Under Connectivity, choose Global Networks. 3. 4. In the navigation pane, choose Settings. In the IAM role deployments status section, choose Retry role deployment. Depending on your organization size and the number of member accounts in your organization, this could take several minutes. During this time you won't be able to register or deregister any new delegated administrators. Troubleshoot multi-account self-managed roles in an AWS global network AWS Global Networks for Transit Gateways uses AWS CloudFormation StackSets to deploy the required IAMRoleForAWSNetworkManagerCrossAccountResourceAccess role and the CloudWatch monitoring CloudWatch-CrossAccountSharingRole role in your AWS Organizations member accounts for cross-account access. For a CloudFormation StackSets- managed deployment, IAM roles must have the required policies attached, as well as the trusted relationship to allow registered delegated administrators and the management account the ability to assume these roles. In a self-managed deployment, you own the responsibility to attach the appropriate policies and to manage the trusted relationship required for the delegated administrator and management accounts to access multiple accounts. Troubleshoot self-managed roles 33 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Important We strongly recommend that you use the global networks console for enabling multi- account settings using the global networks console as this automatically sets up all required roles and permissions for multi-account access. Choosing an alternative approach requires an advanced level of expertise and opens the multi-account setup for your global network to be more prone to error. If the CloudFormation StackSets deployment fails, and the Review required message is IAM role exists, follow the steps below in IAM role exists to change the role from Self-managed to StackSets-managed. For any message other than IAM role exists, ﬁle an AWS Support case. For more information on creating a support case, see Creating a support case in the AWS Support User Guide. IAM role exists If the IAM role has the exact same name in a current the member account, these roles appear in the IAM role deployments status with a status of Self-managed. In order to change this to StackSets-managed, delete the IAM role from the member account with the duplicate role name. After deleting the IAM role, use the global networks console to retry the role deployment. For the steps to retry a role deployment, see Manage IAM multi-account role deployments in an AWS global network to retry the role deployment. To change a role from self-managed to StackSets-managed 1. Access the AWS Identity and Access Management (IAM) console at https:// console.aws.amazon.com/iamv2/home?#/ with the member account that has a self-managed role status. In the navigation pane, choose Roles. In the Roles ﬁeld, search for the role name you want to delete. 2. 3. 4. Choose the role, and then
tgwnm-013	tgwnm.pdf	13	duplicate role name. After deleting the IAM role, use the global networks console to retry the role deployment. For the steps to retry a role deployment, see Manage IAM multi-account role deployments in an AWS global network to retry the role deployment. To change a role from self-managed to StackSets-managed 1. Access the AWS Identity and Access Management (IAM) console at https:// console.aws.amazon.com/iamv2/home?#/ with the member account that has a self-managed role status. In the navigation pane, choose Roles. In the Roles ﬁeld, search for the role name you want to delete. 2. 3. 4. Choose the role, and then choose Delete. 5. Conﬁrm that you want to delete the role. Troubleshoot self-managed roles 34 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Warning This might break other functionality if a custom role has other attached policies or trusted relationships. 6. Access the global networks console at https://console.aws.amazon.com/networkmanager/ home/ with the AWS Organizations management account. 7. Choose Get started. 8. 9. In the navigation pane, choose Settings. In the IAM role deployment status section, choose Retry role deployment. Depending on the size of your organization, it might take several minutes or longer to disable trusted access. During this time you won't be able to re-enable trusted access. Global networks in AWS Global Networks for Transit Gateways A global network in AWS Global Networks for Transit Gateways is a container for your network objects. When you create a global network, you create only the framework of the global network itself. You'll then further deﬁne this network by adding network objects to it, such as • transit gateways. • sites, devices, and links, and then creating connections using links between those sites and devices. • customer gateway associations. • Connect peer associations. Note When creating a global network, you're prompted to create an associated core network. A core network is a feature of AWS Cloud WAN and is not needed if you're not using this feature. While creating a global network, you're prompted whether or not to create a core network. Clear the option to create the core network. If you decide later on that you want to create a core network for this global network you can. For the steps to create a core network, see What is AWS Cloud WAN in the AWS Cloud WAN User Guide. Global networks 35 AWS Network Manager AWS Global Networks for Transit Gateways User Guide You can create, view, update, and delete a global network using either the AWS Network Manager console or by using the CLI. Global network tasks • Create a global network using AWS Network Manager • View a global network using AWS Global Networks for Transit Gateways • Update a global network using AWS Network Manager • Delete a global network using AWS Network Manager Create a global network using AWS Network Manager Create a global network. To create a global network 1. Open the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. 4. 5. Choose Create global network. Enter a Name and Description for your global network. (Optional) In Additional settings, add Key and Value tags that further help identify an Network Manager resource. To add multiple tags, choose Add tag for each tag you want to add. 6. Choose Next. 7. To create a AWS Transit Gateway network only, clear the Add core network in your global network check box on the Create global network - optional page, and then choose Next. Note Core networks are only used with AWS Cloud WAN. If you're creating global network for AWS Cloud WAN and want to create a core network, see Create a core network policy in the AWS Cloud WAN User Guide. 8. Review the information for the global network you want to create, and then choose Create global network. Create a global network 36 AWS Network Manager AWS Global Networks for Transit Gateways User Guide To create a global network using the AWS CLI Use the create-global-network command. View a global network using AWS Global Networks for Transit Gateways View the details of your global network and information about the network objects in your global network. To view your global network information 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. The Overview page displays an inventory of the objects in both your core network and transit gateway network. To view details about the global network resource (such as its ARN), choose Details. For more information about the other pages on the dashboard, see the section called “Access transit gateway network dashboards”. To view global network details using the AWS CLI Use the describe-global-networks command. Update a global network using AWS Network
tgwnm-014	tgwnm.pdf	14	network information 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. The Overview page displays an inventory of the objects in both your core network and transit gateway network. To view details about the global network resource (such as its ARN), choose Details. For more information about the other pages on the dashboard, see the section called “Access transit gateway network dashboards”. To view global network details using the AWS CLI Use the describe-global-networks command. Update a global network using AWS Network Manager Update a global network by modifying the description or tags. To update your global network 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. Choose Edit. 5. For Description, enter a new description for the global network. View a global network 37 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 6. For Tags, choose Remove tag to remove an existing tag, or choose Add tag to add a new tag. 7. Choose Edit global network. To update a global network using the AWS CLI Use the update-global-network command to update the description. Use the tag-resource and untag-resource commands to update the tags. Delete a global network using AWS Network Manager Delete a global network framework. You cannot delete a global network if there are any network objects in the global network, including transit gateways, links, devices, and sites. You must ﬁrst deregister or delete the network objects. To delete your global network 1. Open the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. In the navigation pane, choose Global networks. 4. Choose your global network and choose Delete. 5. In the conﬁrmation dialog box, choose Delete. To delete a global network using the AWS CLI Use the delete-global-network command. Transit gateway registrations in AWS Global Networks for Transit Gateways You can register your existing transit gateways with a global network. Any transit gateway attachments (such as VPCs, VPN connections, and AWS Direct Connect gateways) are automatically included in your global network. Transit gateway limitations Note the following about registering transit gateways in a global network: Delete a global network 38 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • A transit gateway must ﬁrst be created in Amazon Virtual Private Cloud (VPC) before it can be registered in a global network. For more information about transit gateways and creating one, see Transit gateways in the Amazon VPC Transit Gateways User Guide. • You can have multiple global networks, but you can only register one transit gateway with one global network. • You can register transit gateways that are in the same AWS account as the global network. • You cannot create, delete, or modify your transit gateways and their attachments using the Network Manager console or APIs. To work with transit gateways, use the Amazon VPC console or the Amazon EC2 APIs. Transit gateway registration tasks • Register a transit gateway using AWS Network Manager • View registered transit gateways using AWS Network Manager • Deregister a transit gateway using AWS Network Manager Register a transit gateway using AWS Network Manager Register a transit gateway created using Amazon Virtual Private Cloud with your AWS global network using either the Network Manager console or using the CLI. You cannot register a transit gateway with more than one global network. To register a transit gateway 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit gateways., and then choose Register transit gateway. (Optional) If your account is enabled for multi-account access, from the Select account dropdown list choose the account you want to register transit gateways from. The Select transit gateway to register section populates with that account's transit gateways. 6. Choose one or more transit gateways, and then choose Register transit gateway. Register a transit gateway 39 AWS Network Manager AWS Global Networks for Transit Gateways User Guide To register a transit gateway using the AWS CLI Use the register-transit-gateway command. View registered transit gateways using AWS Network Manager View a transit gateway registered with your AWS global network using either the Network Manager console or using the CLI. To access your registered transit gateways 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit gateways. The Transit gateways page lists your registered transit gateways. Choose the ID of transit gateway to view
tgwnm-015	tgwnm.pdf	15	Guide To register a transit gateway using the AWS CLI Use the register-transit-gateway command. View registered transit gateways using AWS Network Manager View a transit gateway registered with your AWS global network using either the Network Manager console or using the CLI. To access your registered transit gateways 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit gateways. The Transit gateways page lists your registered transit gateways. Choose the ID of transit gateway to view its details. To view your registered transit gateways using the AWS CLI Use the get-transit-gateway-registrations command. Deregister a transit gateway using AWS Network Manager Deregister a transit gateway from a global network using either the Network Manager console or using the CLI. Once deregistered, you can re-register this transit gateway with the same global network or with a diﬀerent global network. To deregister a transit gateway 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit gateways. Select your transit gateway, and choose Deregister. View registered transit gateways 40 AWS Network Manager AWS Global Networks for Transit Gateways User Guide To deregister a transit gateway using the AWS CLI Use the deregister-transit-gateway command. Sites and links in AWS Global Networks for Transit Gateways After you've added any devices to your AWS global network, you can associate of your devices with that particular site using a connection, or link. For information on adding devices, see the section called “Devices”. Sites A site represents the physical location of your network, using location information such as latitude, longitude, and address. You can have multiple sites for each of your network locations. Sites are useful when viewing the global network dashboard, which provides you the geographical location of these sites based on location information you provided. Once you create a site you can view the devices associated with the site and create links between devices and sites. You can also view any VPNs associated with the site as well as monitor CloudWatch metrics for this site. Links A link represents the connection between a device and a site. Once you've added a device and created a site, you can create an association between the device and a site. Tasks Create a site using AWS Network Manager Create a site to represent the physical location of your network. Location information is used in the Network Manager transit gateway dashboards. To create a site 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Sites. Choose Create site. Sites and links 41 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 5. 6. 7. 8. For Name and Description, enter a name and description for the site. For Address, enter the physical address of the site, for example, New York, NY 10004. For Latitude, enter the latitude coordinates for the site, for example, 40.7128. For Longitude, enter the longitude coordinates for the site, for example, -74.0060. 9. Choose Create site. Creating and viewing a site using the AWS CLI Use the following commands: • To create a site: create-site • To view your sites: get-sites View site details using AWS Network Manager View details about a core network site using the Network Manager console. To view details about a site 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Sites. 5. Choose the link that you want to see site details for. 6. The General details page provides information about the site. 7. Choose the Devices tab. This page displays information about the devices that are connected to the site. If you don't see a device listed, you'll need to add it. For more information on adding devices, see the section called “Add a device”. 8. Choose the Links tab. This page displays the links that represent a connection from a device. If you don't see a link listed, you'll need to create the link. For the steps to create a link, see the section called “Add a link”. 9. Choose the VPNs tab. This page displays site-related VPN information. View site details 42 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 10. Choose the Monitoring tab. This page displays Data In and Data Out information for your links. 11. From the dropdown list, choose the link that you want to view
tgwnm-016	tgwnm.pdf	16	8. Choose the Links tab. This page displays the links that represent a connection from a device. If you don't see a link listed, you'll need to create the link. For the steps to create a link, see the section called “Add a link”. 9. Choose the VPNs tab. This page displays site-related VPN information. View site details 42 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 10. Choose the Monitoring tab. This page displays Data In and Data Out information for your links. 11. From the dropdown list, choose the link that you want to view information for. 12. (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Update a site using AWS Network Manager Update any of the details of a site you've added, including the description, address, latitude, and longitude. To update a site 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Sites, and select your site. 5. Choose Edit. 6. Update the Description, Address, Latitude, Longitude, and Tags as needed. 7. Choose Edit site. Update a site using the AWS CLI Use the update-site command. Update a site 43 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Delete a site using AWS Network Manager Delete sites from your global network if the site is no longer valid or you no longer want to return any information about the site. You must ﬁrst disassociate the site from any devices and delete any links for the site. To delete a site 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. 6. In the navigation pane, choose Sites. Select the site and choose Delete. In the conﬁrmation dialog box, choose Delete. Deleting a site using the AWS CLI Use the delete-site command. Add a link using AWS Network Manager Add a link to associated a device with a site. To add a link 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Sites. 5. Choose the link for the site ID that you want to add a link to, and then choose the Links tab. Note Choose the link. Do not select the check box. Delete a site 44 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 6. Choose the Links tab, and then choose Create link. 7. 8. 9. For Name and Description, enter a name and description for the link. For Upload speed (Mbps), enter the upload speed in Mbps. For Download speed (Mbps), enter the download speed in Mbps. 10. (Optional) For Provider, enter the name of the service provider. 11. (Optional) For Type, enter the type of link, for example, broadband. 12. (Optional) Under Additional settings, add one or more Key and Value Tags to help further identify this link. 13. Choose Create link. Edit a link using AWS Network Manager Edit the link between two devices in your Cloud WAN global network. To update a link 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Sites. 5. Choose the Links tab. 6. On the Links page, select the check box for the link that you want to update, and then choose Edit. 7. Modify any of the link settings as needed, including adding, editing, or removing tags. 8. Choose Edit link. Delete a link using AWS Network Manager You can delete the link between two devices without deleting the devices. To delete a link 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. Edit a link 45 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Sites. 5. Choose the Links tab. 6. On the Links page, select the
tgwnm-017	tgwnm.pdf	17	any of the link settings as needed, including adding, editing, or removing tags. 8. Choose Edit link. Delete a link using AWS Network Manager You can delete the link between two devices without deleting the devices. To delete a link 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. Edit a link 45 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Sites. 5. Choose the Links tab. 6. On the Links page, select the check box for the link that you want to delete, and then choose Delete. 7. Conﬁrm that you want to delete the link by choosing Delete again. Devices in AWS Global Networks for Transit Gateways Devices represent a physical or virtual appliance in AWS Global Networks for Transit Gateways. When you add a device to your core network using AWS Network Manager, you can include optional information such as vendor, model and serial number to help you more easily identify the device. In addition, you'll indicate whether the device is on-premises or in the AWS Cloud. If the device is on-premises you can specify optional information such as physical address. If the device is in the AWS Cloud, you can specify the zone, subnet ID, latitude and longitude, and physical address. Tags are also used to more help you identify this Network Manager resource. Once added to your global network, a device can then be associated with a site. Before you can associate the device with a site using a link, you must ﬁrst create the site. For more information on creating sites and linking the site to a device, see the section called “Sites and links”. Note A single device can't be associated with multiple sites. Topics • Add a device using AWS Network Manager • Delete a device using AWS Network Manager • Edit a device using AWS Network Manager • View device details using AWS Network Manager Devices 46 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Add a device using AWS Network Manager Create a device to represent a physical or virtual appliance. To add a device 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. 6. 7. 8. 9. In the navigation pane, choose Devices. Choose Create device. For Name and Description, enter a name and description for the device. For Model, enter the device model number. For Serial number, enter the serial number for the device. For Type, enter the device type. For Vendor, enter the name of the vendor, for example, Cisco. 10. For Location type, specify whether the device is located in a remote location (on-premises network, data center, or other cloud provider) or in AWS. If you choose AWS Cloud, specify the location of the device within AWS. For Zone, specify the name of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost. For Subnet, specify the Amazon Resource Name (ARN) of a subnet (for example, arn:aws:ec2:us- east-1:111111111111:subnet/subnet-abcd1234). 11. For Address, enter the physical address of the site, for example, New York, NY 10004. 12. For Latitude, enter the latitude coordinates for the site, for example, 40.7128. 13. For Longitude, enter the longitude coordinates for the site, for example, -74.0060. 14. Choose Create device. Creating and viewing a device using the AWS CLI Use the following commands: • To create a device: create-device • To view your devices: get-devices Add a device 47 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Delete a device using AWS Network Manager Delete any device from your global network that's no longer needed or is no longer available. To delete a site 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the device that you want to want to delete, and then choose Delete. 6. Conﬁrm that you want to delete the site by choosing Delete again. Deletion occurs immediately. Edit a device using AWS Network Manager Edit the details of a device, including whether the location type is either on-premises or AWS Cloud. To update a device 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the check box of the device that you want to update, and then choose Edit. 6. Choose Edit device. 7. Add or update any of the following device information: •
tgwnm-018	tgwnm.pdf	18	by choosing Delete again. Deletion occurs immediately. Edit a device using AWS Network Manager Edit the details of a device, including whether the location type is either on-premises or AWS Cloud. To update a device 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the check box of the device that you want to update, and then choose Edit. 6. Choose Edit device. 7. Add or update any of the following device information: • Description • Model • Serial number Delete a device 48 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • Type • Vendor • Location type • Latitude • Longitude • Tags 8. Choose Edit device. View device details using AWS Network Manager View details about a device. On the device details page you can access tabs: • Overview This tab provides general information about the device, such as the device State, Vendor, and Model. You can also edit, delete, and associate or disassociate the device with a site, • Links Associate or disassociate a link with a device. • On-premises associations Associate or disassociate a device with a customer gateway. You must have at least one gateway set up and one link to create the association. • Connect peer associations Associate a Connect peer with a device, allowing you to connect with a transit gateway. You must have at least one Connect peer and one link. • Connections Create a connection between two devices using a link. You can create a connection between two devices in your global network. The connection can be between a physical or virtual appliance and a third-party appliance in a VPC, or between physical appliances in an on-premises network. A connection is created for a speciﬁc global network and cannot be shared with other global networks. • VPNs View device details 49 AWS Network Manager AWS Global Networks for Transit Gateways User Guide View the VPNs associated with the device. On this tab you can only view the associations of a transit gateway with a device. • Monitoring Monitor the device's data in, data out, and Tunnel down count average with CloudWatch metrics. You can modify the CloudWatch time frame as well as add these metrics to your global network dashboard. Topics • Associate or disassociate a device link using AWS Network Manager • Associate or disassociate an on-premises link using AWS Network Manager • Associate or disassociate a Connect peer using AWS Network Manager • View VPNs using AWS Network Manager • Monitor devices using AWS Network Manager Associate or disassociate a device link using AWS Network Manager Associate a link with a device in your AWS global network. In order to associate a link with a device, you must ﬁrst create the link. For more information on creating links, see the section called “Add a link”. You can only associate one link with one device. If a link is already associated with a device, and you want to use that link with another device, you must ﬁrst disassociate the link the device it's associated with. To associate a link with a device 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the link for the device ID that you want to add a link to, and then choose the Links tab. View device details 50 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Note Choose the link. Do not select the check box. 6. Choose the Links tab, and then choose Associate link. 7. Choose the link that you want to associate with the device. 8. Choose Associate link. The link is available to use immediately. If you to use a link with another device, you must ﬁrst disassociate the link from its original device. To disassociate a link from a device 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the link for the device ID that you want to add a link to, and then choose the Links tab. Note Choose the link. Do not select the check box. 6. Choose the Links tab, and then choose Associate link. 7. Choose the check box for the link that you want to disassociate from a device. 8. Choose Disassociate link. Disassociation occurs immediately. Associate or disassociate an on-premises link using AWS Network Manager Associate or disassociate an on-premises device link association in your AWS
tgwnm-019	tgwnm.pdf	19	networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the link for the device ID that you want to add a link to, and then choose the Links tab. Note Choose the link. Do not select the check box. 6. Choose the Links tab, and then choose Associate link. 7. Choose the check box for the link that you want to disassociate from a device. 8. Choose Disassociate link. Disassociation occurs immediately. Associate or disassociate an on-premises link using AWS Network Manager Associate or disassociate an on-premises device link association in your AWS global network. View device details 51 AWS Network Manager AWS Global Networks for Transit Gateways User Guide You can only associate one link with a customer gateway. If a link is already associated with a customer gateway, and you want to use that link with another gateway, you must ﬁrst disassociate the link the gateway it's currently associated with. To create an on-premises association 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the link for the device ID that you want to create an on-premises association for. 6. Choose the On-premises associations tab. 7. Choose Associate. 8. Choose the on-premises Customer gateway. 9. (Optional) Choose the Link used for the connection. 10. Choose Create on-premises association. The link is available to use immediately. To disassociate an on-premises association 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the device ID link. 6. Choose the On-premises association tab. 7. Choose the check box for the on-premises association that you want to disassociate. 8. Choose Disassociate. Disassociation occurs immediately. View device details 52 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Associate or disassociate a Connect peer using AWS Network Manager Associate or disassociate a Connect peer device link association in your AWS global network. You can only associate one link with a Connect peer. If a link is already associated with a Connect peer, and you want to use that link with another Connect peer, you must ﬁrst disassociate the link the Connect peer it's associated with. To create a Connect peer association 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the link for the device ID that you want to create an on-premises association for. 6. Choose the Connect peer tab. 7. Choose Associate. 8. Choose the on-premises Connect peer. 9. (Optional) Choose the Link used for the connection. 10. Choose Create Connect peer association. The link is available to use immediately. To disassociate a Connect peer association 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the device ID link. 6. Choose the Connect peer tab. 7. Choose the check box for the Connect peer that you want to disassociate. View device details 53 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 8. Choose Disassociate. Disassociation occurs immediately. View VPNs using AWS Network Manager The VPNs page displays a list of your VPN connections for a device. To view device VPN connections 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the device that you want to view the VPN connections for. 6. Choose VPNs. Monitor devices using AWS Network Manager Monitor device Amazon CloudWatch events on the Network Manager Monitoring page. To monitor devices 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices. 5. Choose the Monitoring tab. 6. The Monitoring page displays data for the following: • Data In • Data Out • Tunnel down count Average View device details 54 AWS Network Manager AWS Global Networks for Transit Gateways User Guide (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add
tgwnm-020	tgwnm.pdf	20	4. In the navigation pane, choose Devices. 5. Choose the Monitoring tab. 6. The Monitoring page displays data for the following: • Data In • Data Out • Tunnel down count Average View device details 54 AWS Network Manager AWS Global Networks for Transit Gateways User Guide (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Connections in AWS Global Networks for Transit Gateways Create a connection between two devices in your global network using AWS Network Manager. The connection can be between a physical or virtual appliance and a third-party appliance in a VPC, or between physical appliances in an on-premises network. To create a connection the device must ﬁrst be added to your global network. For the steps to add a device, see the section called “Add a device”. You can also use an optional link to create the connection. For the steps to create a link, see the section called “Add a link”. A connection is created for a speciﬁc global network and cannot be shared with other global networks. Tasks • Create a connection using AWS Network Manager • Update a connection using AWS Network Manager • Delete a connection using AWS Network Manager Create a connection using AWS Network Manager Create a connection between two existing devices in your global network. Connections 55 AWS Network Manager To create a connection AWS Global Networks for Transit Gateways User Guide 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices, and choose the ID of the device. 5. Choose Connections, and then choose Create connection. 6. 7. 8. 9. For Name and Description, enter a name and description for the connection. (Optional) For Link, choose a link to associate with the ﬁrst device in the connection. For Connected device, choose the ID of the second device in the connection. (Optional) For Connected link, choose a link to associate with the second device in the connection. 10. Choose Create connection. To create a connection using the AWS CLI Use the create-connection command. Update a connection using AWS Network Manager You can update the information for an existing connection. To update a connection 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices, and select the device. 5. Choose Connections, and select the connection. 6. Choose Edit. 7. Update the connection details as needed, and then choose Edit connection. To update a connection using the AWS CLI Update a connection 56 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Use the update-connection command. Delete a connection using AWS Network Manager If you no longer need a connection, you can delete it. To delete a connection 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices, and select the device. 5. Choose Connections, and select the connection. 6. Choose Delete. 7. When prompted for conﬁrmation, choose Delete. To delete a connection using the AWS CLI Use the delete-connection command. Gateway associations in AWS Global Networks for Transit Gateways Create a customer gateway association with either a device or with a transit gateway Connect peer. Customer gateway associations To add your on-premises network to your global network, you associate a customer gateway with your device, and optionally, a link. The customer gateway must already be in your global network as part of a VPN attachment in your transit gateway. If you specify a link, it must already be associated with the speciﬁed device. For more information about creating a customer gateway, see Create a Customer Gateway in the AWS Site-to-Site VPN User Guide. For more information about creating a VPN attachment to a transit gateway, see Transit Gateway VPN Attachments in Amazon VPC Transit Gateways. Delete a connection 57 AWS Network Manager AWS Global Networks for Transit Gateways User Guide For more information about viewing the topology of your on-premises network in Network Manager, see the section
tgwnm-021	tgwnm.pdf	21	global network as part of a VPN attachment in your transit gateway. If you specify a link, it must already be associated with the speciﬁed device. For more information about creating a customer gateway, see Create a Customer Gateway in the AWS Site-to-Site VPN User Guide. For more information about creating a VPN attachment to a transit gateway, see Transit Gateway VPN Attachments in Amazon VPC Transit Gateways. Delete a connection 57 AWS Network Manager AWS Global Networks for Transit Gateways User Guide For more information about viewing the topology of your on-premises network in Network Manager, see the section called “Access transit gateway network dashboards” />. Transit Gateway Connect peer associations You can associate a Connect peer (in a transit gateway Connect attachment) with a device, and optionally, with a link. If you specify a link, it must be associated with the speciﬁed device. Topics • Associate a customer gateway using AWS Network Manager • Disassociate a customer gateway using AWS Network Manager • Add a Connect peer association using AWS Network Manager • Disassociate a Connect peer using AWS Network Manager Associate a customer gateway using AWS Network Manager You can associate a customer gateway with a device and link using the Network Manager console on either of the following pages: • On the Transit gateways page • On the Devices page Transit gateways page To associate a customer gateway using the Transit gateways page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Transit gateways, and then choose the ID of your transit gateway. 5. Choose On-premises associations. Transit Gateway Connect peer associations 58 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 6. 7. Select your customer gateway and choose Associate. For Device, select the ID of the device to associate. For Link, select the ID of the link to associate. 8. Choose Edit on-premises association. Devices page To associate a customer gateway using the Devices page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices, and then choose the ID of your device. 5. Choose On-premises associations. 6. Choose Associate. 7. For Customer gateway, select the ID of the customer gateway to associate. For Link, select the ID of the link to associate. 8. Choose Create on-premises association. Create a customer gateway association using the AWS CLI You can view and create a customer gateway association using the following commands. • To associate a customer gateway with a device and link: associate-customer-gateway • To view your customer gateway associations: get-customer-gateway-associations Disassociate a customer gateway using AWS Network Manager You can disassociate a customer gateway from a device or link using the Network Manager console on either of the following pages: • On the Transit gateways page • On the Devices page Disassociate a customer gateway association from a device 59 AWS Network Manager Transit gateways page AWS Global Networks for Transit Gateways User Guide To disassociate a customer gateway using the Transit gateways page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Transit gateways, and then choose On-premises associations. 5. Select your customer gateway and choose Disassociate. Devices page To disassociate a customer gateway using the Devices page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices, and then choose the ID of your device. 5. Choose On-premises associations. 6. Select your customer gateway and choose Disassociate. Disassociate a customer gateway association using the AWS CLI You can view and disassociate a customer gateway association using the following command. • To view your customer gateway associations: get-customer-gateway-associations • To disassociate a customer gateway from a device and link: disassociate-customer-gateway Add a Connect peer association using AWS Network Manager Create a transit gateway Connect peer association using the Network Manager console on either of the following pages: Add a Connect peer association 60 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • On the Transit gateways page • On the Devices page Transit gateways page To associate a Connect peer using the Transit gateways page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Transit gateways, and then choose the ID of your
tgwnm-022	tgwnm.pdf	22	Create a transit gateway Connect peer association using the Network Manager console on either of the following pages: Add a Connect peer association 60 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • On the Transit gateways page • On the Devices page Transit gateways page To associate a Connect peer using the Transit gateways page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Transit gateways, and then choose the ID of your transit gateway. 5. Choose Connect peer associations. 6. 7. Select the Connect peer and choose Edit. For Device, select the ID of the device to associate. For Link, select the ID of the link to associate. 8. Choose Edit Connect peer association. Devices page To associate a Connect peer using the Devices page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices, and choose the ID of the device. 5. Choose Connect peer associations. 6. Choose Associate. 7. 8. For Connect peer, choose the Connect peer. (Optional) For Link, choose the link for the Connect peer association. 9. Choose Create Connect peer association. Add a Connect peer association 61 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Working with Connect peer associations using the AWS CLI You can view and create Connect peer associations using the following commands. • To associate a Connect peer with a device: associate-transit-gateway-connect-peer • To view your Connect peer associations: get-transit-gateway-connect-peer-associations Disassociate a Connect peer using AWS Network Manager You can disassociate a Connect peer from a device in one of the following ways: • On the Transit gateways page • On the Devices page Transit gateways page To disassociate a Connect peer using the Transit gateways page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Transit gateways, and then choose Connect peer associations. 5. Select the Connect peer and choose Disassociate. Devices page To disassociate a Connect peer using the Devices page 1. Access the Network Manager console at https://console.aws.amazon.com/ networkmanager/home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Devices, and then choose the ID of your device. 5. Choose Connect peer associations. Disassociate a Connect peer from a device 62 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 6. Select the Connect peer and choose Disassociate. Working with Connect peer associations using the AWS CLI You can view and disassociate Connect peer associations using the following commands. • To view your Connect peer associations: get-transit-gateway-connect-peer-associations • To disassociate a Connect peer from a device: disassociate-transit-gateway-connect-peer Resource tags in AWS Global Networks for Transit Gateways A tag is a metadata label that either you or AWS assigns to an AWS resource. Each tag consists of a key and a value. For tags that you assign, you deﬁne the key and the value. For example, you might deﬁne the key as purpose and the value as test for one resource. Tags help you do the following: • Identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from diﬀerent services to indicate that the resources are related. • Control access to your AWS resources. For more information, see Controlling access to AWS resources using tags in the IAM User Guide. Supported resources The following global networks resources support tagging: • Global networks • Devices • Sites • Links Tagging restrictions The following basic restrictions apply to tags on global networks resources: • Maximum number of tags that you can assign to a resource: 200 Resource tags 63 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • Maximum key length: 128 Unicode characters • Maximum value length: 256 Unicode characters • Valid characters for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ • Keys and values are case sensitive • You cannot use aws: as a preﬁx for keys; it's reserved for AWS use Tagging restrictions 64 AWS Network Manager AWS Global Networks for Transit Gateways User Guide AWS Global Networks for Transit Gateways dashboards The AWS Network Manager console uses dashboard visualizations to help you view and monitor all aspects of your transit gateway networks and transit gateways. Some of the dashboards include: • World maps that pinpoint where your network
tgwnm-023	tgwnm.pdf	23	key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ • Keys and values are case sensitive • You cannot use aws: as a preﬁx for keys; it's reserved for AWS use Tagging restrictions 64 AWS Network Manager AWS Global Networks for Transit Gateways User Guide AWS Global Networks for Transit Gateways dashboards The AWS Network Manager console uses dashboard visualizations to help you view and monitor all aspects of your transit gateway networks and transit gateways. Some of the dashboards include: • World maps that pinpoint where your network resources, such as edge locations, devices, and attachments, are located. • Monitoring that uses CloudWatch to track 15-months' worth of statistics, giving you a better perspective on how your networks are performing. • Event tracking that streams real-time events to an events dashboard. • Topological and logical diagrams of your transit gateway networks and transit gateways. There are separate dashboards for your transit gateway networks and transit gateways. Topics • Access transit gateway network dashboards using AWS Network Manager • Access transit gateway dashboards using AWS Network Manager Access transit gateway network dashboards using AWS Network Manager he AWS Network Manager console provides a group of dashboards for AWS Global Networks for Transit Gateways, allowing you to view and monitor your network of transit gateways. Dashboards include information about network resources, their geographic locations, the network topology, and the logical network associations. If you want to view the dashboards for a speciﬁc transit gateway, see the section called “Access transit gateway dashboards”. Topics • Overview • Geography • Topology tree • Events • Monitoring Access transit gateway network dashboards 65 AWS Network Manager • Route analyzer Overview AWS Global Networks for Transit Gateways User Guide The Overview page displays details about your transit gateway network, the VPN status, the Connect peer status, and any network events aﬀecting your transit gateways. To access transit gateway network details 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway network. The Overview page opens by default, showing information about your transit gateways. 6. On the Overview page you contains the following information: • Your transit gateway network Inventory: IconDescription Transit gateways The total number of registered transit gateways in your global network. Choose the link to open the Transit gateways page to view more information about your transit gateways. Sites The total number of sites associated with your transit gateways. Choose the link to open the Sites page to view more information about your transit gateway sites. Devices The total number of devices associated with your transit gateways. Choose the link to open the Devices page to view more information about your transit gateway devices. Overview 66 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • The Transit gateways VPN status. The following is displayed: • ID – The ID of the transit gateway. Choose the link to open details about the transit gateway. • Name – Name of the transit gateway. • Region – Region where the transit gateway is located • Down VPN – The percentage of your total transit gateway VPNs that are down. • Impaired VPN –The percentage of your total VPNs that are impaired. • Up VPN – The percentage of your total VPNs that are up. • The Transit gateways connect peer status. The following is displayed: • ID – The ID of the transit gateway. • Name – Name of the transit gateway. • Region – Region where the transit peer is located • Down Connect peer – The percentage of your total transit gateway Connect peers that are down. • Impaired Connect peer – The percentage of your total transit gateway Connect peers that are impaired. • Up VPN – The percentage of your total transit gateway Connect peers that are up. • The Network events summary displays CloudWatch Events number of core network attachments per edge, shown as a stacked column chart. (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Overview 67 AWS Network Manager Geography AWS Global Networks for Transit Gateways User
tgwnm-024	tgwnm.pdf	24	event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Overview 67 AWS Network Manager Geography AWS Global Networks for Transit Gateways User Guide The Geography page displays a world map showing the locations of your transit gateway network. To access a geographic map of your transit gateways 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway network. The Overview page opens by default, showing information about your transit gateways. 6. Choose the Geography tab. A world map displays, showing you the locations of the following: • AWS TGWs and VPCs. • The Connectivity of VPNs, Direct Connects, and Connect peers. • On-premises Sites and Devices. • Not associated Sites and Devices. 7. In the following example, there are four AWS Regions, us-west-1 us-west-2, us-east-1, and us- east-2. Each Region is labeled and represented by a number, indicating the number of transit gateways in that Region. For example, us-east-2 is represented by the number 3, indicating that there are three network resources associated with the us-west-2 Region. Geography 68 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 8. If your account is a delegated administrator in a multi-account environment, you can view details about the transit gateways for diﬀerent accounts. 9. Choose the number representing a Region. For example, choose 3. The following information displays: • The right pane shows the AWS Region, us-east-2. • A bottom panel shows with a Transit Gateways dropdown list option, displaying each transit gateway in that Region. In this example, there are 3 transit gateways in us-east-2. Choose a transit gateway from the dropdown list to view details about that transit gateway. In this example, you can see that the Resource Account ID for this transit gateway is another account in the multi-account environment, 98765432101. Geography 69 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 10. To view more details about the transit gateway, choose the ID link to open the Transit gateway details page for the gateway. If your global network is part of a multi-account environment, you can choose an ID from a member account and view details about that attachment. The Resource Account ID column displays the account ID that the transit gateway belongs to. Viewing details about a member's resources prompts you to use the Network Manager console to switch roles to the member account where the resource is located. Note Switching roles logs you out of the current account and into the member account associated with the attachment. Switch global networks console roles to view resource details To view resource details in a member account 1. When choosing a link to a member account, you're prompted to switch console roles: Geography 70 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 2. The following values populate the Switch Role screen. Keep the following values: • Account — The account ID for the member account that the resource is associated with. • Role — IAMRoleForAWSNetworkManagerCrossAccountResourceAccess is the required IAM role for accessing resources across multiple accounts. 3. Choose Switch Role. You're logged out of your current account and into that member account. A new tab opens showing the details of the resource. For example, if you choose a VPC resource, the VPC resource page opens for the member account that owns the resource. 4. Depending on the delegated permission level assigned to the delegated administrators and the management account when trusted access was enabled, you can either view information (read-only permission) about the resource or add/modify (administrator permission) the resource. 5. To return to the original member account, choose one of the following: • On your current tab, choose the browser Back button. On the Switch Role login screen, enter the Account ID of the account you want, and then choose Switch Role. Geography 71 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • If you haven't closed it, choose the tab for the account you've just logged out of, and then choose Reload. Topology tree The Topology tree page shows a logical diagram of your transit gateway network. To access the topology tree for a transit gateway network 1. Access the Network Manager console at
tgwnm-025	tgwnm.pdf	25	one of the following: • On your current tab, choose the browser Back button. On the Switch Role login screen, enter the Account ID of the account you want, and then choose Switch Role. Geography 71 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • If you haven't closed it, choose the tab for the account you've just logged out of, and then choose Reload. Topology tree The Topology tree page shows a logical diagram of your transit gateway network. To access the topology tree for a transit gateway network 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway network. The Overview page opens by default, showing information about your transit gateways. 6. Choose the Topology tree tab. 7. By default, the Topology tree page displays all Sites, Devices, and Customer Gateways of your transit gateway and the logical relationships between them. You can ﬁlter the network tree to show speciﬁc resources types only to view information about the speciﬁc resource it represents. The line colors represent the state of the relationships between AWS and the on- premises resources. The following example shows the topology tree for two edge locations, us-west-1 and us- east-1. Topology tree 72 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 8. 9. In the Topology tree, choose an attachment. The attachment details display in the left pane. If your global network is part of a multi-account environment, you can choose a Resource ID from a member account and view details about that attachment. Viewing details about a member's resources prompts you to switch Network Manager console roles to the member account where the resource is located. Note Switching roles logs you out of the current account and into the delegated administrator account associated with the attachment. Topology tree 73 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Switch global networks console roles to view resource details To view resource details in a member account 1. When choosing a link to a member account, you're prompted to switch console roles: 2. The following values populate the Switch Role screen. Keep the following values: • Account — The account ID for the member account that the resource is associated with. • Role — IAMRoleForAWSNetworkManagerCrossAccountResourceAccess is the required IAM role for accessing resources across multiple accounts. 3. Choose Switch Role. You're logged out of your current account and into that member account. A new tab opens showing the details of the resource. For example, if you choose a VPC resource, the VPC resource page opens for the member account that owns the resource. 4. Depending on the delegated permission level assigned to the delegated administrators and the management account when trusted access was enabled, you can either view information (read-only permission) about the resource or add/modify (administrator permission) the resource. 5. To return to the original member account, choose one of the following: Topology tree 74 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • On your current tab, choose the browser Back button. On the Switch Role login screen, enter the Account ID of the account you want, and then choose Switch Role. • If you haven't closed it, choose the tab for the account you've just logged out of, and then choose Reload. Events Track your transit gateway events using Amazon EventBridge that delivers a near-real-time stream of system events that describe changes in your resources. Using simple rules that you can quickly set up, you can match events and route them to one or more target functions or streams. For more information, see the Amazon EventBridge User Guide. To access transit gateway network events 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway network. The Overview page opens by default, showing information about your transit gateways. 6. Choose the Events tab. The Events section updates with the events that occurred during the time frame. (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the
tgwnm-026	tgwnm.pdf	26	the time frame. (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Events 75 AWS Network Manager Monitoring AWS Global Networks for Transit Gateways User Guide You can monitor your transit gateways using Amazon CloudWatch which collects raw data and processes it into readable, near-real-time metrics. These statistics are kept for 15 months, so that you can access historical information and gain a better perspective on how your network is performing. You can also set alarms that watch for certain thresholds, and send notiﬁcations or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide. On the monitoring page you can view usage metrics for your transit gateways, ﬁltering by speciﬁc transit gateways. To access transit gateway network monitoring details 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway network. The Overview page opens by default, showing information about your transit gateways. 6. Choose the Monitoring tab. 7. Choose a transit gateway that you want to monitor. If you're using an account that's set up as a delegated administrator between accounts, you can choose a transit gateway from one of those other accounts. The transit gateway list displays the ID, the Region, and the account ID. 8. (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Monitoring 76 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. 9. The page updates the following transit gateway monitors: • Bytes in • Bytes out • Bytes dropped – black hole • Bytes dropped – no route • Packets in • Packets out • Packets dropped – black hole • Packets dropped – no route 10. (Optional) Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatchUser Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Route analyzer The Route Analyzer analyzes the routing path between a speciﬁed source and destination. Note Route Analyzer checks the routes on Transit Gateway route tables only Route analyzer 77 AWS Network Manager AWS Global Networks for Transit Gateways User Guide To analyze transit gateway routes 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway network. The Overview page opens by default, showing information about your transit gateways. 6. Choose the Route Analyzer tab. 7. In the Source section, • Choose the source Transit Gateway for the route that you want to analyze. If you're logged on to an account that's set up as a delegated administrator between accounts, you can choose a transit gateway from one of those other accounts. The transit gateway list displays the ID, the Region, and the account ID. • Choose the source Transit Gateway attachment for the route. • Enter either the IPv4 or IPv6 IP address. • Clear the Include return path in results check box if you don't want . This is chosen by default. • Choose if this is a Middlebox appliance. For more information on middlebox conﬁgurations, see Route analysis with a middlebox conﬁguration. 8. In the Destination section, • Choose the destination Transit Gateway. If you're logged on to an account that's set up as a delegated administrator between accounts, you can choose a transit gateway from one of those other accounts. The transit gateway list displays the ID, the Region, and
tgwnm-027	tgwnm.pdf	27	route. • Enter either the IPv4 or IPv6 IP address. • Clear the Include return path in results check box if you don't want . This is chosen by default. • Choose if this is a Middlebox appliance. For more information on middlebox conﬁgurations, see Route analysis with a middlebox conﬁguration. 8. In the Destination section, • Choose the destination Transit Gateway. If you're logged on to an account that's set up as a delegated administrator between accounts, you can choose a transit gateway from one of those other accounts. The transit gateway list displays the ID, the Region, and the account ID. • Choose the destination Transit Gateway attachment for the route. • Enter either the IPv4 or IPv6 IP address. 9. Choose Run route analysis. 10. The Results of route analysis return the Source and Destination transit gateways and the current Status. An error message is returned if no information is found in the transit gateway route table. For more information on route tables, see Transit gateway route tables. Route analyzer 78 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Access transit gateway dashboards using AWS Network Manager The AWS Network Manager console provides a group of dashboards for AWS Global Networks for Transit Gateways, allowing you to view and monitor your transit gateways. Dashboards include information about network resources, their geographic locations, the network topology, and the logical network associations. If you want to view the dashboards for all transit gateways in your global network, see the section called “Access transit gateway network dashboards”. Topics • Overview • Topology tree • Events • Monitoring • On-premises associations • Connect peer associations Overview To access the transit gateway resource inventory 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway networks. The Transit gateways page opens, showing a list of your transit gateways. 6. Choose the ID of the transit gateway you want to see more information about. 7. On the Overview page you can view the following information: • Your transit gateway details. • The transit gateway attachments, along with information about each of those attachments. Use the following legend to understand the icons on this page: Access transit gateway dashboards 79 AWS Network Manager AWS Global Networks for Transit Gateways User Guide IconDescription VPC The total number of VPC attachments in your transit gateway network. VPN The total number of VPN attachments in your transit gateway. Direct Connect Gateway The total number of Direct Connect gateways attached to your transit gateway. Connect The total number of Connect peer attachments in your transit gateway. Transit Gateway The total number of Transit Gateways. 8. The Details section shows information about your global network: the transit gateway ID, its Name, the Region where it's located, and the current State of the gateway. Note To see details about a diﬀerent transit gateway, choose the dropdown list and then choose the transit gateway. 9. The Transit Gateway attachment section displays details about your attachments: the Transit Gateway ID, the Resource ID, and the Resource Type. 10. The VPNs section displays details about your VPN attachments: the VPN ID, the Device using the VPN attachment, and any Link associated with the attachment. 11. The Connect peers section displays details about your Connect peer attachments: the name of the Connect peer and the Device using that Connect peer. 12. The Network events summary section shows the network events for that transit gateway. You must ﬁrst onboard to see network events. Choose Onboard CloudWatch Insights to enable viewing network events. Overview 80 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 13. (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Topology tree The Topology tree page shows a logical diagram of your transit gateways. To view a transit gateway topology tree 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway networks. The Transit gateways page opens, showing a list of your transit gateways. 6. Choose
tgwnm-028	tgwnm.pdf	28	Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Topology tree The Topology tree page shows a logical diagram of your transit gateways. To view a transit gateway topology tree 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway networks. The Transit gateways page opens, showing a list of your transit gateways. 6. Choose the ID of the transit gateway you want to see more information about. 7. Choose the Topology tree tab. 8. By default, the Topology tree page displays all Sites, Devices, and Customer Gateways of your transit gateway and the logical relationships between them. You can ﬁlter the network tree to show speciﬁc resources types only to view information about the speciﬁc resource it represents. The line colors represent the state of the relationships between AWS and the on- premises resources. 9. In the Topology tree, choose a resource. The resource details display in the right pane. 10. If your global network is part of a multi-account environment, you can choose a Resource ID from a member account and view details about that attachment. Topology tree 81 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Viewing details about a member's resources prompts you to switch Network Manager console roles to the member account where the resource is located. Note Switching roles logs you out of the current account and into the delegated administrator account associated with the attachment. Switch global networks console roles to view resource details To view resource details in a member account 1. When choosing a link to a member account, you're prompted to switch console roles: 2. The following values populate the Switch Role screen. Keep the following values: • Account — The account ID for the member account that the resource is associated with. • Role — IAMRoleForAWSNetworkManagerCrossAccountResourceAccess is the required IAM role for accessing resources across multiple accounts. Topology tree 82 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 3. Choose Switch Role. You're logged out of your current account and into that member account. A new tab opens showing the details of the resource. For example, if you choose a VPC resource, the VPC resource page opens for the member account that owns the resource. 4. Depending on the delegated permission level assigned to the delegated administrators and the management account when trusted access was enabled, you can either view information (read-only permission) about the resource or add/modify (administrator permission) the resource. 5. To return to the original member account, choose one of the following: • On your current tab, choose the browser Back button. On the Switch Role login screen, enter the Account ID of the account you want, and then choose Switch Role. • If you haven't closed it, choose the tab for the account you've just logged out of, and then choose Reload. Events Track your transit gateway events using Amazon EventBridge that delivers a near-real-time stream of system events that describe changes in your resources. Using simple rules that you can quickly set up, you can match events and route them to one or more target functions or streams. For more information, see the Amazon EventBridge User Guide. To track transit gateway events 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway network. The Overview page opens by default, showing information about your transit gateways. 6. Choose the Events tab. The Events section updates with the events that occurred during the time frame. Events 83 AWS Network Manager AWS Global Networks for Transit Gateways User Guide (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Monitoring You can monitor your transit gateways using Amazon CloudWatch, which collects raw data and processes it into readable, near-real-time metrics. These statistics are kept for 15 months, so that you can access historical information and gain a better perspective on
tgwnm-029	tgwnm.pdf	29	in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Monitoring You can monitor your transit gateways using Amazon CloudWatch, which collects raw data and processes it into readable, near-real-time metrics. These statistics are kept for 15 months, so that you can access historical information and gain a better perspective on how your network is performing. You can also set alarms that watch for certain thresholds, and send notiﬁcations or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide. On the monitoring page you can view usage metrics for your transit gateways, ﬁltering by speciﬁc transit gateways. To view transit monitoring details 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway networks. The Transit gateways page opens, showing a list of your transit gateways. 6. Choose the ID of the transit gateway you want to see more information about. 7. Choose the Monitoring tab. Monitoring 84 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 8. If you want to choose a diﬀerent transit gateway to monitor, choose that transit gateway from the list. 9. (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. 10. The page updates the following transit gateway monitors: • Bytes in • Bytes out • Bytes dropped – black hole • Bytes dropped – no route • Packets in • Packets out • Packets dropped – black hole • Packets dropped – no route 11. (Optional) Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatchUser Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Monitoring 85 AWS Network Manager AWS Global Networks for Transit Gateways User Guide On-premises associations The On-premises page displays information about your on-premises devices for this transit gateway. On this page you can associate or disassociate any of your devices.. To view on-premises associations 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway networks. The Transit gateways page opens, showing a list of your transit gateways. 6. Choose the ID of the transit gateway you want to see more information about. 7. Choose the On-premises associations tab. 8. The Transit Gateway on-premises association page displays the Customer gateway, Device, Link, and State of the transit gateway. To associate a device 1. Choose the Customer gateway you want to associate a device with. 2. Choose Associate. 3. On the Edit on-premises association page, choose the Device and optional Link for the association. 4. Choose Edit on-premises association. To disassociate an on-premises device 1. Choose the Customer gateway you want to disassociate. 2. Choose Disassociate. Connect peer associations The Connect peer associations page displays information about your Connect peers for this transit gateway. You can also disassociate any of your devices. On-premises associations 86 AWS Network Manager AWS Global Networks for Transit Gateways User Guide To access Connect peer associations 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway networks. The Transit gateways page opens, showing a list of your transit gateways. 6. Choose the ID of the transit gateway you want to see more information about. 7. Choose the Connect peer associations tab. 8. The Connect peer associations page displays the Connect peer, Device, Link, and State of the transit gateway. To disassociate a Connect peer device 1. Choose the Connect peer you want to disassociate. 2. Choose Disassociate. Connect peer associations 87
tgwnm-030	tgwnm.pdf	30	Under Connectivity choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway networks. The Transit gateways page opens, showing a list of your transit gateways. 6. Choose the ID of the transit gateway you want to see more information about. 7. Choose the Connect peer associations tab. 8. The Connect peer associations page displays the Connect peer, Device, Link, and State of the transit gateway. To disassociate a Connect peer device 1. Choose the Connect peer you want to disassociate. 2. Choose Disassociate. Connect peer associations 87 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Route Analyzer for AWS Network Manager With AWS Global Networks for Transit Gateways, you can use the Route Analyzer to perform an analysis of the routes in your transit gateway route tables. Through AWS Network Manager, Route Analyzer analyzes the routing path between a speciﬁed source and destination, and returns information about the connectivity between components. You can use the Route Analyzer to do the following: • Verify that the transit gateway route table conﬁguration will work as expected before you start sending traﬃc. • Validate your existing route conﬁguration. • Diagnose route-related issues that are causing traﬃc disruption in your global network. Note Route Analyzer does not work with intra-Region peering. Topics • Route Analyzer basics • Perform a route analysis • Example: Route analysis for peered transit gateways • Example: Route analysis with a middlebox conﬁguration Route Analyzer basics To use the Route Analyzer, you indicate the path for the traﬃc from a source to a destination. For the source, you specify the transit gateway, the transit gateway attachment from which the traﬃc originates, and a source IPv4 or IPv6 address. The Route Analyzer analyzes the routes in the associated transit gateway route table for the transit gateway attachment. For the destination, you specify a target IPv4 or IPv6 address, and the destination transit gateway and transit gateway attachment. If you've conﬁgured a middlebox appliance in your VPC, you can indicate the location of the appliance in the route analysis. This enables you to specify multiple network hops in a route Route Analyzer basics 88 AWS Network Manager AWS Global Networks for Transit Gateways User Guide between a source and destination, to help you analyze the route of the traﬃc. We store this information for use in future analyses. You can update your middlebox appliances later on as needed. You can also analyze the return path for traﬃc from the speciﬁed destination back to the source. The following rules apply when using the Route Analyzer: • The Route Analyzer analyzes routes in transit gateway route tables only. It does not analyze routes in VPC route tables or in your customer gateway devices. • The transit gateways must be registered in your global network. • The Route Analyzer does not analyze security group rules or network ACL rules. To capture information about accepted and rejected IP traﬃc in your VPC, you can use VPC ﬂow logs. • The Route Analyzer only returns information for the return path if it can successfully return information for the forward path. Perform a route analysis Perform a route analysis of your AWS global network. You can only use Route Analyzer using the AWS Global Networks for Transit Gateways console. To analyze your routes 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. 5. In the navigation pane, choose Transit Gateway network. The Overview page opens by default, showing information about your transit gateways. 6. Choose the Route Analyzer tab. 7. Under Source, do the following: • Choose the transit gateway and the transit gateway attachment. • For IP address, enter a source IPv4 or IPv6 address. 8. Under Destination, do the following: • Choose the transit gateway and the transit gateway attachment. Perform a route analysis 89 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • For IP address, enter a target IPv4 or IPv6 address. 9. (Optional) To analyze the return path, ensure that you enable Include return path in results. If enabled, you must specify an IP address under Source. 10. To specify middlebox appliances in the routing path, choose Middlebox appliance?. We store this information for use in future analyses. You can update your middlebox appliances later on as needed. 11. Choose Run route analysis. 12. The results are displayed under Results of route analysis. If you speciﬁed Middlebox appliance?, choose Yes or No for each of the attachments to indicate the location of the appliances and to complete the route analysis. You can choose the ID of any of the resources in the path to view more
tgwnm-031	tgwnm.pdf	31	results. If enabled, you must specify an IP address under Source. 10. To specify middlebox appliances in the routing path, choose Middlebox appliance?. We store this information for use in future analyses. You can update your middlebox appliances later on as needed. 11. Choose Run route analysis. 12. The results are displayed under Results of route analysis. If you speciﬁed Middlebox appliance?, choose Yes or No for each of the attachments to indicate the location of the appliances and to complete the route analysis. You can choose the ID of any of the resources in the path to view more information about the resources. Example: Route analysis for peered transit gateways In the following example, transit gateway 1 has two VPC attachments, and a peering attachment to transit gateway 2. Transit gateway 2 has a Site-to-Site VPN attachment to your on-premises network. You want to use the Route Analyzer to ensure that the VPCs and Site-to-Site VPN connections can route traﬃc to each other through the transit gateways. In the Route Analyzer, do the following: 1. Under Source, specify transit gateway 1 and the transit gateway attachment for VPC A. Specify an IP address from the CIDR block of VPC A, for example, 10.0.0.7. 2. Under Destination, specify transit gateway 2 and the VPN attachment. Specify an IP address from the range of the on-premises network, for example, 172.31.0.8. 3. Ensure that Include return path in results is selected. Example: Route analysis for peered transit gateways 90 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 4. Run the route analysis. In the results, verify the path between the source and destination. For example, the following results indicate that there is a forward path from transit gateway 1 to transit gateway 2, but no return path. Check the route table for transit gateway 2, and ensure that there is a static route that points to the peering attachment. 5. To run the analysis between VPC B and the VPN connection, modify the information under Source. Choose the transit gateway attachment for VPC B, and specify an IP address from the CIDR block of VPC B, for example, 10.2.0.9. 6. Reload the results and verify the path between the source and destination. For more information about the routing conﬁguration for this scenario, see the transit gateway peering example. Example: Route analysis with a middlebox conﬁguration If you've conﬁgured a VPC to act as a middlebox appliance for inspecting traﬃc that ﬂows to other parts of your network, you can indicate the location of the appliance in the route analysis. In the following example, the transit gateway has two VPC attachments and a VPN attachment. VPC A runs a ﬁrewall appliance (middlebox) that inspects the traﬃc that ﬂows between the VPN connection and VPC B. Example: Route analysis with a middlebox conﬁguration 91 AWS Network Manager AWS Global Networks for Transit Gateways User Guide In the Route Analyzer, you can specify the location of the middlebox appliance as follows: 1. Under Source, specify the transit gateway and the VPN attachment. Specify an IP address from the range of the on-premises network, for example, 10.0.0.7. 2. Under Destination, specify the transit gateway and the attachment for VPC B. Specify an IP address from the CIDR block of VPC B, for example, 172.31.0.8. 3. For Middlebox appliance?, choose Include. 4. Run the route analysis. 5. For the Middlebox appliance? sections for the transit gateway attachment for VPC A, choose Yes. You can choose the ID of any resource in the path to view more information about that resource. Example: Route analysis with a middlebox conﬁguration 92 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Example: Route analysis with a middlebox conﬁguration 93 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Amazon CloudWatch metrics and events AWS provides the following monitoring tools to watch the resources in your global network, report when something is wrong, and take automatic actions when appropriate. • Amazon CloudWatch monitors your AWS resources and the applications that you run on AWS in real time. You can collect and track metrics, create customized dashboards, and set alarms that notify you or take actions when a speciﬁed metric reaches a threshold that you specify. For more information, see the Amazon CloudWatch User Guide. • Amazon EventBridge delivers a near-real-time stream of system events that describe changes in AWS resources. EventBridge enables automated event-driven computing, as you can write rules that watch for certain events and trigger automated actions in other AWS services when these events happen. For more information, see the Amazon EventBridge User Guide. • AWS CloudTrail provides a record of actions taken by a user, role, or an AWS services in your global network, capturing all API calls for global network events.
tgwnm-032	tgwnm.pdf	32	when a speciﬁed metric reaches a threshold that you specify. For more information, see the Amazon CloudWatch User Guide. • Amazon EventBridge delivers a near-real-time stream of system events that describe changes in AWS resources. EventBridge enables automated event-driven computing, as you can write rules that watch for certain events and trigger automated actions in other AWS services when these events happen. For more information, see the Amazon EventBridge User Guide. • AWS CloudTrail provides a record of actions taken by a user, role, or an AWS services in your global network, capturing all API calls for global network events. Topics • Monitor your global network with Amazon CloudWatch metrics • Monitor your global network using EventBridge • Log AWS Global Networks for Transit Gateways API calls using AWS CloudTrail Monitor your global network with Amazon CloudWatch metrics You can monitor AWS Global Networks for Transit Gateways using Amazon CloudWatch, which collects raw data and processes it into readable, near-real-time metrics. These statistics are kept for 15 months, so that you can access historical information and gain a better perspective on how your web application or service is performing. You can also set alarms that watch for certain thresholds, and send notiﬁcations or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide. You can view CloudWatch metrics in your global network for your registered transited gateways, your associated Site-to-Site VPN connections, and your on-premises resources. You can view metrics per transit gateway and per transit gateway attachment, per global network. For more information about the supported metrics, see the following topics: Monitor with CloudWatch metrics 94 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • CloudWatch metrics for your transit gateways • Monitor VPN tunnels using Amazon CloudWatch • View CloudWatch metrics for on-premises resources For examples of creating alarms, see Creating Amazon CloudWatch Alarms in the Amazon CloudWatch User Guide. View CloudWatch metrics for on-premises resources AWS Global Networks for Transit Gateways publishes data points to Amazon CloudWatch for your on-premises resources, including devices and links. CloudWatch enables you to retrieve statistics about those data points as an ordered set of time series data, known as metrics. Each data point has an associated timestamp and an optional unit of measurement. You can use metrics to verify that your system is performing as expected. For example, you can create a CloudWatch alarm to monitor a speciﬁed metric and initiate an action (such as sending a notiﬁcation to an email address) if the metric goes outside what you consider an acceptable range. Device metrics The AWS/NetworkManager namespace includes the following metrics for devices. Metric DataIn DataOut TunnelDownCount Description The number of bytes received by the device. The number of bytes sent by the device. The number of VPN tunnels on the device that have a DOWN status. Static VPN tunnels with a DOWN status, and BGP VPN tunnels with any state other than ESTABLISHED, are included in the count. Metric dimensions for devices To ﬁlter the metrics for your devices, use the following dimensions. View CloudWatch metrics for on-premises resources 95 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Dimension DeviceId Link metrics Description Filters the metric data by the device. The AWS/NetworkManager namespace includes the following metrics for links. Metric DataIn DataOut Description The number of bytes received by the on- premises network using this link. The number of bytes sent from the on-premis es network using this link. Metric dimensions for links To ﬁlter the metrics for your links, use the following dimensions. Dimension LinkId Description Filters the metric data by the link. View global network CloudWatch metrics There are various options for viewing CloudWatch metrics for your global network, including the following: • Viewing metrics for the global network and ﬁltering by transit gateway • Viewing metrics for a speciﬁc transit gateway and its attachments To view metrics for your global network and ﬁlter by transit gateway 1. Open the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. View global network CloudWatch metrics 96 AWS Network Manager AWS Global Networks for Transit Gateways User Guide 2. 3. In the navigation pane, choose Global networks, and choose the ID for your global network. In the navigation pane, choose Transit gateway network. 4. Choose Monitoring. On this page, you can ﬁlter by transit gateway to view metrics for that transit gateway. To view metrics for a speciﬁc transit gateway and its attachments 1. Open the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. 3. 4. In the navigation pane, choose Global networks, and choose the ID for your global network. In the navigation pane, choose Transit gateways, and choose the ID for your transit gateway. (Optional) Metrics and events use the default time set up in the CloudWatch Events event.
tgwnm-033	tgwnm.pdf	33	ID for your global network. In the navigation pane, choose Transit gateway network. 4. Choose Monitoring. On this page, you can ﬁlter by transit gateway to view metrics for that transit gateway. To view metrics for a speciﬁc transit gateway and its attachments 1. Open the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. 3. 4. In the navigation pane, choose Global networks, and choose the ID for your global network. In the navigation pane, choose Transit gateways, and choose the ID for your transit gateway. (Optional) Metrics and events use the default time set up in the CloudWatch Events event. To set a custom time frame, choose Custom and then choose a Relative or Absolute time, and then choose if you want to see that date range in UTC or the edge location's Local time zone. Choose Add to dashboard to add this metric to your CloudWatch dashboard. For more information about using CloudWatch dashboards, see Using Amazon CloudWatch Dashboards in the Amazon CloudWatch User Guide. Note The Add to dashboard option only works if your registered transit gateway is in the US West (Oregon) Region. Monitor your global network using EventBridge Amazon EventBridge delivers a near-real-time stream of system events that describe changes in your resources. Using simple rules that you can quickly set up, you can match events and route them to one or more target functions or streams. For more information, see the Amazon EventBridge User Guide. AWS Global Networks for Transit Gateways sends the following types of events to EventBridge: • Topology change events • Routing update events Monitor with EventBridge 97 AWS Network Manager • Status update events Get started AWS Global Networks for Transit Gateways User Guide Before you can view events for your global network, you must onboard to CloudWatch Logs Insights. In the global networks console, choose the ID of your global network. In the Network events summary section, choose Onboard to CloudWatch Log Insights. An IAM principal in your account, such as an IAM user, must have suﬃcient permissions to onboard to CloudWatch Logs Insights. Ensure that the IAM policy contains the following permissions. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "events:PutTargets", "events:DescribeRule", "logs:PutResourcePolicy", "logs:DescribeLogGroups", "logs:DescribeResourcePolicies", "events:PutRule", "logs:CreateLogGroup" ], "Resource": "*" } ] } The preceding policy does not grant permission to create, modify, or delete Network Manager resources. For more information about IAM policies for working with Network Manager, see Identity and access management for AWS Global Networks for Transit Gateways. When you onboard to CloudWatch Logs Insights, the following occurs: • A CloudWatch event rule with the name DON_NOT_DELETE_networkmanager_rule is created in the US West (Oregon) Region. • A CloudWatch Logs log group with the name /aws/events/networkmanagerloggroup is created in the US West (Oregon) Region. Get started 98 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • The CloudWatch event rule is conﬁgured with the CloudWatch Logs log group as a target. • A CloudWatch resource policy with the name DO_NOT_DELETE_networkmanager_TrustEventsToStoreLogEvents is created in the US West (Oregon) Region. To view this policy, use the following AWS CLI command: aws logs describe-resource-policies --region us-west-2 View transit gateway events using the AWS Transit Gateway console You can view events for your global network or view a speciﬁc transit gateway using the global networks console. To view global network events 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Transit gateway network. 5. Choose Events. On this page you can view events for your transit gateway network. For more information about this page, see the section called “Events”. To view events for a speciﬁc transit gateway 1. Access the Network Manager console at https://console.aws.amazon.com/networkmanager/ home/. 2. Under Connectivity, choose Global Networks. 3. On the Global networks page, choose the global network ID. 4. In the navigation pane, choose Transit gateways. 5. Choose the Transit gateway ID. 6. Choose Events. On this page you can view events for your transit gateway network. For more information about this page, see the section called “Events”. Get started 99 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Topology change events Topology change events occur when there have been changes to the resources in your global network. These include the following: Events • A transit gateway in the global network was deleted (TGW-DELETED) • A VPN connection was created for a transit gateway (VPN-CONNECTION-CREATED) • A VPN connection was deleted on a transit gateway (VPN-CONNECTION-DELETED) • The customer gateway for a VPN connection was changed (VPN-CONNECTION-CUSTOMER- GATEWAY-MODIFIED) • The target gateway for a VPN connection was changed (VPN-CONNECTION-TARGET-GATEWAY- MODIFIED) • A VPC was attached to a transit gateway (VPC-ATTACHMENT-CREATED) • A VPC attachment was
tgwnm-034	tgwnm.pdf	34	Transit Gateways User Guide Topology change events Topology change events occur when there have been changes to the resources in your global network. These include the following: Events • A transit gateway in the global network was deleted (TGW-DELETED) • A VPN connection was created for a transit gateway (VPN-CONNECTION-CREATED) • A VPN connection was deleted on a transit gateway (VPN-CONNECTION-DELETED) • The customer gateway for a VPN connection was changed (VPN-CONNECTION-CUSTOMER- GATEWAY-MODIFIED) • The target gateway for a VPN connection was changed (VPN-CONNECTION-TARGET-GATEWAY- MODIFIED) • A VPC was attached to a transit gateway (VPC-ATTACHMENT-CREATED) • A VPC attachment was deleted from a transit gateway (VPC-ATTACHMENT-DELETED) • An AWS Direct Connect gateway was attached to a transit gateway (DXGW-ATTACHMENT- CREATED) • An AWS Direct Connect gateway was detached from a transit gateway (DXGW-ATTACHMENT- DELETED) • A transit gateway peering connection attachment was created (TGW_PEERING_CREATED) • A transit gateway peering connection was deleted (TGW-PEERING-DELETED) • A transit gateway Connect attachment was created for a transit gateway (CONNECT_ATTACHMENT_CREATED) • A transit gateway Connect attachment was deleted for a transit gateway (CONNECT_ATTACHMENT_DELETED) • A transit gateway Connect peer was created in a Connect attachment (TGW-CONNECT-PEER- CREATED) • A transit gateway Connect peer was deleted in a Connect attachment (CONNECT_PEER_DELETED) A transit gateway in the global network was deleted (TGW-DELETED) {"version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", Topology change events 100 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-18T22:18:44Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:123456789012:transit-gateway/tgw-1234567890abcdef0" ], "detail":{ "changeType":"TGW-DELETED", "changeDescription":"A Transit Gateway in the global network has been deleted.", "region":"us-east-1", "transitGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0"}} A VPN connection was created for a transit gateway (VPN-CONNECTION- CREATED) { "version":"0", "id":"7636f496-ba9f-b1cc-22a6-8c90bbca8540", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-18T19:52:42Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:123456789012:vpn-connection/vpn-01c3c3738ab9f83c5" ], "detail":{ "changeType":"VPN-CONNECTION-CREATED", "changeDescription":"A Site-to-Site VPN connection has been created.", "region":"us-east-1", "transitGatewayAttachmentArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway- attachment/tgw-attach-1234567890abcdef0", "vpnConnectionArn":"arn:aws:ec2:us-east-1:123456789012:vpn-connection/ vpn-1234567890abcdef0", "customerGatewayArn":"arn:aws:ec2:us-east-1:123456789012:customer-gateway/ cgw-1234567890abcdef0", Topology change events 101 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "outsideIpAddresses":["54.166.146.158","3.93.214.172"], "routing":"dynamic_route", "accelerated":false, "isPrivateVpn":false, "transitGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0" } } A VPN connection was deleted on a transit gateway (VPN-CONNECTION- DELETED) { "version":"0", "id":"877fe5fd-4c95-1553-84ef-cfa271121081", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-19T19:43:12Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:123456789012:vpn-connection/vpn-1234567890abcdef0" ], "detail":{ "changeType":"VPN-CONNECTION-DELETED", "changeDescription":"A Site-to-Site VPN connection has been deleted.", "region":"us-east-1", "transitGatewayAttachmentArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway- attachment/tgw-attach-1234567890abcdef0", "vpnConnectionArn":"arn:aws:ec2:us-east-1:123456789012:vpn-connection/ vpn-1234567890abcdef0", "customerGatewayArn":"arn:aws:ec2:us-east-1:123456789012:customer-gateway/ cgw-1234567890abcdef0", "isPrivateVpn":false, "transitGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0" } } Topology change events 102 AWS Network Manager AWS Global Networks for Transit Gateways User Guide The customer gateway for a VPN connection was changed (VPN-CONNECTION- CUSTOMER-GATEWAY-MODIFIED) {"version":"0", "id":"76594f68-2b9f-7885-895e-58ece42ac48a", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012","time":"2023-06-28T19:25:12Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:123456789012:vpn-connection/vpn-0822025a9ea3dde43" ], "detail":{ "changeType":"VPN-CONNECTION-CUSTOMER-GATEWAY-MODIFIED", "changeDescription":"The customer gateway of a Site-to-Site VPN connection has been modified", "region":"us-east-1", "vpnConnectionArn":"arn:aws:ec2:us-east-1:123456789012:vpn-connection/ vpn-1234567890abcdef0", "previousCustomerGatewayArn":"arn:aws:ec2:us-east-1:123456789012:customer-gateway/ cgw-1234567890abcdef0", "currentCustomerGatewayArn":"arn:aws:ec2:us-east-1:123456789012:customer-gateway/ cgw-1234567890abcdef0", "transitGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0" } } The target gateway for a VPN connection was changed (VPN-CONNECTION- TARGET-GATEWAY-MODIFIED) {"version":"0", "id":"668a4e46-a757-3663-dc32-308c5ac5d87f", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"503089527312", "time":"2023-06-27T18:27:24Z", "region":"us-west-2", "resources":[ Topology change events 103 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:123456789012:vpn-connection/vpn-1234567890abcdef0" ], "detail":{ "changeType":"VPN-CONNECTION-TARGET-GATEWAY-MODIFIED", "changeDescription":"The target gateway of a Site-to-Site VPN connection has been modified", "region":"us-east-1", "vpnConnectionArn":"arn:aws:ec2:us-east-1:123456789012:vpn-connection/ vpn-1234567890abcdef0", "previousTargetGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0", "currentTargetGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0", "transitGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0" } } A VPC was attached to a transit gateway (VPC-ATTACHMENT-CREATED) { "version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-18T19:52:52Z", "region":"us-west-2", "resources": [ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:networkmanager::123456789012:core-network/core-network-1234567890abcdef0" ], "detail":{ "changeType":"VPC-ATTACHMENT-CREATED", "changeDescription":"A VPC attachment has been created for a Core Network.", "edgeLocation":"us-east-2", "attachmentArn":"arn:aws:networkmanager::123456789012:attachment/ attachment-1234567890abcdef0", "vpcArn":"arn:aws:ec2:us-east-2:123456789012:vpc/vpc-1234567890abcdef0", Topology change events 104 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "coreNetworkArn":"arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0" } } A VPC attachment was deleted from a transit gateway (VPC-ATTACHMENT- DELETED) { "account": "123456789012", "region": "us-west-2", "detail-type": "Network Manager Topology Change", "source": "aws.networkmanager", "version": "0", "time": "2019-06-30T23:18:50Z", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "resources": [ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:123456789012:transit-gateway/tgw-1234567890abcdef0" ], "detail": { "changeType": "VPC-ATTACHMENT-DELETED", "changeDescription": "A VPC attachment has been deleted.", "region": "us-east-1", "transit-gateway-arn": "arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-11111111111122222", "transit-gateway-attachment-arn": "arn:aws:ec2:us-east-1:123456789012:transit- gateway-attachment/tgw-attach-1234567890abcdef0", "vpc-arn": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-1234567890abcdef0" } } An AWS Direct Connect gateway was attached to a transit gateway (DXGW- ATTACHMENT-CREATED) { "version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", Topology change events 105 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "time":"2023-01-19T18:57:29Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-west-1:123456789012:transit-gateway/tgw-1234567890abcdef0"], "detail":{ "changeType":"DXGW-ATTACHMENT-CREATED", "changeDescription":"A Direct Connect Gateway attachment has been created.", "region":"us-west-1", "transitGatewayAttachmentArn":"arn:aws:ec2:us-west-1:123456789012:transit- gateway-attachment/tgw-attach-1234567890abcdef0", "directConnectGatewayArn":"arn:aws:directconnect::123456789012:dx-gateway/ a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "transitGatewayArn":"arn:aws:ec2:us-west-1:123456789012:transit-gateway/ tgw-1234567890abcdef0" } } An AWS Direct Connect gateway was detached from a transit gateway (DXGW- ATTACHMENT-DELETED) { "version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-19T19:16:23Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-west-1:123456789012:transit-gateway/tgw-1234567890abcdef0" ], "detail":{ "changeType":"DXGW-ATTACHMENT-DELETED", "changeDescription":"A Direct Connect Gateway attachment has been deleted.", "region":"us-west-1", "transitGatewayAttachmentArn":"arn:aws:ec2:us-west-1:123456789012:transit-gateway- attachment/tgw-attach-1234567890abcdef0", "directConnectGatewayArn":"arn:aws:directconnect::123456789012:dx-gateway/ a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", Topology change events 106 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "transitGatewayArn":"arn:aws:ec2:us-west-1:123456789012:transit-gateway/ tgw-1234567890abcdef0" } } A transit gateway peering connection attachment was created (TGW_PEERING_CREATED) { "version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-18T22:28:51Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:networkmanager::123456789012:core-network/core-network-1234567890abcdef0" ], "detail":{ "changeType":"TGW_PEERING_CREATED", "changeDescription":"A Transit Gateway peering has been created for a Core Network.", "edgeLocation":"us-east-1", "peeringArn":"arn:aws:networkmanager::123456789012:peering/ peering-1234567890abcdef0", "transitGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0", "coreNetworkArn":"arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0" } } A transit gateway peering connection
tgwnm-035	tgwnm.pdf	35	"id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-19T19:16:23Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-west-1:123456789012:transit-gateway/tgw-1234567890abcdef0" ], "detail":{ "changeType":"DXGW-ATTACHMENT-DELETED", "changeDescription":"A Direct Connect Gateway attachment has been deleted.", "region":"us-west-1", "transitGatewayAttachmentArn":"arn:aws:ec2:us-west-1:123456789012:transit-gateway- attachment/tgw-attach-1234567890abcdef0", "directConnectGatewayArn":"arn:aws:directconnect::123456789012:dx-gateway/ a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", Topology change events 106 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "transitGatewayArn":"arn:aws:ec2:us-west-1:123456789012:transit-gateway/ tgw-1234567890abcdef0" } } A transit gateway peering connection attachment was created (TGW_PEERING_CREATED) { "version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-18T22:28:51Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:networkmanager::123456789012:core-network/core-network-1234567890abcdef0" ], "detail":{ "changeType":"TGW_PEERING_CREATED", "changeDescription":"A Transit Gateway peering has been created for a Core Network.", "edgeLocation":"us-east-1", "peeringArn":"arn:aws:networkmanager::123456789012:peering/ peering-1234567890abcdef0", "transitGatewayArn":"arn:aws:ec2:us-east-1:123456789012:transit-gateway/ tgw-1234567890abcdef0", "coreNetworkArn":"arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0" } } A transit gateway peering connection was deleted (TGW-PEERING-DELETED) { "version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", Topology change events 107 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "account":"503089527312", "time":"2023-06-27T19:55:59Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-1234567890abcdef0" ], "detail":{ "changeType":"TGW-PEERING-DELETED", "changeDescription":"A Transit Gateway peering attachment has been deleted.", "region":"us-east-1", "transitGatewayAttachmentArn":"arn:aws:ec2:us-east-1:111122223333:transit-gateway- attachment/tgw-attach-1234567890abcdef0", "peeredTransitGatewayArn":"arn:aws:ec2:us-east-1:111122223333:transit-gateway/ tgw-1234567890abcdef0", "transitGatewayArn":"arn:aws:ec2:us-east-1:111122223333:transit-gateway/ tgw-1234567890abcdef0" } } A transit gateway Connect attachment was created for a transit gateway (CONNECT_ATTACHMENT_CREATED) { "version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2022-11-21T23:23:46Z", "region":"us-west-2", "resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:networkmanager::123456789012:core-network/core-network-1234567890abcdef0" ], "detail":{ "changeType":"CONNECT_ATTACHMENT_CREATED", "changeDescription":"A Connect attachment has been created for a Core Network.", "edgeLocation":"us-east-1", "attachmentArn":"arn:aws:networkmanager::123456789012:attachment/ attachment-1234567890abcdef0", Topology change events 108 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "transportAttachmentArn":"arn:aws:networkmanager::123456789012:attachment/ attachment-1234567890abcdef0", "protocol":"GRE", "coreNetworkArn":"arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0" } } A transit gateway Connect attachment was deleted for a transit gateway (CONNECT_ATTACHMENT_DELETED) { "version":"0", "id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type":"Network Manager Topology Change", "source":"aws.networkmanager", "account":"123456789012", "time":"2023-01-19T19:26:26Z", "region":"us-west-2","resources":[ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:networkmanager::123456789012:core-network/core-network-1234567890abcdef0" ], "detail":{ "changeType":"CONNECT_ATTACHMENT_DELETED", "changeDescription":"A Connect attachment has been deleted for a Core Network.", "edgeLocation":"us-east-1", "attachmentArn":"arn:aws:networkmanager::123456789012:attachment/ attachment-1234567890abcdef0", "transportAttachmentArn":"arn:aws:networkmanager::123456789012:attachment/ attachment-1234567890abcdef0", "coreNetworkArn":"arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0" } } A transit gateway Connect peer was created in a Connect attachment (TGW- CONNECT-PEER-CREATED) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", Topology change events 109 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "detail-type": "Network Manager Topology Change", "source": "aws.networkmanager", "account": "123456789012", "time": "2023-06-27T17:22:45Z", "region": "us-west-2", "resources": [ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-1234567890abcdef0" ], "detail": { "changeType": "TGW-CONNECT-PEER-CREATED", "changeDescription": "A TGW Connect Peer has been created in a Connect attachment.", "region": "us-east-1", "transitGatewayAttachmentArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway- attachment/tgw-attach-1234567890abcdef0", "connectPeerArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway-connect-peer/ tgw-connect-peer-1234567890abcdef0", "peerAddress": "10.1.2.3", "transitGatewayAddress": "10.0.0.1", 111122223333 "transitGatewayArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway/ tgw-1234567890abcdef0" } } A transit gateway Connect peer was deleted in a Connect attachment (CONNECT_PEER_DELETED) { "version": "0", "id": "437f664b-cc6c-ccb8-b322-2c185ebe0c10", "detail-type": "Network Manager Topology Change", "source": "aws.networkmanager", "account": "738040852526", "time": "2023-11-13T20:49:34Z", "region": "us-west-2", "resources": [ "arn:aws:networkmanager::738040852526:global-network/global- network-02e49afd6fa01d0c3", "arn:aws:networkmanager::738040852526:core-network/core- network-0d6ee69cdc931f7b5" ], Topology change events 110 AWS Network Manager "detail": { AWS Global Networks for Transit Gateways User Guide "changeType": "CONNECT_PEER_DELETED", "changeDescription": "A Connect peer has been deleted in a Connect attachment.", "edgeLocation": "eu-west-2", "attachmentArn": "arn:aws:networkmanager::738040852526:attachment/ attachment-05e447f0df042a011", "connectPeerArn": "arn:aws:networkmanager::738040852526:connect-peer/connect- peer-024b3172d38112df5", "coreNetworkArn": "arn:aws:networkmanager::738040852526:core-network/core- network-0d6ee69cdc931f7b5" } } Routing update events Routing update events occur when there have been changes to the transit gateway route tables in your global network. These include the following: Events • A transit gateway attachment's route table changed (CONNECT_PEER_DELETED) • A route was created in a transit gateway route table (TGW-ROUTE-INSTALLED) • A route was deleted in a transit gateway route table gateway (TGW-ROUTE-UNINSTALLED) A transit gateway attachment's route table changed (CONNECT_PEER_DELETED) { "version": "0", "id": "437f664b-cc6c-ccb8-b322-2c185ebe0c10", "detail-type": "Network Manager Topology Change", "source": "aws.networkmanager", "account": "738040852526", "time": "2023-11-13T20:49:34Z", "region": "us-west-2", "resources": [ "arn:aws:networkmanager::738040852526:global-network/global- network-02e49afd6fa01d0c3", "arn:aws:networkmanager::738040852526:core-network/core- network-0d6ee69cdc931f7b5" ], Routing update events 111 AWS Network Manager "detail": { AWS Global Networks for Transit Gateways User Guide "changeType": "CONNECT_PEER_DELETED", "changeDescription": "A Connect peer has been deleted in a Connect attachment.", "edgeLocation": "eu-west-2", "attachmentArn": "arn:aws:networkmanager::738040852526:attachment/ attachment-05e447f0df042a011", "connectPeerArn": "arn:aws:networkmanager::738040852526:connect-peer/connect- peer-024b3172d38112df5", "coreNetworkArn": "arn:aws:networkmanager::738040852526:core-network/core- network-0d6ee69cdc931f7b5" } } A route was created in a transit gateway route table (TGW-ROUTE-INSTALLED) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type": "Network Manager Routing Update", "source": "aws.networkmanager", "account": "123456789012", "time": "2023-06-27T15:24:32Z", "region": "us-west-2", "resources": [ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-1234567890abcdef0" ], "detail": { "changeType": "TGW-ROUTE-INSTALLED", "changeDescription": "Routes in one or more Transit Gateway route tables have been installed.", "region": "us-east-1", "transitGatewayRouteTableArns": [ "arn:aws:ec2:us-east-1:111122223333:transit-gateway-route-table/tgw- rtb-1234567890abcdef0" ], "sequenceNumber": 1687879467281, "routes": [{ "destinationCidrBlock": "11.0.0.0/16", "attachments": [ { "tgwAttachmentId": "tgw-attach-1234567890abcdef0", Routing update events 112 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "resourceId": "vpc-1234567890abcdef0", "attachmentType": "vpc" } ], "routeType": "route_propagated", "routeState": "active", "propagatedRouteFamily": "connected" } ], "transitGatewayArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway/ tgw-1234567890abcdef0" } A route was deleted in a transit gateway route table gateway (TGW-ROUTE- UNINSTALLED) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type": "Network Manager Routing Update", "source": "aws.networkmanager", "account": "123456789012", "time": "2022-02-30T23:18:50Z", "region": "us-east-1", "resources": [ "arn:aws-us-east-1:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws-us-east-1:ec2:us-east-1:111122223333:transit-gateway/ tgw-1234567890abcdef0" ], "detail": { "changeType": "TGW-ROUTE-UNINSTALLED", "changeDescription": "Routes in one or more Transit Gateway route tables have been uninstalled.", "region": "us-east-1", "transitGatewayRouteTableArns": [ "arn:aws-us-east-1:ec2:us-east-1:111122223333:transit-gateway-route-table/tgw- rtb-1234567890abcdef0" ], "sequenceNumber": 1648147298451, "routes": [{ "destinationCidrBlock": "10.10.10.0/16", Routing update events 113 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "attachments": [], "routeType": "route_static", "routeState": "blackhole" } ], "transitGatewayArn": "arn:aws-us-east-1:ec2:us-east-1:111122223333:transit-gateway/ tgw-1234567890abcdef0" } } Status update events Status update events occur when there have been changes to the status of the connectivity of your VPN connections in the global network. These include the following: Events •
tgwnm-036	tgwnm.pdf	36	"2022-02-30T23:18:50Z", "region": "us-east-1", "resources": [ "arn:aws-us-east-1:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws-us-east-1:ec2:us-east-1:111122223333:transit-gateway/ tgw-1234567890abcdef0" ], "detail": { "changeType": "TGW-ROUTE-UNINSTALLED", "changeDescription": "Routes in one or more Transit Gateway route tables have been uninstalled.", "region": "us-east-1", "transitGatewayRouteTableArns": [ "arn:aws-us-east-1:ec2:us-east-1:111122223333:transit-gateway-route-table/tgw- rtb-1234567890abcdef0" ], "sequenceNumber": 1648147298451, "routes": [{ "destinationCidrBlock": "10.10.10.0/16", Routing update events 113 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "attachments": [], "routeType": "route_static", "routeState": "blackhole" } ], "transitGatewayArn": "arn:aws-us-east-1:ec2:us-east-1:111122223333:transit-gateway/ tgw-1234567890abcdef0" } } Status update events Status update events occur when there have been changes to the status of the connectivity of your VPN connections in the global network. These include the following: Events • A VPN tunnel's IPsec session went down (VPN-CONNECTION-IPSEC-DOWN) • A VPN tunnel's IPsec session went up (after being down) (VPN-CONNECTION-IPSEC-UP) • A VPN tunnel's BGP session went down (VPN-CONNECTION-BGP-DOWN) • A VPN tunnel's BGP session went up (after being down) (VPN-CONNECTION-BGP-ESTABLISH) • A Connect peer (GRE tunnel) BGP session went down (CONNECT_PEER_BGP_DOWN) • A Connect peer (GRE tunnel) BGP session went up after being down) (CONNECT_PEER_BGP_UP) A VPN tunnel's IPsec session went down (VPN-CONNECTION-IPSEC-DOWN) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type": "Network Manager Status Update", "source": "aws.networkmanager", "account": "123456789012", "time": "2023-01-31T19:48:05Z", "region": "us-west-2", "resources": [ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-west-2:111122223333:vpn-connection/vpn-1234567890abcdef0" ], "detail": { Status update events 114 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "changeType": "VPN-CONNECTION-IPSEC-DOWN", "changeDescription": "IPsec for a VPN connection has gone down.", "region": "us-west-2", "transitGatewayAttachmentArn": "arn:aws:ec2:us-west-2:111122223333:transit- gateway-attachment/tgw-attach-1234567890abcdef0", "vpnConnectionArn": "arn:aws:ec2:us-west-2:111122223333:vpn-connection/ vpn-1234567890abcdef0", "outsideIpAddress": "35.84.102.207", "transitGatewayArn": "arn:aws:ec2:us-west-2:111122223333:transit-gateway/ tgw-1234567890abcdef0" } } A VPN tunnel's IPsec session went up (after being down) (VPN-CONNECTION- IPSEC-UP) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type": "Network Manager Status Update", "source": "aws.networkmanager", "account": "123456789012", "time": "2023-01-31T19:34:54Z", "region": "us-west-2", "resources": [ "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-west-2:111122223333:vpn-connection/vpn-1234567890abcdef0" ], "detail": { "changeType": "VPN-CONNECTION-IPSEC-UP", "changeDescription": "IPsec for a VPN connection has come up.", "region": "us-west-2", "transitGatewayAttachmentArn": "arn:aws:ec2:us-west-2:111122223333:transit- gateway-attachment/tgw-attach-1234567890abcdef0", "vpnConnectionArn": "arn:aws:ec2:us-west-2:111122223333:vpn-connection/ vpn-1234567890abcdef0", "outsideIpAddress": "52.37.214.193", "transitGatewayArn": "arn:aws:ec2:us-west-2:111122223333:transit-gateway/ tgw-1234567890abcdef0" } } Status update events 115 AWS Network Manager AWS Global Networks for Transit Gateways User Guide A VPN tunnel's BGP session went down (VPN-CONNECTION-BGP-DOWN) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type": "Network Manager Status Update", "source": "aws.networkmanager", "account": "123456789012", "time": "2023-01-31T19:48:23Z", "region": "us-west-2", "resources": [ "arn:aws:networkmanager::123456789012:global-network/global- network-0c243052669618f74", "arn:aws:ec2:us-west-2:111122223333:vpn-connection/vpn-0fdb136628eff65a8" ], "detail": { "changeType": "VPN-CONNECTION-BGP-DOWN", "changeDescription": "BGP for a VPN connection has gone down.", "region": "us-west-2", "transitGatewayAttachmentArn": "arn:aws:ec2:us-west-2:111122223333:transit- gateway-attachment/tgw-attach-1234567890abcdef0", "vpnConnectionArn": "arn:aws:ec2:us-west-2:111122223333:vpn-connection/ vpn-1234567890abcdef0", "outsideIpAddress": "54.190.210.71", "peerAsn": "65001", "transitGatewayArn": "arn:aws:ec2:us-west-2:111122223333:transit-gateway/ tgw-1234567890abcdef0" } } A VPN tunnel's BGP session went up (after being down) (VPN-CONNECTION-BGP- ESTABLISH) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type": "Network Manager Status Update", "source": "aws.networkmanager", "account": "123456789012", "time": "2023-01-31T19:34:40Z", "region": "us-west-2", "resources": [ Status update events 116 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "arn:aws:networkmanager::123456789012:global-network/global- network-1234567890abcdef0", "arn:aws:ec2:us-west-2:111122223333:vpn-connection/vpn-1234567890abcdef0" ], "detail": { "changeType": "VPN-CONNECTION-BGP-ESTABLISH", "changeDescription": "BGP for a VPN connection has been established.", "region": "us-west-2", "transitGatewayAttachmentArn": "arn:aws:ec2:us-west-2:111122223333:transit- gateway-attachment/tgw-attach-1234567890abcdef0", "vpnConnectionArn": "arn:aws:ec2:us-west-2:111122223333:vpn-connection/ vpn-1234567890abcdef0", "outsideIpAddress": "52.37.214.193", "peerAsn": "65001", "transitGatewayArn": "arn:aws:ec2:us-west-2:111122223333:transit-gateway/ tgw-1234567890abcdef0" } } A Connect peer (GRE tunnel) BGP session went down (CONNECT_PEER_BGP_DOWN) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type": "Network Manager Status Update", "source": "aws.networkmanager", "account": "123456789012", "time": "2023-03-01T19:57:34Z", "region": "us-west-2", "resources": ["arn:aws:networkmanager::123456789012:global-network/global- network-07a82dd610af0cc57", "arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0"], "detail": { "changeType": "CONNECT_PEER_BGP_DOWN", "changeDescription": "BGP for a Connect peer has gone down.", "edgeLocation": "ap-southeast-1", "attachmentArn": "arn:aws:networkmanager::123456789012:attachment/ attachment-1234567890abcdef0", "connectPeerArn": "arn:aws:networkmanager::123456789012:connect-peer/connect- peer-1234567890abcdef0", "peerAsn": "65011", "coreNetworkAddress": "192.0.2.0", Status update events 117 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "coreNetworkArn": "arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0" } } A Connect peer (GRE tunnel) BGP session went up after being down) (CONNECT_PEER_BGP_UP) { "version": "0", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "detail-type": "Network Manager Status Update", "source": "aws.networkmanager", "account": "123456789012", "time": "2023-03-01T19:57:49Z", "region": "us-west-2", "resources": ["arn:aws:networkmanager::123456789012:global-network/global- network-07a82dd610af0cc57", "arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0"], "detail": { "changeType": "CONNECT_PEER_BGP_UP", "changeDescription": "BGP for a Connect peer has been established.", "edgeLocation": "ap-southeast-1", "attachmentArn": "arn:aws:networkmanager::123456789012:attachment/ attachment-1234567890abcdef0", "connectPeerArn": "arn:aws:networkmanager::123456789012:connect-peer/connect- peer-1234567890abcdef0", "peerAsn": "65011", "coreNetworkAddress": "192.0.2.0", "coreNetworkArn": "arn:aws:networkmanager::123456789012:core-network/core- network-1234567890abcdef0" } } Log AWS Global Networks for Transit Gateways API calls using AWS CloudTrail AWS Global Networks for Transit Gateways works with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in global networks. CloudTrail captures all API calls for global network as events. The calls that are captured include calls from the Network Log API calls using CloudTrail 118 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Manager console and code calls to the global API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Global Networks. If you don't conﬁgure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine what request was made to global networks, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. Global network information in CloudTrail CloudTrail is enabled on your AWS account when
tgwnm-037	tgwnm.pdf	37	trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Global Networks. If you don't conﬁgure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine what request was made to global networks, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. Global network information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in a global network, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing Events with CloudTrail Event History. For an ongoing record of events in your AWS account, including events for a global network create a trail. A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition, and delivers the log ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following topics in the AWS CloudTrail User Guide. • Overview for Creating a Trail • CloudTrail Supported Services and Integrations • Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts All actions in a global network are logged by CloudTrail and are documented in the Network Manager API Reference. For example, calls to the CreateGlobalNetwork action generate entries in the CloudTrail log ﬁles. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root or AWS Identity and Access Management (IAM user) credentials Global network information in CloudTrail 119 AWS Network Manager AWS Global Networks for Transit Gateways User Guide • Whether the request was made with temporary security credentials for a role or federated user • Whether the request was made by another AWS service For more information, see the CloudTrail userIdentity Element. Global network information in CloudTrail 120 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Identity and access management for AWS Global Networks for Transit Gateways AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS Global Networks for Transit Gateways resources. IAM is an AWS service that you can use with no additional charge. You can use features of IAM to allow other users, services, and applications to use your AWS resources fully or in a limited way, without sharing your security credentials. By default, IAM users don't have permission to create, view, or modify AWS resources. To allow an IAM user to access resources, such as a global network, and perform tasks, you must: • Create an IAM policy that grants the IAM user permission to use the speciﬁc resources and API actions they need • Attach the policy to the IAM user or to the group to which the IAM user belongs When you attach a policy to a user or group of users, it allows or denies the user permissions to perform the speciﬁed tasks on the speciﬁed resources. Important If you grant access to a global network in Network Manager, you grant access to all AWS service data associated with the registered transit gateways across all Regions. Contents • How Network Manager works with IAM • Example policies to manage global networks • AWS Global Networks for Transit Gateways service-linked roles • AWS managed policies for AWS Global Networks for Transit Gateways • Multi-account access roles for AWS Global Networks for Transit Gateways 121 AWS Network Manager AWS Global Networks for Transit Gateways User Guide How Network Manager works with IAM With IAM identity-based policies, you can specify allowed or denied actions and resources, and specify the conditions under which actions are allowed or denied. Network Manager supports speciﬁc actions, resources, and condition keys. For a complete list, see Actions, Resources, and Condition Keys for AWS Network Manager in the Service Authorization Reference. To learn about all of the elements that you use in a JSON policy, see IAM JSON Policy Elements Reference in the IAM User Guide. Actions Policy actions in Network Manager use the following preﬁx before the action: networkmanager:.
tgwnm-038	tgwnm.pdf	38	Gateways User Guide How Network Manager works with IAM With IAM identity-based policies, you can specify allowed or denied actions and resources, and specify the conditions under which actions are allowed or denied. Network Manager supports speciﬁc actions, resources, and condition keys. For a complete list, see Actions, Resources, and Condition Keys for AWS Network Manager in the Service Authorization Reference. To learn about all of the elements that you use in a JSON policy, see IAM JSON Policy Elements Reference in the IAM User Guide. Actions Policy actions in Network Manager use the following preﬁx before the action: networkmanager:. For example, to grant someone permission to create a global network with the CreateGlobalNetwork API operation, you include the networkmanager:CreateGlobalNetwork action in their policy. For a list of global networks actions, see the Network Manager API Reference. Resources The Resource element speciﬁes the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. You specify a resource using an ARN or using the wildcard () to indicate that the statement applies to all resources. The global network resource has the following ARN. arn:${Partition}:networkmanager::${Account}:global-network/${GlobalNetworkId} For example, to specify the global-network-1122334455aabbccd global network in your statement, use the following ARN. "Resource": "arn:aws:networkmanager::123456789012:global-network/global- network-1122334455aabbccd" Condition keys The Condition element (or Condition block) lets you specify conditions in which a statement is in eﬀect. The Condition element is optional. You can build conditional expressions that use How Network Manager works with IAM 122 AWS Network Manager AWS Global Networks for Transit Gateways User Guide condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM Policy Elements: Variables and Tags in the IAM User Guide. You can attach tags to global networks resources or pass tags in a request to global networks. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. To see all AWS global condition keys, see AWS Global Condition Context Keys in the IAM User Guide. global networks also supports the following condition keys: • networkmanager:tgwArn—Controls which transit gateways can be registered or deregistered in your global network. • networkmanager:cgwArn—Controls which customer gateways can be associated or disassociated from devices and links in your global network. • networkmanager:tgwConnectPeerArn—Controls which Connect peers can be associated or disassociated from devices and links in your global network. Example policies to manage global networks The following are example IAM policies for working with global networks. Administrator access The following IAM policy grants full access to the Amazon EC2, global networks, AWS Direct Connect, and CloudWatch APIs. This enables administrators to create and manage transit gateways and their attachments (such as VPCs and AWS Direct Connect gateways), create and manage global Example policies 123 AWS Network Manager AWS Global Networks for Transit Gateways User Guide networks resources, and monitor global networks using CloudWatch metrics and events. The policy also grants user permissions to create any required service-linked roles. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "ec2:", "Resource": "" }, { "Effect": "Allow", "Action": "networkmanager:", "Resource": "" }, { "Effect": "Allow", "Action": "cloudwatch:", "Resource": "" }, { "Effect": "Allow", "Action": "events:", "Resource": "" }, { "Effect": "Allow", "Action": "directconnect:", "Resource": "" }, { "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam:::role/aws-service-role/" } ] } Read-only access The following IAM policy grants read-only access to the Amazon EC2, global networks, AWS Direct Connect, CloudWatch, and EventBridge APIs. This enables users to use the global networks console Example policies 124 AWS Network Manager AWS Global Networks for Transit Gateways User Guide to view and monitor global networks and their associated resources, and view metrics and events for the resources. Users cannot create or modify any resources. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ec2:Get", "ec2:Describe" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "networkmanager:Get", "networkmanager:Describe" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "cloudwatch:List", "cloudwatch:Get", "cloudwatch:Describe" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "logs:Describe", "logs:Get", "logs:List", "logs:StartQuery", "logs:StopQuery", "logs:TestMetricFilter", "logs:FilterLogEvents" ], "Resource": "" Example policies 125 AWS Global Networks for Transit Gateways User Guide AWS Network Manager }, { "Effect": "Allow", "Action": [ "events:List",
tgwnm-039	tgwnm.pdf	39	to view and monitor global networks and their associated resources, and view metrics and events for the resources. Users cannot create or modify any resources. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ec2:Get", "ec2:Describe" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "networkmanager:Get", "networkmanager:Describe" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "cloudwatch:List", "cloudwatch:Get", "cloudwatch:Describe" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "logs:Describe", "logs:Get", "logs:List", "logs:StartQuery", "logs:StopQuery", "logs:TestMetricFilter", "logs:FilterLogEvents" ], "Resource": "" Example policies 125 AWS Global Networks for Transit Gateways User Guide AWS Network Manager }, { "Effect": "Allow", "Action": [ "events:List", "events:TestEventPattern", "events:Describe" ], "Resource": "" }, { "Effect": "Allow", "Action": "directconnect:Describe", "Resource": "" } ] } Controlling the use of transit gateways and customer gateways The following IAM policy enables users to work with global networks resources, but they are explicitly denied permission to do the following: • Register or deregister a speciﬁc transit gateway (tgw-aabbccdd112233445) in the global network. • Associate or disassociate a speciﬁc customer gateway (cgw-11223344556677abc) in the global network. The policy uses the networkmanager:tgwArn and networkmanager:cgwArn condition keys to enforce these conditions. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "networkmanager:" ], "Resource": [ "" Example policies 126 AWS Network Manager ] }, { AWS Global Networks for Transit Gateways User Guide "Effect": "Deny", "Action": [ "networkmanager:RegisterTransitGateway", "networkmanager:DeregisterTransitGateway" ], "Resource": [ "" ], "Condition": { "StringEquals": { "networkmanager:tgwArn": "arn:aws:ec2:region:account-id:transit- gateway/tgw-aabbccdd112233445" } } }, { "Effect": "Deny", "Action": [ "networkmanager:AssociateCustomerGateway", "networkmanager:DisassociateCustomerGateway" ], "Resource": [ "*" ], "Condition": { "StringEquals": { "networkmanager:cgwArn": "arn:aws:ec2:region:account-id:customer- gateway/cgw-11223344556677abc" } } } ] } AWS Global Networks for Transit Gateways service-linked roles AWS Global Networks for Transit Gateways uses service-linked roles for the permissions that it requires to call other AWS services on your behalf. These service-linked roles are not propagated to your AWS Organizations management account. Service-linked role 127 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Permissions granted by the service-linked role AWS Global Networks for Transit Gateways uses a Network Manager service-linked role named AWSServiceRoleForNetworkManager to call the actions on your behalf when you work with global networks. The AWSServiceRoleForNetworkManager service-linked role trusts the following service to assume the role: • networkmanager.amazonaws.com This service-linked role uses the managed policy AWSNetworkManagerServiceRolePolicy. To view the permissions for this policy, see AWSNetworkManagerServiceRolePolicy in the AWS Managed Policy Reference. Create the service-linked role You don't need to manually create the AWSServiceRoleForNetworkManager role. global networks creates this role for you when you create your ﬁrst global network. For global networks to create a service-linked role on your behalf, you must have the required permissions. For more information, see Service-linked role permissions in the IAM User Guide. Edit the service-linked role You can edit the description of AWSServiceRoleForNetworkManager using IAM. For more information, see Edit a service-linked role description in the IAM User Guide. Delete the service-linked role If you no longer need to use global networks, we recommend that you delete the AWSServiceRoleForNetworkManager role. You can delete this service-linked role only after you delete your global network. For information about how to delete your global network, see Delete a global network. You can use the IAM console, the IAM CLI, or the IAM API to delete service-linked roles. For more information, see Delete a service-linked role in the IAM User Guide. After you delete AWSServiceRoleForNetworkManager, Network Manager will create the role again when you create a new global network. Permissions granted by the service-linked role 128 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Supported Regions for AWS Global Networks for Transit Gateways service-linked roles AWS Global Networks for Transit Gateways supports the custom-linked roles in all of AWS Regions where the service is available. For more information, see the section called “Region availability”. AWS managed policies for AWS Global Networks for Transit Gateways To add permissions to users, groups, and roles, it is easier to use AWS managed policies than to write policies yourself. It takes time and expertise to create IAM customer managed policies that provide your team with only the permissions they need. To get started quickly, you can use our AWS managed policies. These policies cover common use cases and are available in your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. AWS services maintain and update AWS managed policies. You can't change the permissions in AWS managed policies. Services occasionally add additional permissions to an AWS managed policy to support new features. This type of update aﬀects all identities (users, groups, and roles) where the policy is attached. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services do not remove permissions from an AWS managed policy, so policy
tgwnm-040	tgwnm.pdf	40	your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. AWS services maintain and update AWS managed policies. You can't change the permissions in AWS managed policies. Services occasionally add additional permissions to an AWS managed policy to support new features. This type of update aﬀects all identities (users, groups, and roles) where the policy is attached. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services do not remove permissions from an AWS managed policy, so policy updates won't break your existing permissions. Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For a list and descriptions of job function policies, see AWS managed policies for job functions in the IAM User Guide. AWS managed policy: NetworkAdministrator You can attach the NetworkAdministrator policy to your IAM identities. This policy grants permissions that allow registered delegated administrators and the management account administrator access to global networks. For more information, see the section called “Multi- account access roles”. To view the permissions for this policy, see NetworkAdministrator in the AWS Managed Policy Reference. Supported Regions 129 AWS Network Manager AWS Global Networks for Transit Gateways User Guide AWS managed policy: AWSNetworkManagerReadOnlyAccess You can attach the AWSNetworkManagerReadOnlyAccess policy to your IAM identities. This policy grants permissions that allow registered delegated administrators and the management account read-only access to global networks. For more information, see the section called “Multi-account access roles”. To view the permissions for this policy, see AWSNetworkManagerReadOnlyAccess in the AWS Managed Policy Reference. AWS managed policy: AWSNetworkManagerServiceRolePolicy This policy is attached to the service-linked role named AWSServiceRoleForNetworkManager to allow AWS Global Networks for Transit Gateways to call API actions on your behalf when you work with global networks. For more information, see the section called “Service-linked role”. To view the permissions for this policy, see AWSNetworkManagerServiceRolePolicy in the AWS Managed Policy Reference. AWS Global Networks for Transit Gateways updates to AWS managed policies View details about updates to AWS managed policies for Network Manager since this service began tracking these changes in April 2021. For automatic alerts about changes to this page, subscribe to the RSS feed on the Network Manager Document history page. Change Description Date AWSNetworkManagerS erviceRolePolicy July 12, 2022 AWS Global Networks for Transit Gateways added permission to call the following API action: GetTransitGatewayR outeTablePropagati ons . NetworkAdministrator AWS Global Networks for Transit Gateways began using May 24, 2022 AWSNetworkManagerReadOnlyAccess 130 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Change Description Date administrative permissions in member accounts for multi- account access. AWSNetworkManagerR eadOnlyAccess - Updated AWS Global Networks for Transit Gateways began using May 24, 2022 existing policy AWSNetworkManagerS erviceRolePolicy - Updated existing policy AWSNetworkManagerS erviceRolePolicy - Updated existing policy read-only permissions in member accounts for multi- account access. AWS Global Networks for Transit Gateways added permission to call the following API actions: organizations:Desc ribeAccount , organizations:Desc , ribeOrganization organizations:List Accounts , organizat ions:ListAWSServic eAccessForOrganiza tion , and organizat ions:ListDelegated Administrators . AWS Global Networks for Transit Gateways added permissions to call the following API action: ec2:DescribeRegions . May 24, 2022 December 2, 2021 Policy updates 131 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Change Description Date AWSNetworkManagerS erviceRolePolicy: updated AWS Global Networks for Transit Gateways added June 1, 2021 existing policy permissions to call the following API actions: directconnect:Desc ribeDirectConnectG ateways , ec2:Descr ibeVpnConnections ec2:DescribeVpcs , , ec2:GetTransitGate wayRouteTableAssoc iations , ec2:Searc hTransitGatewayRou tes , ec2:Descr ibeTransitGatewayP eeringAttachments , ec2:DescribeTransi tGatewayConnects , and ec2:DescribeTransi tGatewayConnectPee rs . Multi-account access roles for AWS Global Networks for Transit Gateways AWS Global Networks for Transit Gateways uses AWS CloudFormation StackSets to deploy and manage the following two custom IAM roles in AWS Organizations member accounts to support multi-account permissions. These two roles are deployed to every member account in the organization when AWSServiceAccess is enabled (trusted access). For more information about multi-account, see Manage multiple accounts in global networks using AWS Organizations. The custom IAM roles are created automatically through the Network Manager service when you enable multi-account access using the global networks console. We strongly recommend that you Multi-account access roles 132 AWS Network Manager AWS Global Networks for Transit Gateways User Guide use the console for enabling multi-account. Choosing an alternative approach requires an advanced level of expertise, and opens the multi-account for your global network to be more prone to error. CloudWatch-CrossAccountSharingRole This policy provides delegated administrators and the management accounts access to CloudWatch monitoring data from other member accounts. The following
tgwnm-041	tgwnm.pdf	41	accounts in global networks using AWS Organizations. The custom IAM roles are created automatically through the Network Manager service when you enable multi-account access using the global networks console. We strongly recommend that you Multi-account access roles 132 AWS Network Manager AWS Global Networks for Transit Gateways User Guide use the console for enabling multi-account. Choosing an alternative approach requires an advanced level of expertise, and opens the multi-account for your global network to be more prone to error. CloudWatch-CrossAccountSharingRole This policy provides delegated administrators and the management accounts access to CloudWatch monitoring data from other member accounts. The following is an example of the template. AWSTemplateFormatVersion: '2010-09-09' Description: Enables CloudWatch in central monitoring accounts to assume permissions to view CloudWatch data in the current account Resources: CloudWatch-CrossAccountSharingRole: Type: AWS::IAM::Role Properties: RoleName: CloudWatch-CrossAccountSharingRole AssumeRolePolicyDocument: Version: '2012-10-17' Statement: - Effect: Allow Principal: AWS: [ "arn:aws:iam::<account1-id>:root", "arn:aws:iam::<account2-id>:root", "arn:aws:iam::<account3-id>:root" ] Action: - sts:AssumeRole Path: "/" ManagedPolicyArns: - arn:aws:iam::aws:policy/CloudWatchReadOnlyAccess IAMRoleForAWSNetworkManagerCrossAccountResourceAccess The IAMRoleForAWSNetworkManagerCrossAccountResourceAccess IAM policy role, based on your selection when enabling trusted access through the global networksconsole, enables either administrative or read-only global networks console switch role access. An associated administrative or read-only template is also deployed along with the policy. For information about these templates, see the section called “ Permission templates”. The following is an example of the administrator role template. CloudWatch-CrossAccountSharingRole 133 AWS Network Manager AWS Global Networks for Transit Gateways User Guide AWSTemplateFormatVersion: '2010-09-09' Description: Enables admin cross account resource access through switch role Resources: IAMRoleForAWSNetworkManagerCrossAccountResourceAccess: Type: AWS::IAM::Role Properties: RoleName: IAMRoleForAWSNetworkManagerCrossAccountResourceAccess AssumeRolePolicyDocument: Version: '2012-10-17' Statement: - Effect: Allow Principal: AWS: [ "arn:aws:iam::<account1-id>:root", "arn:aws:iam::<account2-id>:root", "arn:aws:iam::<account3-id>:root" ] Action: - sts:AssumeRole Path: "/" ManagedPolicyArns: - arn:aws:iam::aws:policy/NetworkAdministrator The following is the read-only role template. AWSTemplateFormatVersion: '2010-09-09' Description: Enables read only cross account resource access through switch role Resources: IAMRoleForAWSNetworkManagerCrossAccountResourceAccess: Type: AWS::IAM::Role Properties: RoleName: IAMRoleForAWSNetworkManagerCrossAccountResourceAccess AssumeRolePolicyDocument: Version: '2012-10-17' Statement: - Effect: Allow Principal: AWS: [ "arn:aws:iam::<account1-id>:root", "arn:aws:iam::<account2-id>:root", "arn:aws:iam::<account3-id>:root" ] IAMRoleForAWSNetworkManagerCrossAccountResourceAccess 134 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Action: - sts:AssumeRole Path: "/" ManagedPolicyArns: - arn:aws:iam::aws:policy/AWSNetworkManagerReadOnlyAccess - arn:aws:iam::aws:policy/AWSDirectConnectReadOnlyAccess - arn:aws:iam::aws:policy/AmazonEC2ReadOnlyAccess - arn:aws:iam::aws:policy/AmazonRoute53ReadOnlyAccess Permission templates When choosing the IAMRoleForAWSNetworkManagerCrossAccountResourceAccess permission, an associated administrative or read-only template is also passed to AWS CloudFormation StackSets. These templates contain a list of accounts that are able to assume these roles. These accounts include the AWS Organizations management account and all registered delegated administrators for the Network Manager service. Deregistering a delegated administrator removes it from this list so that it can no longer assume these roles. Disabling trusted access deletes the AWS CloudFormation StackSets, and in turn all member account stacks and custom IAM roles in those accounts that were StackSets-managed for multi-account. NetworkAdministrator This policy enables administrator permission for the delegated administrator and management accounts to modify resources from other accounts in the global network while using the Network Manager console switch role. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "autoscaling:Describe", "cloudfront:ListDistributions", "cloudwatch:DeleteAlarms", "cloudwatch:DescribeAlarms", "cloudwatch:GetMetricStatistics", "cloudwatch:PutMetricAlarm", "directconnect:", "ec2:AcceptVpcEndpointConnections", "ec2:AllocateAddress", "ec2:AssignIpv6Addresses", Permission templates 135 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "ec2:AssignPrivateIpAddresses", "ec2:AssociateAddress", "ec2:AssociateDhcpOptions", "ec2:AssociateRouteTable", "ec2:AssociateSubnetCidrBlock", "ec2:AssociateVpcCidrBlock", "ec2:AttachInternetGateway", "ec2:AttachNetworkInterface", "ec2:AttachVpnGateway", "ec2:CreateCarrierGateway", "ec2:CreateCustomerGateway", "ec2:CreateDefaultSubnet", "ec2:CreateDefaultVpc", "ec2:CreateDhcpOptions", "ec2:CreateEgressOnlyInternetGateway", "ec2:CreateFlowLogs", "ec2:CreateInternetGateway", "ec2:CreateNatGateway", "ec2:CreateNetworkAcl", "ec2:CreateNetworkAclEntry", "ec2:CreateNetworkInterface", "ec2:CreateNetworkInterfacePermission", "ec2:CreatePlacementGroup", "ec2:CreateRoute", "ec2:CreateRouteTable", "ec2:CreateSecurityGroup", "ec2:CreateSubnet", "ec2:CreateTags", "ec2:CreateVpc", "ec2:CreateVpcEndpoint", "ec2:CreateVpcEndpointConnectionNotification", "ec2:CreateVpcEndpointServiceConfiguration", "ec2:CreateVpnConnection", "ec2:CreateVpnConnectionRoute", "ec2:CreateVpnGateway", "ec2:DeleteCarrierGateway", "ec2:DeleteEgressOnlyInternetGateway", "ec2:DeleteFlowLogs", "ec2:DeleteNatGateway", "ec2:DeleteNetworkInterface", "ec2:DeleteNetworkInterfacePermission", "ec2:DeletePlacementGroup", "ec2:DeleteSubnet", "ec2:DeleteTags", Permission templates 136 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "ec2:DeleteVpc", "ec2:DeleteVpcEndpointConnectionNotifications", "ec2:DeleteVpcEndpointServiceConfigurations", "ec2:DeleteVpcEndpoints", "ec2:DeleteVpnConnection", "ec2:DeleteVpnConnectionRoute", "ec2:DeleteVpnGateway", "ec2:DescribeAccountAttributes", "ec2:DescribeAddresses", "ec2:DescribeAvailabilityZones", "ec2:DescribeCarrierGateways", "ec2:DescribeClassicLinkInstances", "ec2:DescribeCustomerGateways", "ec2:DescribeDhcpOptions", "ec2:DescribeEgressOnlyInternetGateways", "ec2:DescribeFlowLogs", "ec2:DescribeInstances", "ec2:DescribeInternetGateways", "ec2:DescribeKeyPairs", "ec2:DescribeMovingAddresses", "ec2:DescribeNatGateways", "ec2:DescribeNetworkAcls", "ec2:DescribeNetworkInterfaceAttribute", "ec2:DescribeNetworkInterfacePermissions", "ec2:DescribeNetworkInterfaces", "ec2:DescribePlacementGroups", "ec2:DescribePrefixLists", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroupReferences", "ec2:DescribeSecurityGroupRules", "ec2:DescribeSecurityGroups", "ec2:DescribeStaleSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeTags", "ec2:DescribeVpcAttribute", "ec2:DescribeVpcClassicLink", "ec2:DescribeVpcClassicLinkDnsSupport", "ec2:DescribeVpcEndpointConnectionNotifications", "ec2:DescribeVpcEndpointConnections", "ec2:DescribeVpcEndpointServiceConfigurations", "ec2:DescribeVpcEndpointServicePermissions", "ec2:DescribeVpcEndpointServices", "ec2:DescribeVpcEndpoints", "ec2:DescribeVpcPeeringConnections", Permission templates 137 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "ec2:DescribeVpcs", "ec2:DescribeVpnConnections", "ec2:DescribeVpnGateways", "ec2:DescribePublicIpv4Pools", "ec2:DescribeIpv6Pools", "ec2:DetachInternetGateway", "ec2:DetachNetworkInterface", "ec2:DetachVpnGateway", "ec2:DisableVgwRoutePropagation", "ec2:DisableVpcClassicLinkDnsSupport", "ec2:DisassociateAddress", "ec2:DisassociateRouteTable", "ec2:DisassociateSubnetCidrBlock", "ec2:DisassociateVpcCidrBlock", "ec2:EnableVgwRoutePropagation", "ec2:EnableVpcClassicLinkDnsSupport", "ec2:ModifyNetworkInterfaceAttribute", "ec2:ModifySecurityGroupRules", "ec2:ModifySubnetAttribute", "ec2:ModifyVpcAttribute", "ec2:ModifyVpcEndpoint", "ec2:ModifyVpcEndpointConnectionNotification", "ec2:ModifyVpcEndpointServiceConfiguration", "ec2:ModifyVpcEndpointServicePermissions", "ec2:ModifyVpcPeeringConnectionOptions", "ec2:ModifyVpcTenancy", "ec2:MoveAddressToVpc", "ec2:RejectVpcEndpointConnections", "ec2:ReleaseAddress", "ec2:ReplaceNetworkAclAssociation", "ec2:ReplaceNetworkAclEntry", "ec2:ReplaceRoute", "ec2:ReplaceRouteTableAssociation", "ec2:ResetNetworkInterfaceAttribute", "ec2:RestoreAddressToClassic", "ec2:UnassignIpv6Addresses", "ec2:UnassignPrivateIpAddresses", "ec2:UpdateSecurityGroupRuleDescriptionsEgress", "ec2:UpdateSecurityGroupRuleDescriptionsIngress", "elasticbeanstalk:Describe", "elasticbeanstalk:List", "elasticbeanstalk:RequestEnvironmentInfo", "elasticbeanstalk:RetrieveEnvironmentInfo", "elasticloadbalancing:", Permission templates 138 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "logs:DescribeLogGroups", "logs:DescribeLogStreams", "logs:GetLogEvents", "route53:", "route53domains:", "sns:CreateTopic", "sns:ListSubscriptionsByTopic", "sns:ListTopics" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "ec2:AcceptVpcPeeringConnection", "ec2:AttachClassicLinkVpc", "ec2:AuthorizeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupIngress", "ec2:CreateVpcPeeringConnection", "ec2:DeleteCustomerGateway", "ec2:DeleteDhcpOptions", "ec2:DeleteInternetGateway", "ec2:DeleteNetworkAcl", "ec2:DeleteNetworkAclEntry", "ec2:DeleteRoute", "ec2:DeleteRouteTable", "ec2:DeleteSecurityGroup", "ec2:DeleteVolume", "ec2:DeleteVpcPeeringConnection", "ec2:DetachClassicLinkVpc", "ec2:DisableVpcClassicLink", "ec2:EnableVpcClassicLink", "ec2:GetConsoleScreenshot", "ec2:RejectVpcPeeringConnection", "ec2:RevokeSecurityGroupEgress", "ec2:RevokeSecurityGroupIngress" ], "Resource": [ "" ] }, { "Effect": "Allow", "Action": [ Permission templates 139 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "ec2:CreateLocalGatewayRoute", "ec2:CreateLocalGatewayRouteTableVpcAssociation", "ec2:DeleteLocalGatewayRoute", "ec2:DeleteLocalGatewayRouteTableVpcAssociation", "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", "ec2:DescribeLocalGatewayRouteTableVpcAssociations", "ec2:DescribeLocalGatewayRouteTables", "ec2:DescribeLocalGatewayVirtualInterfaceGroups", "ec2:DescribeLocalGatewayVirtualInterfaces", "ec2:DescribeLocalGateways", "ec2:SearchLocalGatewayRoutes" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "s3:GetBucketLocation", "s3:GetBucketWebsite", "s3:ListBucket" ], "Resource": [ "" ] }, { "Effect": "Allow", "Action": [ "iam:GetRole", "iam:ListRoles", "iam:PassRole" ], "Resource": "arn:aws:iam:::role/flow-logs-" }, { "Effect": "Allow", "Action": [ "networkmanager:" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ Permission templates 140
tgwnm-042	tgwnm.pdf	42	"ec2:DeleteDhcpOptions", "ec2:DeleteInternetGateway", "ec2:DeleteNetworkAcl", "ec2:DeleteNetworkAclEntry", "ec2:DeleteRoute", "ec2:DeleteRouteTable", "ec2:DeleteSecurityGroup", "ec2:DeleteVolume", "ec2:DeleteVpcPeeringConnection", "ec2:DetachClassicLinkVpc", "ec2:DisableVpcClassicLink", "ec2:EnableVpcClassicLink", "ec2:GetConsoleScreenshot", "ec2:RejectVpcPeeringConnection", "ec2:RevokeSecurityGroupEgress", "ec2:RevokeSecurityGroupIngress" ], "Resource": [ "" ] }, { "Effect": "Allow", "Action": [ Permission templates 139 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "ec2:CreateLocalGatewayRoute", "ec2:CreateLocalGatewayRouteTableVpcAssociation", "ec2:DeleteLocalGatewayRoute", "ec2:DeleteLocalGatewayRouteTableVpcAssociation", "ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", "ec2:DescribeLocalGatewayRouteTableVpcAssociations", "ec2:DescribeLocalGatewayRouteTables", "ec2:DescribeLocalGatewayVirtualInterfaceGroups", "ec2:DescribeLocalGatewayVirtualInterfaces", "ec2:DescribeLocalGateways", "ec2:SearchLocalGatewayRoutes" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "s3:GetBucketLocation", "s3:GetBucketWebsite", "s3:ListBucket" ], "Resource": [ "" ] }, { "Effect": "Allow", "Action": [ "iam:GetRole", "iam:ListRoles", "iam:PassRole" ], "Resource": "arn:aws:iam:::role/flow-logs-" }, { "Effect": "Allow", "Action": [ "networkmanager:" ], "Resource": "" }, { "Effect": "Allow", "Action": [ Permission templates 140 AWS Network Manager AWS Global Networks for Transit Gateways User Guide "ec2:AcceptTransitGatewayVpcAttachment", "ec2:AssociateTransitGatewayRouteTable", "ec2:CreateTransitGateway", "ec2:CreateTransitGatewayRoute", "ec2:CreateTransitGatewayRouteTable", "ec2:CreateTransitGatewayVpcAttachment", "ec2:DeleteTransitGateway", "ec2:DeleteTransitGatewayRoute", "ec2:DeleteTransitGatewayRouteTable", "ec2:DeleteTransitGatewayVpcAttachment", "ec2:DescribeTransitGatewayAttachments", "ec2:DescribeTransitGatewayRouteTables", "ec2:DescribeTransitGatewayVpcAttachments", "ec2:DescribeTransitGateways", "ec2:DisableTransitGatewayRouteTablePropagation", "ec2:DisassociateTransitGatewayRouteTable", "ec2:EnableTransitGatewayRouteTablePropagation", "ec2:ExportTransitGatewayRoutes", "ec2:GetTransitGatewayAttachmentPropagations", "ec2:GetTransitGatewayRouteTableAssociations", "ec2:GetTransitGatewayRouteTablePropagations", "ec2:ModifyTransitGateway", "ec2:ModifyTransitGatewayVpcAttachment", "ec2:RejectTransitGatewayVpcAttachment", "ec2:ReplaceTransitGatewayRoute", "ec2:SearchTransitGatewayRoutes" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "iam:CreateServiceLinkedRole" ], "Resource": "", "Condition": { "StringLike": { "iam:AWSServiceName": [ "transitgateway.amazonaws.com" ] } } } ] Permission templates 141 AWS Network Manager } AWSNetworkManagerReadOnlyAccess AWS Global Networks for Transit Gateways User Guide This policy enables read-only permission for the delegated administrator and management accounts to review information about resources from other accounts in the global network while using the global networks console switch role, but doesn't allow either account to make changes. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "networkmanager:Describe", "networkmanager:Get", "networkmanager:List" ], "Resource": "*" } ] } Permission templates 142 AWS Network Manager AWS Global Networks for Transit Gateways User Guide AWS Global Networks for Transit Gateways Quotas Your AWS account has the quotas shown in the following table for AWS Global Networks for Transit Gateways. The Service Quotas console also provides information about global networks quotas. You can use the Service Quotas console to view default quotas and request quota increases for adjustable quotas. For more information, see Requesting a quota increase in the Service Quotas User Guide. General quotas The following global networks general quotas apply. Quota Default Adjustable Global networks per AWS account Number of devices per global network Number of sites per global network Number of links per global network Number of connections per global network Number of registered delegated administrators for an organization in AWS Organizations 5 200 200 200 200 10 Yes Yes Yes Yes Yes Yes General quotas 143 AWS Network Manager AWS Global Networks for Transit Gateways User Guide Document history for AWS Global Networks for Transit Gateways Change Description Date Support for dual-stack IPv6 endpoints. Network Manager now supports dual-stack IPv6 March 25, 2025 Support PrivateLink. New Region support New Region support endpoints. Network Manager now supports PrivateLink in the us-west-2 and us-gov-west-1 Regions. March 25, 2025 Added ap-southeast-5 to the list of available Regions. March 13, 2025 October 3, 2024 Added me-central-1 , ap-south-2 , ap-southe ast-4 , ca-west-1 , eu- south-2 , and eu-centra l-2 to the list of available Regions. New Region support Added ap-southeast-3 to the list of available Regions. March 26, 2024 Guide renamed November 28, 2022 The Network Manager User Guide was renamed to the AWS Global Networks for Transit Gateways User Guide, as the AWS Network Manager console was reorganized. AWS Global Networks for Transit Gateways are now a part of 144 AWS Network Manager AWS Global Networks for Transit Gateways User Guide the greater-feature Network Manager console. Updated AWS managed policy Network Manager added July 12, 2022 Multi-account support New guide created a new action, GetTransi tGatewayRouteTable Propagations managed policies. , to its AWS Network Manager now supports multi-account, which allows you to centrally manage multiple AWS Organizations accounts and transit gateways in a single global network. Network Manager documenta tion was removed from the AWS Transit Gateway User Guide and included as part of a new, standalone AWS Network Manager User Guide. May 24, 2022 December 2, 2021 Documentation updated for AWS Cloud WAN The AWS Network Manager User Guide was updated, as December 2, 2021 Network Manager supports both AWS Transit Gateways and AWS Cloud WAN. 145
timestream-001	timestream.pdf	1	Developer Guide Amazon Timestream Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon Timestream Developer Guide Amazon Timestream: Developer Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon Timestream Table of Contents Developer Guide ......................................................................................................................................................... xi Amazon Timestream for LiveAnalytics ........................................................................................... 1 Timestream for LiveAnalytics key beneﬁts ............................................................................................. 1 Timestream for LiveAnalytics use cases .................................................................................................. 2 Getting started with Timestream for LiveAnalytics .............................................................................. 2 Amazon Timestream for LiveAnalytics availability change .................................................................. 3 Amazon Timestream for LiveAnalytics availability change ............................................................ 3 Migration Guide ....................................................................................................................................... 5 How it works ............................................................................................................................................... 18 Concepts .................................................................................................................................................. 19 Architecture ............................................................................................................................................ 21 Writes ....................................................................................................................................................... 25 Storage .................................................................................................................................................... 40 Queries .................................................................................................................................................... 41 Scheduled queries ................................................................................................................................. 46 Timestream Compute Unit (TCU) ...................................................................................................... 46 Accessing Timestream for LiveAnalytics ................................................................................................ 55 .................................................................................................................................................................. 55 Using the console ................................................................................................................................. 60 Using the AWS CLI ............................................................................................................................... 65 Using the API ......................................................................................................................................... 69 Using the AWS SDKs ............................................................................................................................ 72 Getting started ........................................................................................................................................... 77 Tutorial .................................................................................................................................................... 77 Sample application ............................................................................................................................... 79 Code samples .............................................................................................................................................. 80 Write SDK client .................................................................................................................................... 81 Query SDK client ................................................................................................................................... 84 Create database .................................................................................................................................... 86 Describe database ................................................................................................................................. 90 Update a database ............................................................................................................................... 94 Delete database .................................................................................................................................... 98 List databases ...................................................................................................................................... 102 Create table ......................................................................................................................................... 107 iii Amazon Timestream Developer Guide Describe table ...................................................................................................................................... 115 Update table ........................................................................................................................................ 119 Delete table ......................................................................................................................................... 123 List tables ............................................................................................................................................. 127 Write data ............................................................................................................................................ 132 Run query ............................................................................................................................................. 187 Run UNLOAD query ........................................................................................................................... 212 Cancel query ........................................................................................................................................ 235 Create batch load task ...................................................................................................................... 238 Describe batch load task .................................................................................................................. 252 List batch load tasks .......................................................................................................................... 257 Resume batch load task .................................................................................................................... 262 Create scheduled query .................................................................................................................... 266 List scheduled query .......................................................................................................................... 282 Describe scheduled query ................................................................................................................. 286 Execute scheduled query .................................................................................................................. 289 Update scheduled query ................................................................................................................... 293 Delete scheduled query .................................................................................................................... 296 Using batch load ...................................................................................................................................... 299 Concepts ............................................................................................................................................... 299 Prerequisites ........................................................................................................................................ 300 Best practices ...................................................................................................................................... 302 Preparing a batch load data ﬁle ..................................................................................................... 303 Data model mappings ....................................................................................................................... 304 Using batch load with the console ................................................................................................. 308 Using batch load with the CLI ......................................................................................................... 312 Using batch load with the SDKs ..................................................................................................... 320 Using batch load error reports ........................................................................................................ 320 Using scheduled queries ......................................................................................................................... 321 Beneﬁts ................................................................................................................................................. 322 Use cases .............................................................................................................................................. 322 Example ................................................................................................................................................ 323 Concepts ............................................................................................................................................... 323 Schedule expressions ......................................................................................................................... 327 Data model mappings ....................................................................................................................... 331 Notiﬁcation messages ........................................................................................................................ 350 iv Amazon Timestream Developer Guide Error reports ........................................................................................................................................ 356 Patterns and examples ...................................................................................................................... 360 Using UNLOAD ......................................................................................................................................... 459 Beneﬁts ................................................................................................................................................. 460 Use cases .............................................................................................................................................. 460 Concepts ............................................................................................................................................... 461 Prerequisites ........................................................................................................................................ 471 Best practices ...................................................................................................................................... 473 Example use case ............................................................................................................................... 474 Limits ..................................................................................................................................................... 479 Using query insights ............................................................................................................................... 480 Beneﬁts ................................................................................................................................................. 480 Optimizing data access ..................................................................................................................... 480 Enabling query insights in Amazon Timestream ......................................................................... 485 Optimizing queries ............................................................................................................................. 486 Working with AWS Backup .................................................................................................................... 490 How it works ....................................................................................................................................... 491 Creating backups ................................................................................................................................ 495 Restoring backups .............................................................................................................................. 497 Copying backups ................................................................................................................................. 498 Deleting backups ................................................................................................................................ 499 Quotas and limits ............................................................................................................................... 499 Customer-deﬁned partition keys .......................................................................................................... 500 Using customer-deﬁned partition keys .......................................................................................... 500 Getting started with customer-deﬁned partition keys ............................................................... 501 Checking partitioning schema conﬁguration ................................................................................ 505 Updating partitioning schema conﬁguration ............................................................................... 511 Advantages of customer-deﬁned partition keys .......................................................................... 514 Limitations of customer-deﬁned partition keys ........................................................................... 514 Customer-deﬁned partition keys and low cardinality dimensions ........................................... 514 Creating partition keys for existing tables .................................................................................... 515 Timestream for LiveAnalytics schema validation with custom composite partition keys .... 515 Tagging resources .................................................................................................................................... 518 Tagging restrictions ............................................................................................................................ 518 Tagging operations ............................................................................................................................ 519 Security ...................................................................................................................................................... 520 v Amazon Timestream Developer Guide Data protection ................................................................................................................................... 521 Identity and access management ................................................................................................... 524 Logging and monitoring ................................................................................................................... 562 Resilience .............................................................................................................................................. 566 Infrastructure security ....................................................................................................................... 566 Conﬁguration and vulnerability analysis ....................................................................................... 566 Incident response ............................................................................................................................... 567 VPC endpoints ..................................................................................................................................... 567 Security best practices ...................................................................................................................... 571 Working with other services .................................................................................................................. 572 Amazon DynamoDB ........................................................................................................................... 573 AWS Lambda ....................................................................................................................................... 574 AWS IoT Core ...................................................................................................................................... 576 Amazon Managed Service for Apache Flink ................................................................................. 580 Amazon Kinesis ................................................................................................................................... 582 Amazon MQ ......................................................................................................................................... 589 Amazon MSK ....................................................................................................................................... 590 Amazon QuickSight ............................................................................................................................ 592 Amazon SageMaker AI ....................................................................................................................... 596 Amazon SQS ........................................................................................................................................ 599 DBeaver ................................................................................................................................................. 599 Grafana ................................................................................................................................................. 604 SquaredUp ............................................................................................................................................ 605 Open source Telegraf ........................................................................................................................ 606 JDBC ...................................................................................................................................................... 611 ODBC ..................................................................................................................................................... 627 VPC endpoints ..................................................................................................................................... 635 Best practices ............................................................................................................................................ 635 Data modeling ..................................................................................................................................... 636 Security ................................................................................................................................................ 653 Conﬁguring Timestream for LiveAnalytics .................................................................................... 654 Writes .................................................................................................................................................... 655 Queries .................................................................................................................................................. 656 Scheduled queries .............................................................................................................................. 657 Client applications and supported integrations ........................................................................... 658
timestream-002	timestream.pdf	2	AWS Lambda ....................................................................................................................................... 574 AWS IoT Core ...................................................................................................................................... 576 Amazon Managed Service for Apache Flink ................................................................................. 580 Amazon Kinesis ................................................................................................................................... 582 Amazon MQ ......................................................................................................................................... 589 Amazon MSK ....................................................................................................................................... 590 Amazon QuickSight ............................................................................................................................ 592 Amazon SageMaker AI ....................................................................................................................... 596 Amazon SQS ........................................................................................................................................ 599 DBeaver ................................................................................................................................................. 599 Grafana ................................................................................................................................................. 604 SquaredUp ............................................................................................................................................ 605 Open source Telegraf ........................................................................................................................ 606 JDBC ...................................................................................................................................................... 611 ODBC ..................................................................................................................................................... 627 VPC endpoints ..................................................................................................................................... 635 Best practices ............................................................................................................................................ 635 Data modeling ..................................................................................................................................... 636 Security ................................................................................................................................................ 653 Conﬁguring Timestream for LiveAnalytics .................................................................................... 654 Writes .................................................................................................................................................... 655 Queries .................................................................................................................................................. 656 Scheduled queries .............................................................................................................................. 657 Client applications and supported integrations ........................................................................... 658 General ................................................................................................................................................ 659 vi Amazon Timestream Developer Guide Metering and cost optimization ........................................................................................................... 659 Writes .................................................................................................................................................... 659 Storage .................................................................................................................................................. 662 Queries .................................................................................................................................................. 663 Cost optimization ............................................................................................................................... 663 Monitoring with Amazon CloudWatch ........................................................................................... 664 Troubleshooting ....................................................................................................................................... 680 Handling WriteRecords throttles ................................................................................................... 680 Handling rejected records ............................................................................................................... 680 Troubleshooting UNLOAD ................................................................................................................. 681 Timestream for LiveAnalytics speciﬁc error codes ..................................................................... 683 Quotas ........................................................................................................................................................ 685 Default quotas ..................................................................................................................................... 685 Service limits ....................................................................................................................................... 686 Supported data types ........................................................................................................................ 690 Batch load ............................................................................................................................................ 690 Naming constraints ............................................................................................................................ 691 Reserved keywords ............................................................................................................................. 693 System identiﬁers ............................................................................................................................... 695 UNLOAD ................................................................................................................................................ 695 Query language reference ..................................................................................................................... 696 Supported data types ........................................................................................................................ 697 Built-in time series functionality ..................................................................................................... 700 SQL support ......................................................................................................................................... 714 Logical operators ................................................................................................................................ 723 Comparison operators ....................................................................................................................... 725 Comparison functions ........................................................................................................................ 725 Conditional expressions ..................................................................................................................... 728 Conversion functions ......................................................................................................................... 730 Mathematical operators .................................................................................................................... 731 Mathematical functions ..................................................................................................................... 731 String operators .................................................................................................................................. 734 String functions .................................................................................................................................. 735 Array operators ................................................................................................................................... 738 Array functions .................................................................................................................................... 739 Bitwise functions ................................................................................................................................ 747 vii Amazon Timestream Developer Guide Regular expression functions ........................................................................................................... 749 Date / time operators ........................................................................................................................ 754 Date / time functions ........................................................................................................................ 756 Aggregate functions ........................................................................................................................... 773 Window functions ............................................................................................................................... 788 Sample queries .................................................................................................................................... 792 API reference ............................................................................................................................................. 805 Actions .................................................................................................................................................. 806 Data Types ........................................................................................................................................... 947 Common Errors ................................................................................................................................. 1063 Common Parameters ....................................................................................................................... 1064 Document history .................................................................................................................................. 1067 Amazon Timestream for InﬂuxDB ............................................................................................ 1074 DB instances ........................................................................................................................................... 1074 DB instance classes ............................................................................................................................... 1076 DB instance class types ........................................................................................................................ 1076 Hardware speciﬁcations ....................................................................................................................... 1076 Instance Storage .................................................................................................................................... 1078 InﬂuxDB storage types .................................................................................................................... 1078 Instance sizing ................................................................................................................................... 1078 Regions and Availability Zones ........................................................................................................... 1079 Regions availability .......................................................................................................................... 1081 Regions design .................................................................................................................................. 1083 Availability Zones ............................................................................................................................. 1083 Billing ....................................................................................................................................................... 1084 Setting up ............................................................................................................................................... 1084 Sign up for AWS ............................................................................................................................... 1084 Setting up .......................................................................................................................................... 1085 Determine requirements ................................................................................................................. 1087 VPC access ......................................................................................................................................... 1089 Getting started ....................................................................................................................................... 1090 Creating and connecting to a Timestream for InﬂuxDB instance ........................................... 1091 Creating a new operator token for your InﬂuxDB instance ..................................................... 1105 Migrating data from self-managed InﬂuxDB to Timestream for InﬂuxDB ................................. 1105 Preparation ........................................................................................................................................ 1106 How to use scripts ........................................................................................................................... 1107 viii Amazon Timestream Developer Guide Migration Overview ......................................................................................................................... 1110 Conﬁguring a DB instance ................................................................................................................... 1114 Creating a DB instance .................................................................................................................... 1114 Settings for DB instances ............................................................................................................... 1117 Connecting to an Amazon Timestream for InﬂuxDB DB instance .......................................... 1121 Working with read replica clusters .................................................................................................... 1156 Instance class availability ............................................................................................................... 1156 Read replica cluster architecture .................................................................................................. 1157 Parameter groups ............................................................................................................................. 1158 Replica lag ......................................................................................................................................... 1159 Availability and durability .............................................................................................................. 1160 Read replicas cluster overview ...................................................................................................... 1160 Creating a read replica cluster ...................................................................................................... 1164 Connecting to a read replica DB cluster ..................................................................................... 1178 Modifying a read replica cluster ................................................................................................... 1180 Creating CloudWatch alarms to monitor Timestream for InﬂuxDB ....................................... 1184 Read replica licensing through AWS Marketplace ..................................................................... 1189 Managing DB instances ........................................................................................................................ 1194 Updating DB instances .................................................................................................................... 1194 Maintaining a DB instance ............................................................................................................. 1196 Deleting a DB instance .................................................................................................................... 1197 Multi-AZ DB instance deployments .............................................................................................. 1198 Setup to view InﬂuxDB Logs on Timestream Inﬂuxdb Instances ........................................... 1202 Tagging resources .................................................................................................................................. 1204 Tagging restrictions ......................................................................................................................... 1204 Best practices for Timestream for InﬂuxDB ..................................................................................... 1205 Optimize writes to InﬂuxDB .......................................................................................................... 1205 Design for performance .................................................................................................................. 1206 Troubleshooting ..................................................................................................................................... 1209 Warning of "dev" version not recognized ................................................................................... 1209 Migration failed during restoration stage ................................................................................... 1209 Amazon Timestream for InﬂuxDB basic operational guidelines ............................................. 1210 DB instance RAM recommendations ............................................................................................ 1210 Security .................................................................................................................................................... 1211 Overview ............................................................................................................................................ 1212 Database authentication with Amazon Timestream for InﬂuxDB .......................................... 1215 ix Amazon Timestream Developer Guide How Timestream for InﬂuxDB uses secrets ................................................................................ 1217 Data protection ................................................................................................................................. 1223 Identity and Access Management ................................................................................................. 1225 Logging and monitoring ................................................................................................................. 1264 Compliance validation ..................................................................................................................... 1267 Resilience ............................................................................................................................................ 1267 Infrastructure security ..................................................................................................................... 1268 Conﬁguration and vulnerability analysis in Timestream for InﬂuxDB ................................... 1268 Incident response ............................................................................................................................. 1269 Amazon Timestream for InﬂuxDB API and interface VPC endpoints (AWS PrivateLink) .... 1269 Security best practices .................................................................................................................... 1272 Working with other services ............................................................................................................... 1274 InﬂuxDB portals ................................................................................................................................ 1274 DBeaver .............................................................................................................................................. 1275 Grafana ............................................................................................................................................... 1275 API reference .......................................................................................................................................... 1281 Document history .................................................................................................................................. 1281 x Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics will no longer be open to new customers starting June 20, 2025. If you would like to use Amazon Timestream for
timestream-003	timestream.pdf	3	monitoring ................................................................................................................. 1264 Compliance validation ..................................................................................................................... 1267 Resilience ............................................................................................................................................ 1267 Infrastructure security ..................................................................................................................... 1268 Conﬁguration and vulnerability analysis in Timestream for InﬂuxDB ................................... 1268 Incident response ............................................................................................................................. 1269 Amazon Timestream for InﬂuxDB API and interface VPC endpoints (AWS PrivateLink) .... 1269 Security best practices .................................................................................................................... 1272 Working with other services ............................................................................................................... 1274 InﬂuxDB portals ................................................................................................................................ 1274 DBeaver .............................................................................................................................................. 1275 Grafana ............................................................................................................................................... 1275 API reference .......................................................................................................................................... 1281 Document history .................................................................................................................................. 1281 x Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics will no longer be open to new customers starting June 20, 2025. If you would like to use Amazon Timestream for LiveAnalytics, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Timestream for LiveAnalytics availability change. xi Amazon Timestream Developer Guide What is Amazon Timestream for LiveAnalytics? Amazon Timestream for LiveAnalytics is a fast, scalable, fully managed, purpose-built time series database that makes it easy to store and analyze trillions of time series data points per day. Timestream for LiveAnalytics saves you time and cost in managing the lifecycle of time series data by keeping recent data in memory and moving historical data to a cost optimized storage tier based upon user deﬁned policies. Timestream for LiveAnalytics's purpose-built query engine lets you access and analyze recent and historical data together, without having to specify its location. Amazon Timestream for LiveAnalytics has built-in time series analytics functions, helping you identify trends and patterns in your data in near real-time. Timestream for LiveAnalytics is serverless and automatically scales up or down to adjust capacity and performance. Because you don't need to manage the underlying infrastructure, you can focus on optimizing and building your applications. Timestream for LiveAnalytics also integrates with commonly used services for data collection, visualization, and machine learning. You can send data to Amazon Timestream for LiveAnalytics using AWS IoT Core, Amazon Kinesis, Amazon MSK, and open source Telegraf. You can visualize data using QuickSight, Grafana, and business intelligence tools through JDBC. You can also use Amazon SageMaker AI with Timestream for LiveAnalytics for machine learning. Timestream for LiveAnalytics key beneﬁts The key beneﬁts of Amazon Timestream for LiveAnalytics are: • Serverless with auto-scaling - With Amazon Timestream for LiveAnalytics, there are no servers to manage and no capacity to provision. As the needs of your application change, Timestream for LiveAnalytics automatically scales to adjust capacity. • Data lifecycle management - Amazon Timestream for LiveAnalytics simpliﬁes the complex process of data lifecycle management. It oﬀers storage tiering, with a memory store for recent data and a magnetic store for historical data. Amazon Timestream automates the transfer of data from the memory store to the magnetic store based upon user conﬁgurable policies. • Simpliﬁed data access - With Amazon Timestream for LiveAnalytics, you no longer need to use disparate tools to access recent and historical data. Amazon Timestream for LiveAnalytics's purpose-built query engine transparently accesses and combines data across storage tiers without you having to specify the data location. Timestream for LiveAnalytics key beneﬁts 1 Amazon Timestream Developer Guide • Purpose-built for time series - You can quickly analyze time series data using SQL, with built- in time series functions for smoothing, approximation, and interpolation. Timestream for LiveAnalytics also supports advanced aggregates, window functions, and complex data types such as arrays and rows. • Always encrypted - Amazon Timestream for LiveAnalytics ensures that your time series data is always encrypted, whether at rest or in transit. Amazon Timestream for LiveAnalytics also enables you to specify an AWS KMS customer managed key (CMK) for encrypting data in the magnetic store. • High availability - Amazon Timestream ensures high availability of your write and read requests by automatically replicating data and allocating resources across at least 3 diﬀerent Availability Zones within a single AWS Region. For more information, see the Timestream Service Level Agreement. • Durability - Amazon Timestream ensures durability of your data by automatically replicating your memory and magnetic store data across diﬀerent Availability Zones within a single AWS Region. All of your data is written to disk before acknowledging your write request as complete. Timestream for LiveAnalytics use cases Examples of a growing list of use cases for Timestream for LiveAnalytics include: • Monitoring metrics to improve the performance and availability of your applications. • Storage and analysis of industrial telemetry to streamline equipment management and maintenance. • Tracking user interaction with an application over time. • Storage and analysis of IoT sensor data. Getting started with Timestream for LiveAnalytics We recommend that you begin by reading the following sections: • Tutorial - To create a database populated with sample data sets and run sample queries. • Amazon Timestream for LiveAnalytics concepts - To learn essential Timestream for LiveAnalytics concepts. • Accessing Timestream for LiveAnalytics - To learn how
timestream-004	timestream.pdf	4	for LiveAnalytics include: • Monitoring metrics to improve the performance and availability of your applications. • Storage and analysis of industrial telemetry to streamline equipment management and maintenance. • Tracking user interaction with an application over time. • Storage and analysis of IoT sensor data. Getting started with Timestream for LiveAnalytics We recommend that you begin by reading the following sections: • Tutorial - To create a database populated with sample data sets and run sample queries. • Amazon Timestream for LiveAnalytics concepts - To learn essential Timestream for LiveAnalytics concepts. • Accessing Timestream for LiveAnalytics - To learn how to access Timestream for LiveAnalytics using the console, AWS CLI, or API. Timestream for LiveAnalytics use cases 2 Amazon Timestream Developer Guide • Quotas - To learn about quotas on the number of Timestream for LiveAnalytics components that you can provision. To learn how to quickly begin developing applications for Timestream for LiveAnalytics, see the following: • Using the AWS SDKs • Query language reference Amazon Timestream for LiveAnalytics availability change After careful consideration, we have made the decision to close new customer access to Amazon Timestream for LiveAnalytics, eﬀective 6/20/25. This change will not impact customer workloads running with Amazon Timestream for LiveAnalytics. AWS continues to invest in security, availability, and performance improvements for Amazon Timestream for LiveAnalytics. We recommend evaluating Amazon Timestream for InﬂuxDB as an alternative due to its similar functionality. Topics • Amazon Timestream for LiveAnalytics availability change • Migration Guide Amazon Timestream for LiveAnalytics availability change Since time-series applications have unique requirements and characteristics, we oﬀer a broad framework to help you evaluate various alternatives before diving into speciﬁc implementation details. This high-level guidance serves as a foundation for your decision-making process, with more detailed steps and practical implementations to be covered in subsequent sections. Alternative services evaluation Use-case ﬁts into Amazon Timestream for InﬂuxDB We recommend Timestream for InﬂuxDB, if your Timestream for LiveAnalytics table has less than 10 million cardinality (series keys), meaning the unique combinations of Amazon Timestream for LiveAnalytics concepts or if you can reduce your table's cardinality under 10 million. Timestream for InﬂuxDB gives you access to the capabilities of the open source version Amazon Timestream for LiveAnalytics availability change 3 Amazon Timestream Developer Guide of InﬂuxDB. Choosing this path provides existing time-series functionality such as time-series analytics functions provided by Flux, tasks (equivalent to Scheduled queries) and other similar functions oﬀered by Timestream for LiveAnalytics. Timestream for InﬂuxDB also provides InﬂuxQL (an SQL-like query language) to interact with InﬂuxDB for querying and analyzing your time-series data. Prefer using SQL instead of InﬂuxQL We recommend implementing Amazon Aurora or RDS PostgreSQL. These databases oﬀer full SQL functionality while providing eﬀective time-series data management capabilities. Time-series analytics can either be implemented using the built-in database functions where available, or managed at the application layer. Require high-scale data ingestion (exceeding 1 million records per second) We recommend using Amazon DynamoDB or other AWS NoSQL databases. These databases can be selected based on your speciﬁc application needs. Time-series analytics can either be implemented using the built-in database functions where available, or managed at the application layer. Before beginning your data migration to the chosen alternate AWS service, it is crucial to assess several key factors that will signiﬁcantly inﬂuence your migration strategy and its ultimate success. These evaluations will help shape your approach, identify potential challenges, and ensure a smoother transition during the migration process. Data selection and retention considerations Assess your data migration scope by deﬁning exact retention requirements. Consider whether you need to migrate the complete historical dataset, recent data only (such as the last 30, 60, or 90 days), or speciﬁc time-series data segments. This decision should be guided by three key factors: regulatory compliance requirements, analytical needs of your business, and practical considerations around migration complexity and costs. Query pattern compatibility analysis Query compatibility between your source (Timestream for LiveAnalytics) and target service requires thorough evaluation, as time-series databases handle query languages and features diﬀerently. Conduct comprehensive testing to identify syntax diﬀerences, functional gaps, and performance variations between systems. Test all business-critical queries or if possible all queries that your applications rely on to ensure they will function correctly after migration and are performant. Amazon Timestream for LiveAnalytics availability change 4 Amazon Timestream Data transformation planning Developer Guide Before migrating, pay close attention to schema mapping to ensure proper data alignment and structural consistency between source and target systems, and accurate data type conversions speciﬁcally tailored for time-series data. These components work together to ensure data quality, optimize performance, and maintain functionality across diﬀerent system architectures. In addition, consider any specialized indexing patterns and system-speciﬁc optimizations to guarantee eﬃcient data access and retrieval. Continuity and downtime management Since data migration inherently causes operational disruption, developing a comprehensive switchover strategy
timestream-005	timestream.pdf	5	after migration and are performant. Amazon Timestream for LiveAnalytics availability change 4 Amazon Timestream Data transformation planning Developer Guide Before migrating, pay close attention to schema mapping to ensure proper data alignment and structural consistency between source and target systems, and accurate data type conversions speciﬁcally tailored for time-series data. These components work together to ensure data quality, optimize performance, and maintain functionality across diﬀerent system architectures. In addition, consider any specialized indexing patterns and system-speciﬁc optimizations to guarantee eﬃcient data access and retrieval. Continuity and downtime management Since data migration inherently causes operational disruption, developing a comprehensive switchover strategy is crucial for success. Few best practices to consider in the migration plan to minimize downtime are: • Implement temporary parallel processing systems where possible to maintain business continuity. • Schedule migrations during low-traﬃc periods such as weekends or overnight hours. • Establish well-tested rollback procedures for quick recovery in case of unexpected issues. Migration Guide This guide presents two approaches for migrating time-series data from Amazon Timestream for LiveAnalytics to Timestream for InﬂuxDB, and to Aurora or RDS PostgreSQL with a intermediate layer for Amazon S3. For migrations to other database services, we recommend consulting the speciﬁc documentation for importing data from S3 into your chosen service. In this guide, we walk through following steps: 1. Export your data from Timestream for LiveAnalytics to Amazon S3. 2. Ingesting data to Timestream for InﬂuxDB. 3. Ingestion data to PostgreSQL. Topics • Exporting Timestream data to Amazon S3 • Timestream for InﬂuxDB as a Target Migration Guide 5 Amazon Timestream Developer Guide • Aurora/RDS Postgres as a target Exporting Timestream data to Amazon S3 Irrespective of the target service for migration, we recommend following the below best practices for exporting your Timestream for LiveAnalytics data to Amazon S3, creating a durable intermediate storage layer that serves as the foundation for subsequent database-speciﬁc ingestion. To reliably export data from Timestream for LiveAnalytics tables to Amazon S3, we recommend using Timestream for LiveAnalytics export tool, which uses the Timestream UNLOAD feature — designed for large-scale data exports. Timestream for LiveAnalytics export tool Time-based chunking strategy Time-based chunking is essential when migrating large volumes of time-series data. This approach breaks down the export process into manageable units that can be independently processed and re-tried on failures, signiﬁcantly reducing migration risks. It creates checkpoints for easier progress tracking and adds the ability to resume after interruptions. For organizations with continuous data ingestion, this allows newer data to be exported in separate time chunks, enabling better coordination between ongoing operations and migration. The tool uses day-based chunking, storing each day's data with S3 bucket preﬁx for eﬃcient management. Additionally, chunking can be based on hour, day, month, or year. Monitoring migration The tool provides an option to capture the migration statistics in a DynamoDB table, tracking metrics such as conﬁgurations used, records exported, and other data points for validating the completeness of your migration. We recommend monitoring these metrics closely during your migration and validation. You can also use the logging provided within your orchestration script, capturing execution timestamps, chunk boundaries, and any error conditions encountered. The tool also provides SNS notiﬁcation if you want to integrate your downstream system to take action on failures. Recommendations and best practices The Timestream for LiveAnalytics export tool provides a ﬂexible and robust solution for exporting data to S3 with various conﬁguration options tailored to your target system requirements. If your Migration Guide 6 Amazon Timestream Developer Guide target is Timestream for InﬂuxDB, use Parquet format without compression to ensure compatibility with ingestion scripts. For optimal tracking and monitoring, enable DynamoDB logging and conﬁgure SNS notiﬁcations to receive alerts about export failures or completions. The tool leverages the Timestream for LiveAnalytics UNLOAD feature while overcoming its partition for query limitations by automatically exporting data in batches based on your speciﬁed time range. You can customize data partitioning by hour, day, month, or year, day being the default. Each partition must remain under approximately 350 GB to avoid memory-related errors, such as query computation exceeding maximum available memory. For example, if your yearly data exceeds 350 GB, consider using monthly partitions or even more granular options like daily or hourly partitioning. If you choose hourly and still get a "The query computation exceeds maximum available memory" error, you can reduce the number of partitions, making sure your exports are successful. The tool oﬀers ﬂexibility in the scope of export, allowing you to export a single table, an entire database, or all databases in your account. For more specialized requirements, such as exporting multiple speciﬁc databases, you can build a custom wrapper around this automation. Additionally, you can choose to export the most recent data ﬁrst by enabling the reverse chronological order option. When restarting after failures, you can either continue
timestream-006	timestream.pdf	6	partitioning. If you choose hourly and still get a "The query computation exceeds maximum available memory" error, you can reduce the number of partitions, making sure your exports are successful. The tool oﬀers ﬂexibility in the scope of export, allowing you to export a single table, an entire database, or all databases in your account. For more specialized requirements, such as exporting multiple speciﬁc databases, you can build a custom wrapper around this automation. Additionally, you can choose to export the most recent data ﬁrst by enabling the reverse chronological order option. When restarting after failures, you can either continue with the same migration tag to keep all ﬁles under the same S3 preﬁx or omit the tag to create ﬁles under a new preﬁx. As the tool exports the data in batches, if you encounter failures we recommend starting from the failed batch rather than restarting from the original start time. If you don't specify an end timestamp, the tool automatically uses the current timestamp (UTC) to ensure consistent exports and validation. Basic commands Example : Export a table with DynamoDB logging enabled python3.9 unload.py \ --export-table \ --database Demo \ --table Demo \ --start-time '2020-03-26 17:24:38' \ --enable-dynamodb_logger true Example : Export entire database python3.9 unload.py \ --export-database \ Migration Guide 7 Amazon Timestream Developer Guide --database Demo \ --start-time '2020-03-26 17:24:38' Example : Export all databases python3.9 unload.py \ --export-all_databases \ --start-time '2020-03-26 17:24:38' Example : Advanced export with more options python unload.py \ --export-table \ --database MyDB \ --table MyTable \ --start-time '2024-05-14 00:00:00' \ --end-time '2025-05-14 00:00:00' \ --partition month \ --export-format PARQUET \ --compression GZIP \ --region us-east-1 \ --s3-uri s3://my-bucket \ --enable-dynamodb_logger \ --sns-topic_arn arn:aws:sns:region:account-id:topic-name For more information, see the unload script's README. Timestream for InﬂuxDB as a Target Amazon Timestream for InﬂuxDB is a managed time-series database service on AWS that uses open-source InﬂuxDB APIs for real-time applications. It oﬀers easy setup, operation, and scaling, delivering queries with single-digit millisecond response times. The ﬁrst step for determining whether Timestream for InﬂuxDB is an appropriate migration target for your use-case is determining the cardinality of your Timestream for LiveAnalytics table. We have developed a script that calculates table cardinality in Timestream for LiveAnalytics. This calculation serves two purposes: 1. Checks if the cardinality is under 10 million, which will help determine whether Timestream for InﬂuxDB can handle your use-case. Migration Guide 8 Amazon Timestream Developer Guide 2. Helps you decide which Timestream for InﬂuxDB Instance type to use. Cardinality in InﬂuxDB is the number of unique measurements, tags, and ﬁeld key combinations in an InﬂuxDB bucket. Refer to Timestream for InﬂuxDB's documentation on cardinality management to understand how exceeding recommended limits can degrade query performance and increase memory consumption. Benchmark your anticipated query patterns against representative data samples before ﬁnalizing your instance selection to ensure your queries remain performant post- migration. Pay attention to memory-intensive aggregation queries that might behave diﬀerently than in Timestream for LiveAnalytics. When migrating from Timestream for LiveAnalytics, carefully select your InﬂuxDB instance speciﬁcations based on your dataset's cardinality as this directly impacts performance and resource requirement. We recommend considering other destinations if your data cardinality is more than 10 million. Cardinality calculation script overview The cardinality calculation script calculates the cardinality of a Timestream for LiveAnalytics table. If the cardinality is under 10 million, the script recommends a Timestream for InﬂuxDB instance type. Using the default schema mapping, cardinality is calculated by computing the total unique combinations of dimensions and measure name. Choosing the right line protocol tags (equivalent to dimensions in Timestream for LiveAnalytics) helps you automatically index your data and ﬁlter your data eﬃciently using tags. The script also provides the option to exclude speciﬁc dimensions when calculating cardinality. If applicable to your case that is, if you are not using certain dimensions for ﬁltering data in SQL queries (speciﬁcally not using them as predicates) then you can exclude these dimensions from the cardinality calculation. Later, you can ingest them as ﬁelds (equivalent to measures in Timestream for LiveAnalytics) in the next steps of migration. Prerequisites and installation See the Prerequisites section and installation in the cardinality script's README. Basic usage To determine the cardinality of a table, example_table, in the database example_database the script can be used in the following way: Example python3 cardinality.py \ --table-name example_table \ Migration Guide 9 Amazon Timestream Developer Guide --database-name example_database This produces the following output: Cardinality of "example_database"."example_table": 160 Your recommended Timestream for InfluxDB type is: db.influx.medium Recommendations The script automatically scans the entire table to calculate cardinality while oﬀering time ﬁlter options for optimal query execution. We suggest implementing time ﬁlters when your data involves consistent dimensions and when analyzing distinct dimension variations across the entire table yields similar results to analyzing speciﬁc time ranges. This approach
timestream-007	timestream.pdf	7	a table, example_table, in the database example_database the script can be used in the following way: Example python3 cardinality.py \ --table-name example_table \ Migration Guide 9 Amazon Timestream Developer Guide --database-name example_database This produces the following output: Cardinality of "example_database"."example_table": 160 Your recommended Timestream for InfluxDB type is: db.influx.medium Recommendations The script automatically scans the entire table to calculate cardinality while oﬀering time ﬁlter options for optimal query execution. We suggest implementing time ﬁlters when your data involves consistent dimensions and when analyzing distinct dimension variations across the entire table yields similar results to analyzing speciﬁc time ranges. This approach ensures eﬃcient and performant query execution. For more information, see the cardinality script's README. Ingesting data from Amazon S3 to Timestream for InﬂuxDB automation After the Timestream for LiveAnalytics export tool completes the unload process, the next step in the automation process begins. This automation uses InﬂuxDB's import tools to transfer the data into its specialized time-series structure. The process transforms Timestream's data model to match InﬂuxDB' s concepts of measurements, tags, and ﬁelds. Finally, it loads the data eﬃciently using InﬂuxDB's line protocol. The workﬂow for completing a migration is separated into four stages: 1. Unload data using Timestream for LiveAnalytics export tool. 2. Data transformation: Converting Timestream for LiveAnalytics data into InﬂuxDB line protocol format (Based on the schema deﬁned after the cardinality assessment) using Amazon Athena. 3. Data ingestion: Ingest the line protocol dataset to your Timestream for InﬂuxDB instance. 4. Validation: Optionally, you can validate that every line protocol point has been ingested (Requires --add-validation-field true during data transformation step). Data Transformation For data transformation, we developed a script to convert Timestream for LiveAnalytics exported data parquet format into InﬂuxDB's Line Protocol format using Amazon Athena. Amazon Athena Migration Guide 10 Amazon Timestream Developer Guide provides a serverless query service and a cost-eﬀective way to transform large volumes of time- series data without requiring dedicated compute resources. The script does the following: • Loads exported Timestream for LiveAnalytics data from an Amazon S3 bucket into an Amazon Athena table. • Performs data mapping and transformation from the data stored in the Athena table into line protocol and stores it in the S3 bucket. Data Mapping The following table shows how Timestream for LiveAnalytics data is mapped to line protocol data. Timestream for LiveAnalytics Concept Line Protocol Concept Table Name Dimensions Measure name Measures Time Measurement Tags Tag (Optional) Fields Timestamp Prerequisites and Installation See the Prerequisites and Installation sections in the transformation script’s README. Usage To transform data stored in the bucket example_s3_bucket from the Timestream for LiveAnalytics table example_table in example_database, run the following command: python3 transform.py \ --database-name example_database \ --tables example_table \ --s3-bucket-path example_s3_bucket \ --add-validation-field false Migration Guide 11 Amazon Timestream After the script is completed, Developer Guide • In Athena, the table example_database_example_table will be created, containing Timestream for LiveAnalytics data. • In Athena, the table lp_example_database_example_table will be created, containing Timestream for LiveAnalytics data transformed to line protocol points. • In the S3 bucket example_s3_bucket, within the path example_database/example_table/ unload-<%Y-%m-%d-%H:%M:%S>/line-protocol-output, line protocol data will be stored. Recommendations Refer to the transformation script’s README for more details on the latest usage of the script and outputs are required for later steps of the migration, such as validation. If you excluded dimensions in order to improve cardinality, adjust the schema to reduce cardinality by using the -- dimensions-to-fields argument to change particular dimensions to ﬁelds. Adding a Field for Validation For information on how to add a ﬁeld for validation, see the Adding a Field for Validation section in the transformation script’s README. Data ingestion into Timestream for InﬂuxDB The InﬂuxDB ingestion script ingests compressed line protocol datasets to Timestream for InﬂuxDB. A directory containing gzip compressed line protocol ﬁles is passed in as a command line argument along with the ingestion destination InﬂuxDB bucket. This script was designed to ingest multiple ﬁles at a time using multi-processing to utilize the resources with InﬂuxDB and the machine executing the script. The script does following: • Extracts zipped ﬁles and ingests them into InﬂuxDB. • Implements retry mechanisms and error handling. • Tracks successful and failed ingestions for resuming. • Optimizes I/O operations when reading from line protocol dataset. Prerequisites and installation See the Prerequisites and Installation section in the ingestion script's README in GitHub. Migration Guide 12 Amazon Timestream Data preparation Developer Guide The zipped line protocol ﬁles required for ingestion are generated by the data transform scripts. Follow these steps to prepare your data: 1. Set up an EC2 instance with suﬃcient storage to hold the transformed dataset. 2. Sync the transformed data from the S3 bucket to your local directory: aws s3 sync \ s3://your-bucket-name/path/to/transformed/data \ ./data_directory 3. Make sure you have read access to all ﬁles in the data
timestream-008	timestream.pdf	8	when reading from line protocol dataset. Prerequisites and installation See the Prerequisites and Installation section in the ingestion script's README in GitHub. Migration Guide 12 Amazon Timestream Data preparation Developer Guide The zipped line protocol ﬁles required for ingestion are generated by the data transform scripts. Follow these steps to prepare your data: 1. Set up an EC2 instance with suﬃcient storage to hold the transformed dataset. 2. Sync the transformed data from the S3 bucket to your local directory: aws s3 sync \ s3://your-bucket-name/path/to/transformed/data \ ./data_directory 3. Make sure you have read access to all ﬁles in the data directory. 4. Run the following ingestion script to ingest data into Timestream for InﬂuxDB. Usage python influxdb_ingestion.py <bucket_name> <data_directory> [options] Basic usage python influxdb_ingestion.py my_bucket ./data_files Ingestion rates We have run some tests for Ingestion rates. Ingestion tests using a C5N.9XL EC2 instance executing the ingestion script with 10 Workers, and ingesting ~500 GB line protocol to 8XL Timestream for InﬂuxDB instances: • 3K IOPS 15.86 GB/hour. • 12K IOPS 70.34 GB/hour. • 16K IOPS 71.28 GB/hour. Recommendations • Use an EC2 instance with suﬃcient CPU cores to handle parallel processing. • Ensure the instance has enough storage to hold the entire transformed dataset with additional room for extraction. Migration Guide 13 Amazon Timestream Developer Guide • The number of ﬁles extracted at one time is equal to the number of workers conﬁgured during script execution. • Position the EC2 instance in the same region and AZ (if possible) as your InﬂuxDB instance to minimize latency. • Consider using instance types optimized for network operations, for example C5N. • If high ingestion rates are required, at least 12K IOPS is recommended for the Timestream for InﬂuxDB instance. Additional optimizations can be gained by increasing the worker count for the script dependent on Timestream for InﬂuxDB instance size. For more information, see the ingestion script's README. Migration validation script The validation script compares logical row/point counts between a source table (Amazon Timestream or Amazon Athena) and an InﬂuxDB bucket measurement, with optional time-range speciﬁcations. This tool helps ensure data integrity during migration processes by running parallel queries against both systems and comparing the results. The validation script supports queries against either the exported dataset in Athena or the original Timestream database/table. Be aware that querying Timestream directly may lead to inaccurate comparisons if data has been written since the export. The validation script can be run anytime after ingestion has begun. It ﬁrst polls InﬂuxDB's metrics endpoint to wait for the WAL (Write- Ahead Log) to ﬂush completely, ensuring all data processing, including post-ingestion ﬁle merging and de-duplication, is ﬁnished. The script then executes count-only queries over identical time windows, comparing results to highlight matches or mismatches. It supports optional schema/ tag ﬁltering for transformed schemas where dimensions are used as ﬁelds, and produces human- readable timing and result summaries to facilitate validation of the migration process. Prerequisites and installation See the prerequisites and installation section in the Migration Validation Script README. Usage python validator.py [options] All settings can be supplied as CLI ﬂags or environment variables. See the example.env ﬁle within the repository. Migration Guide 14 Amazon Timestream Developer Guide For troubleshooting and recommendations see the Migration Validation Script README. Cleanup After ﬁnishing a migration, following resources/artifacts will be created: • An Athena table, containing Timestream for LiveAnalytics data. By default, this is <Timestream database name>_<Timestream table name> in the default Athena database. • An Athena table, containing transformed line protocol data. By default, this is lp_<Athena table name> in the default Athena database. • Line protocol data within your S3 bucket, with the path <Timestream database name>/ <Timestream table name>/unload-<%Y-%m-%d-%H:%M:%S>/line-protocol-output. • Unloaded data that was created as part of Timestream for LiveAnalytics export tool. • Downloaded data and logs on your EC2 instance. • DynamoDB table if used for logging as part of Timestream for LiveAnalytics export tool. Cleaning up Athena resources To delete any Athena table, run the following AWS CLI command, replacing <Athena table name> with the name of the table that you want to delete and <Athena database name> with the name of the Athena database that the table resides in: aws glue delete-table \ --database-name <Athena database name> \ --name <Athena table name> Cleaning up S3 resources To delete line protocol data within your S3 bucket, run the following AWS CLI command, replacing <S3 bucket name> with the name of your S3 bucket, <Timestream database name> with the name of your Timestream for LiveAnalytics database, <Timestream table name> with the name of your Timestream for LiveAnalytics table, and <timestamp> with the timestamp that forms the unload-< %Y-%m-%d-%H:%M:%S> path in your S3 bucket: aws s3 rm \ s3://<S3 bucket name>/<Timestream database name>/<Timestream table name>/unload- <timestamp>/line-protocol-output \ --recursive Migration Guide 15 Amazon Timestream Developer Guide To delete
timestream-009	timestream.pdf	9	<Athena database name> \ --name <Athena table name> Cleaning up S3 resources To delete line protocol data within your S3 bucket, run the following AWS CLI command, replacing <S3 bucket name> with the name of your S3 bucket, <Timestream database name> with the name of your Timestream for LiveAnalytics database, <Timestream table name> with the name of your Timestream for LiveAnalytics table, and <timestamp> with the timestamp that forms the unload-< %Y-%m-%d-%H:%M:%S> path in your S3 bucket: aws s3 rm \ s3://<S3 bucket name>/<Timestream database name>/<Timestream table name>/unload- <timestamp>/line-protocol-output \ --recursive Migration Guide 15 Amazon Timestream Developer Guide To delete an S3 bucket, run the following command, replacing <S3 bucket name> with the name of your S3 bucket: aws s3 delete-bucket --bucket <S3 bucket name> Cleaning up DynamoDB resources To delete a DynamoDB table, run the following command, replacing <table name> with the name of the DynamoDB table that you want to delete: aws dynamodb delete-table --table-name <table name> Aurora/RDS Postgres as a target This section explains ingesting the S3 staged time-series data into Amazon RDS/Aurora PostgreSQL. The ingestion process will primarily focus on the CSV ﬁles generated from Timestream's export tool to ingest into Postgres. We recommend designing the PostgreSQL schema and table with proper indexing strategies for time-based queries. Use any ETL processes to transform Timestream's specialized structures into relational tables optimized for your speciﬁc requirements. When migrating Timestream data to a relational database, structure your schema with a timestamp column as the primary time index, measurement identiﬁer columns derived from Timestream's measure_name, and dimension columns from Timestream's dimensions and your actual measures. Create strategic indexes on time ranges and frequently queried dimension combinations to optimize performance during data transformation and loading process. When migrating time-series data to PostgreSQL, proper instance sizing is critical for maintaining query performance at scale. Consider your expected data volume, query complexity, and concurrency requirements when selecting an instance class, with particular attention to memory allocation for time-series aggregation workloads. For datasets exceeding tens of millions of rows, leverage PostgreSQL's native partitioning capabilities and advanced indexing strategies to optimize for time-series access patterns. We recommend performing functional and performance testing to choose the right instance and tuning your PostgreSQL database to address any performance bottlenecks. Performing rigorous data integrity checks through sample query comparisons between your source Timestream database and target system is critical to ensure migration success and maintain query correctness. By executing identical queries against both systems and comparing results — including record counts, aggregations, and outlier values — you can identify any discrepancies that might indicate transformation errors, data loss, or semantic diﬀerences in query interpretation. This veriﬁcation Migration Guide 16 Amazon Timestream Developer Guide process validates that your data maintains its analytical value post-migration, builds conﬁdence in the new system among stakeholders who rely on these insights, helps identify any necessary query adjustments to accommodate syntax or functional diﬀerences between platforms, and establishes a quantiﬁable baseline for determining when the migration can be considered complete and successful. Without these systematic checks, subtle data inconsistencies might remain undetected, potentially leading to incorrect business decisions or undermining conﬁdence in the entire migration project. Ingestion We recommend using AWSDatabase Migration Service (DMS) with source as S3 (both CSV and Parquet are supported) with PostgreSQL as the target. For scenarios where AWS DMS may not be suitable for your speciﬁc requirements, we provide a supplementary Python-based utility (PostgreSQL CSV Ingestion Tool) for migrating CSV data from S3 to PostgreSQL. Overview of PostgreSQL CSV ingestion tool The PostgreSQL CSV Ingestion Tool, is a high-performance utility designed to eﬃciently load CSV ﬁles into PostgreSQL databases. It leverages multi-threading and connection pooling to process multiple ﬁles in parallel, signiﬁcantly reducing data loading time. We recommend to running this script using an EC2 instance. Consider using instance types optimized for network operations, such as C5N. Key features • Multi-threaded Processing: Loads multiple CSV ﬁles simultaneously. • Connection Pooling: Eﬃciently manages database connections. • Automatic Column Detection: Dynamically extracts column names from CSV headers. • Retry Logic: Handles transient errors with exponential backoﬀ. • File Management; Moves processed ﬁles to a designated directory so retrying is resuming but not restarting. • Comprehensive Logging: Detailed logs for monitoring and troubleshooting. • Error Notiﬁcations: Optional SNS notiﬁcations for failures. • Secure Credentials: Retrieves database passwords from AWS Secrets Manager. Prerequisites and installation See prerequisites and installation in the PostgreSQL CSV Ingestion Tool Readme in GitHub. Migration Guide 17 Amazon Timestream Usage python copy_postgres.py \ --database 'postgres_testing' \ --table 'demolarge_restored' \ Developer Guide --csv-files-dir '/data/csv_files/partition/*.csv' \ --host database-1.cluster-xxxxxxxx.us-east-1.rds.amazonaws.com \ --secret-arn 'arn:aws:secretsmanager:<region>:<account_id>:secret:rds!cluster- xxxxx-xx-xx-xx-xxxxxxxx-xxxxx' \ --sns-topic-arn 'arn:aws:sns:<region>:<account_id>:<topic_name>' Validation You can use DynamoDB for exported rows or logs generated by Timestream's export tool and compare against rows ingested from PostgreSQL Ingestion automation logs. You can do select counts against the source and target tables
timestream-010	timestream.pdf	10	troubleshooting. • Error Notiﬁcations: Optional SNS notiﬁcations for failures. • Secure Credentials: Retrieves database passwords from AWS Secrets Manager. Prerequisites and installation See prerequisites and installation in the PostgreSQL CSV Ingestion Tool Readme in GitHub. Migration Guide 17 Amazon Timestream Usage python copy_postgres.py \ --database 'postgres_testing' \ --table 'demolarge_restored' \ Developer Guide --csv-files-dir '/data/csv_files/partition/*.csv' \ --host database-1.cluster-xxxxxxxx.us-east-1.rds.amazonaws.com \ --secret-arn 'arn:aws:secretsmanager:<region>:<account_id>:secret:rds!cluster- xxxxx-xx-xx-xx-xxxxxxxx-xxxxx' \ --sns-topic-arn 'arn:aws:sns:<region>:<account_id>:<topic_name>' Validation You can use DynamoDB for exported rows or logs generated by Timestream's export tool and compare against rows ingested from PostgreSQL Ingestion automation logs. You can do select counts against the source and target tables with the consistent export and import time, if the data is being continuously ingested during the migration process the counts will vary so the recommendation is to compare rows exported and rows important from logging. Cleanup • Cleanup unloaded data that was created as part of Timestream for LiveAnalytics export tool. • Delete downloaded data and logs on EC2 to reclaim the space. • Delete DynamoDB table if used for logging as part of Timestream for LiveAnalytics export tool. How it works The following sections provide an overview of Amazon Timestream for Live Analytics service components and how they interact. After you read this introduction, see the Accessing Timestream for LiveAnalytics sections to learn how to access Timestream for Live Analytics using the console, AWS CLI, or SDKs. Topics • Amazon Timestream for LiveAnalytics concepts • Architecture • Writes • Storage How it works 18 Amazon Timestream • Queries • Scheduled queries • Timestream Compute Unit (TCU) Developer Guide Amazon Timestream for LiveAnalytics concepts Time series data is a sequence of data points recorded over a time interval. This type of data is used for measuring events that change over time. Examples include the following. • Stock prices over time • Temperature measurements over time • CPU utilization of an EC2 instance over time With time series data, each data point consists of a timestamp, one or more attributes, and the event that changes over time. This data can be used to derive insights into the performance and health of an application, detect anomalies, and identify optimization opportunities. For example, DevOps engineers might want to view data that measures changes in infrastructure performance metrics. Manufacturers might want to track IoT sensor data that measures changes in equipment across a facility. Online marketers might want to analyze clickstream data that captures how a user navigates a website over time. Because time series data is generated from multiple sources in extremely high volumes, it needs to be cost-eﬀectively collected in near real time, and therefore requires eﬃcient storage that helps organize and analyze the data. Following are the key concepts of Timestream for LiveAnalytics. • Time series - A sequence of one or more data points (or records) recorded over a time interval. Examples are the price of a stock over time, the CPU or memory utilization of an EC2 instance over time, and the temperature/pressure reading of an IoT sensor over time. • Record - A single data point in a time series. • Dimension - An attribute that describes the meta-data of a time series. A dimension consists of a dimension name and a dimension value. Consider the following examples: • When considering a stock exchange as a dimension, the dimension name is "stock exchange" and the dimension value is "NYSE" • When considering an AWS Region as a dimension, the dimension name is "region" and the dimension value is "us-east-1" Concepts 19 Amazon Timestream Developer Guide • For an IoT sensor, the dimension name is "device ID" and the dimension value is "12345" • Measure - The actual value being measured by the record. Examples are the stock price, the CPU or memory utilization, and the temperature or humidity reading. Measures consist of measure names and measure values. Consider the following examples: • For a stock price, the measure name is "stock price" and the measure value is the actual stock price at a point in time. • For CPU utilization, the measure name is "CPU utilization" and the measure value is the actual CPU utilization. Measures can be modeled in Timestream for LiveAnalytics as multi-measure or single-measure records. For more information, see Multi-measure records vs. single-measure records. • Timestamp - Indicates when a measure was collected for a given record. Timestream for LiveAnalytics supports timestamps with nanosecond granularity. • Table - A container for a set of related time series. • Database - A top level container for tables. A summary of Timestream for LiveAnalytics concepts A database contains 0 or more tables. Each table contains 0 or more time series. Each time series consists of a sequence of records over a given time interval at a speciﬁed granularity. Each time series can be described using its meta-data
timestream-011	timestream.pdf	11	For more information, see Multi-measure records vs. single-measure records. • Timestamp - Indicates when a measure was collected for a given record. Timestream for LiveAnalytics supports timestamps with nanosecond granularity. • Table - A container for a set of related time series. • Database - A top level container for tables. A summary of Timestream for LiveAnalytics concepts A database contains 0 or more tables. Each table contains 0 or more time series. Each time series consists of a sequence of records over a given time interval at a speciﬁed granularity. Each time series can be described using its meta-data or dimensions, its data or measures, and its timestamps. Concepts 20 Amazon Timestream Developer Guide Architecture Amazon Timestream for Live Analytics has been designed from the ground up to collect, store, and process time series data at scale. Its serverless architecture supports fully decoupled data ingestion, storage, and query processing systems that can scale independently. This design simpliﬁes each subsystem, making it easier to achieve unwavering reliability, eliminate scaling bottlenecks, and reduce the chances of correlated system failures. Each of these factors becomes more important as the system scales. Topics • Write architecture • Storage architecture • Query architecture • Cellular architecture Architecture 21 Amazon Timestream Developer Guide Write architecture When writing time-series data, Amazon Timestream for Live Analytics routes writes for a table, partition, to a fault-tolerant memory store instance that processes high throughput data writes. The memory store in turn achieves durability in a separate storage system that replicates the data across three Availability Zones (AZs). Replication is quorum based such that the loss of nodes, or an entire AZ, will not disrupt write availability. In near real-time, other in-memory storage nodes sync to the data in order to serve queries. The reader replica nodes span AZs as well, to ensure high read availability. Architecture 22 Amazon Timestream Developer Guide Timestream for Live Analytics supports writing data directly into the magnetic store, for applications generating lower throughput late-arriving data. Late-arriving data is data with a timestamp earlier than the current time. Similar to the high throughput writes in the memory store, the data written into the magnetic store is replicated across three AZs and the replication is quorum based. Whether data is written to the memory or magnetic store, Timestream for Live Analytics automatically indexes and partitions data before writing it to storage. A single Timestream for Live Analytics table may have hundreds, thousands, or even millions of partitions. Individual partitions do not, directly, communicate with each other and do not share any data (shared- nothing architecture). Instead, the partitioning of a table is tracked through a highly available partition tracking and indexing service. This provides another separation of concerns designed speciﬁcally to minimize the eﬀect of failures in the system and make correlated failures much less likely. Storage architecture When data is stored in Timestream for Live Analytics, data is organized in time order as well as across time based on context attributes written with the data. Having a partitioning scheme that divides "space" in addition to time is important for massively scaling a time series system. This is because most time series data is written at or around the current time. As a result, partitioning by time alone does not do a good job of distributing write traﬃc or allowing for eﬀective pruning of data at query time. This is important for extreme scale time series processing, and it has allowed Timestream for Live Analytics to scale orders of magnitude higher than the other leading systems out there today in serverless fashion. The resulting partitions are referred to as "tiles" because they represent divisions of a two-dimensional space (which are designed to be of a similar size). Timestream for Live Analytics tables start out as a single partition (tile), and then split in the spatial dimension as throughput requires. When tiles reach a certain size, they then split in the time dimension in order to achieve better read parallelism as the data size grows. Timestream for Live Analytics is designed to automatically manage the lifecycle of time series data. Timestream for Live Analytics oﬀers two data stores—an in-memory store and a cost-eﬀective magnetic store. It also supports conﬁguring table-level policies to automatically transfer data across stores. Incoming high throughput data writes land in the memory store where data is optimized for writes, as well as reads performed around current time for powering dashboard and alerting type queries. When the main time frame for writes, alerting, and dashboarding needs has passed, allowing the data to automatically ﬂow from the memory store to the magnetic store to optimize cost. Timestream for Live Analytics allows setting a data retention policy on the memory Architecture 23 Amazon Timestream Developer Guide store for this purpose. Data writes for late-arriving data are
timestream-012	timestream.pdf	12	supports conﬁguring table-level policies to automatically transfer data across stores. Incoming high throughput data writes land in the memory store where data is optimized for writes, as well as reads performed around current time for powering dashboard and alerting type queries. When the main time frame for writes, alerting, and dashboarding needs has passed, allowing the data to automatically ﬂow from the memory store to the magnetic store to optimize cost. Timestream for Live Analytics allows setting a data retention policy on the memory Architecture 23 Amazon Timestream Developer Guide store for this purpose. Data writes for late-arriving data are directly written into the magnetic store. Once the data is available in the magnetic store (because of expiration of the memory store retention period or because of direct writes into the magnetic store), it is reorganized into a format that is highly optimized for large volume data reads. The magnetic store also has a data retention policy that may be conﬁgured if there is a time threshold where the data outlives its usefulness. When the data exceeds the time range deﬁned for the magnetic store retention policy, it is automatically removed. Therefore, with Timestream for Live Analytics, other than some conﬁguration, the data lifecycle management occurs seamlessly behind the scenes. Query architecture Timestream for Live Analytics queries are expressed in a SQL grammar that has extensions for time series-speciﬁc support (time series-speciﬁc data types and functions), so the learning curve is easy for developers already familiar with SQL. Queries are then processed by an adaptive, distributed query engine that uses metadata from the tile tracking and indexing service to seamlessly access and combine data across data stores at the time the query is issued. This makes for an experience that resonates well with customers as it collapses many of the Rube Goldberg complexities into a simple and familiar database abstraction. Queries are run by a dedicated ﬂeet of workers where the number of workers enlisted to run a given query is determined by query complexity and data size. Performance for complex queries over large datasets is achieved through massive parallelism, both on the query runtime ﬂeet and the storage ﬂeets of the system. The ability to analyze massive amounts of data quickly and eﬃciently is one of the greatest strengths of Timestream for Live Analytics. A single query that runs over terabytes or even petabytes of data might have thousands of machines working on it all at the same time. Cellular architecture To ensure that Timestream for Live Analytics can oﬀer virtually inﬁnite scale for your applications, while simultaneously ensuring 99.99% availability, the system is also designed using a cellular architecture. Rather than scaling the system as a whole, Timestream for Live Analytics segments into multiple smaller copies of itself, referred to as cells. This allows cells to be tested at full scale, and prevents a system problem in one cell from aﬀecting activity in any other cells in a given region. While Timestream for Live Analytics is designed to support multiple cells per region, consider the following ﬁctitious scenario, in which there are 2 cells in a region. Architecture 24 Amazon Timestream Developer Guide In the scenario depicted above, the data ingestion and query requests are ﬁrst processed by the discovery endpoint for data ingestion and query, respectively. Then, the discovery endpoint identiﬁes the cell containing the customer data, and directs the request to the appropriate ingestion or query endpoint for that cell. When using the SDKs, these endpoint management tasks are transparently handled for you. Note When using VPC endpoints with Timestream for Live Analytics or directly accessing REST API operations for Timestream for Live Analytics, you will need to interact directly with the cellular endpoints. For guidance on how to do so, see VPC Endpoints for instructions on how to set up VPC endpoints, and Endpoint Discovery Pattern for instructions on direct invocation of the REST API operations. Writes You can collect time series data from connected devices, IT systems, and industrial equipment, and write it into Timestream for Live Analytics. Timestream for Live Analytics enables you to write Writes 25 Amazon Timestream Developer Guide data points from a single time series and/or data points from many series in a single write request when the time series belong to the same table. For your convenience, Timestream for Live Analytics oﬀers you with a ﬂexible schema that auto detects the column names and data types for your Timestream for Live Analytics tables based on the dimension names and the data types of the measure values you specify when invoking writes into the database. You can also write batches of data into Timestream for Live Analytics. Note Timestream for Live Analytics supports eventual consistency semantics for reads. This means that when you query data immediately after writing a batch
timestream-013	timestream.pdf	13	series in a single write request when the time series belong to the same table. For your convenience, Timestream for Live Analytics oﬀers you with a ﬂexible schema that auto detects the column names and data types for your Timestream for Live Analytics tables based on the dimension names and the data types of the measure values you specify when invoking writes into the database. You can also write batches of data into Timestream for Live Analytics. Note Timestream for Live Analytics supports eventual consistency semantics for reads. This means that when you query data immediately after writing a batch of data into Timestream for Live Analytics, the query results might not reﬂect the results of a recently completed write operation. The results may also include some stale data. Similarly, while writing time series data with one or more new dimensions, a query can return a partial subset of columns for a short period of time. If you repeat these query requests after a short time, the results should return the latest data. You can write data using the AWS SDKs, AWS CLI, or through AWS Lambda, AWS IoT Core, Amazon Managed Service for Apache Flink, Amazon Kinesis, Amazon MSK, and Open source Telegraf. Topics • Data types • No upfront schema deﬁnition • Writing data (inserts and upserts) • Eventual consistency for reads • Batching writes with WriteRecords API • Batch load • Choosing between the WriteRecords API operation and batch load Data types Timestream for Live Analytics supports the following data types for writes. Writes 26 Amazon Timestream Developer Guide Data type BIGINT BOOLEAN DOUBLE Description Represents a 64-bit signed integer. Represents the two truth values of logic, namely, true, and false. 64-bit variable-precision implementing the IEEE Standard 754 for Binary Floating-Point Arithmetic. Note There are query language functions for Infinity and NaN double values which can be used in queries. But you cannot write those values to Timestream. VARCHAR Variable length character data with an optional maximum length. The maximum limit is 2 KB. MULTI Data type for multi-measure records. This data type includes one or TIMESTAMP more measures of type BIGINT, BOOLEAN, DOUBLE, VARCHAR, and TIMESTAMP . Represents an instance in time using nanosecond precision time in UTC, tracking the time since Unix time. This data type is currently supported only for multi-measure records (i.e. within measure values of type MULTI). YYYY-MM-DD hh:mm:ss.sssssssss Writes support timestamps in the range 1970-01-01 00:00:00.000000000 854775807 . to 2262-04-11 23:47:16. No upfront schema deﬁnition Before sending data into Amazon Timestream for Live Analytics, you must create a database and a table using the AWS Management Console, Timestream for Live Analytics SDKs, or the Timestream for Live Analytics API operations. For more information, see Create a database and Create a table. Writes 27 Amazon Timestream Developer Guide While creating the table, you do not need to deﬁne the schema up front. Amazon Timestream for Live Analytics automatically detects the schema based on the measures and dimensions of the data points being sent, so you no longer need to alter your schema oﬄine to adapt it to your rapidly changing time series data. Writing data (inserts and upserts) The write operation in Amazon Timestream for Live Analytics enables you to insert and upsert data. By default, writes in Amazon Timestream for Live Analytics follow the ﬁrst writer wins semantics, where data is stored as append only and duplicate records are rejected. While the ﬁrst writer wins semantics satisﬁes the requirements of many time series applications, there are scenarios where applications need to update existing records in an idempotent manner and/or write data with the last writer wins semantics, where the record with the highest version is stored in the service. To address these scenarios, Amazon Timestream for Live Analytics provides the ability to upsert data. Upsert is an operation that inserts a record into the system when the record does not exist, or updates the record when one exists. When the record is updated, it is updated in an idempotent manner. There isn't a record level operation for deletion. But tables and databases can be deleted. Writing data into the memory store and the magnetic store Amazon Timestream for Live Analytics oﬀers the ability to directly write data into the memory store and the magnetic store. The memory store is optimized for high throughput data writes and the magnetic store is optimized for lower throughput writes of late arrival data. Late-arriving data is data with a timestamp earlier than the current time and outside the memory store retention period. You must explicitly enable the ability to write late- arriving data into the magnetic store by enabling magnetic store writes for the table. Also, MagneticStoreRejectedDataLocation is deﬁned when a table is created. To write to the magnetic store, callers of WriteRecords must have
timestream-014	timestream.pdf	14	the ability to directly write data into the memory store and the magnetic store. The memory store is optimized for high throughput data writes and the magnetic store is optimized for lower throughput writes of late arrival data. Late-arriving data is data with a timestamp earlier than the current time and outside the memory store retention period. You must explicitly enable the ability to write late- arriving data into the magnetic store by enabling magnetic store writes for the table. Also, MagneticStoreRejectedDataLocation is deﬁned when a table is created. To write to the magnetic store, callers of WriteRecords must have S3:PutObject permissions to the S3 bucket speciﬁed in MagneticStoreRejectedDataLocationduring table creation. For more information, see CreateTable, WriteRecords, and PutObject. Writing data with single-measure records and multi-measure records Amazon Timestream for Live Analytics oﬀers the ability to write data using two types of records, namely, single-measure records and multi-measure records. Single-measure records Writes 28 Amazon Timestream Developer Guide Single-measure records enable you to send a single measure per record. When data is sent to Timestream for Live Analytics using this format, Timestream for Live Analytics creates one table row per record. This means that if a device emits 4 metrics and each metric is sent as a single- measure record, Timestream for Live Analytics will create 4 rows in the table to store this data, and the device attributes will be repeated for each row. This format is recommended in cases when you want to monitor a single metric from an application or when your application does not emit multiple metrics at the same time. Multi-measure records With multi-measure records, you can store multiple measures in a single table row, instead of storing one measure per table row. Multi-measure records therefore enable you to migrate your existing data from relational databases to Amazon Timestream for Live Analytics with minimal changes. You can also batch more data in a single write request than single-measure records. This increases data write throughput and performance, and also reduces the cost of data writes. This is because batching more data in a write request enables Amazon Timestream for Live Analytics to identify more repeatable data in a single write request (where applicable), and charge only once for repeated data. Topics • Multi-measure records • Writing data with a timestamp that exists in the past or in the future Multi-measure records With multi-measure records, you can store your time-series data in a more compact format in the memory and magnetic store, which helps lower data storage costs. Also, the compact data storage lends itself to writing simpler queries for data retrieval, improves query performance, and lowers the cost of queries. Furthermore, multi-measure records also support the TIMESTAMP data type for storing more than one timestamp in a time-series record. TIMESTAMP attributes in a multi-measure record support timestamps in future or past. Multi-measure records therefore help improve performance, cost, and query simplicity—and oﬀer more ﬂexibility for storing diﬀerent types of correlated measures. Writes 29 Amazon Timestream Beneﬁts Developer Guide The following are the beneﬁts of using multi-measure records. • Performance and cost – Multi-measure records enable you to write multiple time-series measures in a single write request. This increases the write throughput and also reduces the cost of writes. With multi-measure records, you can store data in a more compact manner, which helps lower the data storage costs. The compact data storage of multi-measure records results in less data being processed by queries. This is designed to improve the overall query performance and help lower the query cost. • Query simplicity – With multi-measure records, you do not need to write complex common table expressions (CTEs) in a query to read multiple measures with the same timestamp. This is because the measures are stored as columns in a single table row. Multi-measure records therefore enable writing simpler queries. • Data modeling ﬂexibility – You can write future timestamps into Timestream for Live Analytics by using the TIMESTAMP data type and multi-measure records. A multi-measure record can have multiple attributes of TIMESTAMP data type, in addition to the time ﬁeld in a record. TIMESTAMP attributes, in a multi-measure record, can have timestamps in the future or the past and behave like the time ﬁeld except that Timestream for Live Analytics does not index on the values of type TIMESTAMP in a multi-measure record. Use cases You can use multi-measure records for any time-series application that generates more than one measurement from the same device at any given time. The following are some example applications. • A video streaming platform that generates hundreds of metrics at a given time. • Medical devices that generate measurements such as blood oxygen levels, heart rate, and pulse. • Industrial equipment such as oil rigs that generate metrics, temperature, and weather sensors. • Other
timestream-015	timestream.pdf	15	behave like the time ﬁeld except that Timestream for Live Analytics does not index on the values of type TIMESTAMP in a multi-measure record. Use cases You can use multi-measure records for any time-series application that generates more than one measurement from the same device at any given time. The following are some example applications. • A video streaming platform that generates hundreds of metrics at a given time. • Medical devices that generate measurements such as blood oxygen levels, heart rate, and pulse. • Industrial equipment such as oil rigs that generate metrics, temperature, and weather sensors. • Other applications that are architected with one or more microservices. Example: Monitoring the performance and health of a video streaming application Consider a video streaming application that is running on 200 EC2 instances. You want to use Amazon Timestream for Live Analytics to store and analyze the metrics being emitted from the Writes 30 Amazon Timestream Developer Guide application, so you can understand the performance and health of your application, quickly identify anomalies, resolve issues, and discover optimization opportunities. We will model this scenario with single-measure records and multi-measure records, and then compare/contrast both approaches. For each approach, we make the following assumptions. • Each EC2 instance emits four measures (video_startup_time, rebuﬀering_ratio, video_playback_failures, and average_frame_rate) and four dimensions (device_id, device_type, os_version, and region) per second. • You want to store 6 hours of data in the memory store and 6 months of data in the magnetic store. • To identify anomalies, you've set up 10 queries that run every minute to identify any unusual activity over the past few minutes. You've also built a dashboard with eight widgets that display the last 6 hours of data, so that you can eﬀectively monitor your application. This dashboard is accessed by ﬁve users at any given time and is auto-refreshed every hour. Using single measure records Data modeling: With single measure records, we will create one record for each of the four measures (video startup time, rebuﬀering ratio, video playback failures, and average frame rate). Each record will have the four dimensions (device_id, device_type, os_version, and region) and a timestamp. Writes: When you write data into Amazon Timestream for Live Analytics, the records are constructed as follows. public void writeRecords() { System.out.println("Writing records"); // Specify repeated values for all records List<Record> records = new ArrayList<>(); final long time = System.currentTimeMillis(); List<Dimension> dimensions = new ArrayList<>(); final Dimension device_id = new Dimension().withName("device_id").withValue("12345678"); final Dimension device_type = new Dimension().withName("device_type").withValue("iPhone 11"); final Dimension os_version = new Dimension().withName("os_version").withValue("14.8"); Writes 31 Amazon Timestream Developer Guide final Dimension region = new Dimension().withName("region").withValue("us-east-1"); dimensions.add(device_id); dimensions.add(device_type); dimensions.add(os_version); dimensions.add(region); Record videoStartupTime = new Record() .withDimensions(dimensions) .withMeasureName("video_startup_time") .withMeasureValue("200") .withMeasureValueType(MeasureValueType.BIGINT) .withTime(String.valueOf(time)); Record rebufferingRatio = new Record() .withDimensions(dimensions) .withMeasureName("rebuffering_ratio") .withMeasureValue("0.5") .withMeasureValueType(MeasureValueType.DOUBLE) .withTime(String.valueOf(time)); Record videoPlaybackFailures = new Record() .withDimensions(dimensions) .withMeasureName("video_playback_failures") .withMeasureValue("0") .withMeasureValueType(MeasureValueType.BIGINT) .withTime(String.valueOf(time)); Record averageFrameRate = new Record() .withDimensions(dimensions) .withMeasureName("average_frame_rate") .withMeasureValue("0.5") .withMeasureValueType(MeasureValueType.DOUBLE) .withTime(String.valueOf(time)); records.add(videoStartupTime); records.add(rebufferingRatio); records.add(videoPlaybackFailures); records.add(averageFrameRate); WriteRecordsRequest writeRecordsRequest = new WriteRecordsRequest() .withDatabaseName(DATABASE_NAME) .withTableName(TABLE_NAME) .withRecords(records); try { Writes 32 Amazon Timestream Developer Guide WriteRecordsResult writeRecordsResult = amazonTimestreamWrite.writeRecords(writeRecordsRequest); System.out.println("WriteRecords Status: " + writeRecordsResult.getSdkHttpMetadata().getHttpStatusCode()); } catch (RejectedRecordsException e) { System.out.println("RejectedRecords: " + e); for (RejectedRecord rejectedRecord : e.getRejectedRecords()) { System.out.println("Rejected Index " + rejectedRecord.getRecordIndex() + ": " + rejectedRecord.getReason()); } System.out.println("Other records were written successfully. "); } catch (Exception e) { System.out.println("Error: " + e); } } When you store single-measure records, the data is logically represented as follows. Time device_id device_ty pe os_versio n region measure_n ame measure_v alue::big measure_v alue::dou 2021-09-0 7 12345678 iPhone 14.8 us-east-1 11 21:48:44 .00000000 0 int 200 video_sta rtup_time 12345678 iPhone 2021-09-0 7 21:48:44 .00000000 0 2021-09-0 7 21:48:44 .00000000 0 11 11 12345678 iPhone 14.8 us-east-1 rebuﬀeri ng_ratio 14.8 us-east-1 0 video_pla yback_fai lures ble 0.5 12345678 iPhone 14.8 us-east-1 11 average_f rame_rate 0.85 2021-09-0 7 Writes 33 Amazon Timestream Developer Guide Time device_id device_ty pe os_versio n region measure_n ame measure_v alue::big measure_v alue::dou int ble 21:48:44 .00000000 0 2021-09-0 7 12345678 iPhone 14.8 us-east-1 11 video_sta rtup_time 500 21:53:44 .00000000 0 12345678 iPhone 2021-09-0 7 21:53:44 .00000000 11 14.8 us-east-1 rebuﬀeri ng_ratio 1.5 0 2021-09-0 7 12345678 iPhone 14.8 us-east-1 11 21:53:44 .00000000 video_pla yback_fai 10 lures 0 2021-09-0 7 12345678 iPhone 14.8 us-east-1 11 average_f rame_rate 0.2 21:53:44 .00000000 0 Queries: You can write a query that retrieves all of the data points with the same timestamp received over the past 15 minutes as follows. with cte_video_startup_time as ( SELECT time, device_id, device_type, os_version, region, measure_value::bigint as video_startup_time FROM table where time >= ago(15m) and measure_name=”video_startup_time”), cte_rebuffering_ratio as ( SELECT time, device_id, device_type, os_version, region, measure_value::double as rebuffering_ratio FROM table where time >= ago(15m) and measure_name=”rebuffering_ratio”), cte_video_playback_failures as ( SELECT time, device_id, device_type, os_version, region, measure_value::bigint as video_playback_failures FROM table where time >= ago(15m) and measure_name=”video_playback_failures”), Writes 34 Amazon Timestream Developer Guide cte_average_frame_rate as ( SELECT time,
timestream-016	timestream.pdf	16	21:53:44 .00000000 0 Queries: You can write a query that retrieves all of the data points with the same timestamp received over the past 15 minutes as follows. with cte_video_startup_time as ( SELECT time, device_id, device_type, os_version, region, measure_value::bigint as video_startup_time FROM table where time >= ago(15m) and measure_name=”video_startup_time”), cte_rebuffering_ratio as ( SELECT time, device_id, device_type, os_version, region, measure_value::double as rebuffering_ratio FROM table where time >= ago(15m) and measure_name=”rebuffering_ratio”), cte_video_playback_failures as ( SELECT time, device_id, device_type, os_version, region, measure_value::bigint as video_playback_failures FROM table where time >= ago(15m) and measure_name=”video_playback_failures”), Writes 34 Amazon Timestream Developer Guide cte_average_frame_rate as ( SELECT time, device_id, device_type, os_version, region, measure_value::double as average_frame_rate FROM table where time >= ago(15m) and measure_name=”average_frame_rate”) SELECT a.time, a.device_id, a.os_version, a.region, a.video_startup_time, b.rebuffering_ratio, c.video_playback_failures, d.average_frame_rate FROM cte_video_startup_time a, cte_buffering_ratio b, cte_video_playback_failures c, cte_average_frame_rate d WHERE a.time = b.time AND a.device_id = b.device_id AND a.os_version = b.os_version AND a.region=b.region AND a.time = c.time AND a.device_id = c.device_id AND a.os_version = c.os_version AND a.region=c.region AND a.time = d.time AND a.device_id = d.device_id AND a.os_version = d.os_version AND a.region=d.region Workload cost: The cost of this workload is estimated to be $373.23 per month with single- measure records Using multi-measure records Data modeling: With multi-measure records, we will create one record that contains all four measures (video startup time, rebuﬀering ratio, video playback failures, and average frame rate), all four dimensions (device_id, device_type, os_version, and region), and a timestamp. Writes: When you write data into Amazon Timestream for Live Analytics, the records are constructed as follows. public void writeRecords() { System.out.println("Writing records"); // Specify repeated values for all records List<Record> records = new ArrayList<>(); final long time = System.currentTimeMillis(); List<Dimension> dimensions = new ArrayList<>(); final Dimension device_id = new Dimension().withName("device_id").withValue("12345678"); final Dimension device_type = new Dimension().withName("device_type").withValue("iPhone 11"); final Dimension os_version = new Dimension().withName("os_version").withValue("14.8"); final Dimension region = new Dimension().withName("region").withValue("us-east-1"); dimensions.add(device_id); Writes 35 Amazon Timestream Developer Guide dimensions.add(device_type); dimensions.add(os_version); dimensions.add(region); Record videoMetrics = new Record() .withDimensions(dimensions) .withMeasureName("video_metrics") .withTime(String.valueOf(time)); .withMeasureValueType(MeasureValueType.MULTI) .withMeasureValues( new MeasureValue() .withName("video_startup_time") .withValue("0") .withValueType(MeasureValueType.BIGINT), new MeasureValue() .withName("rebuffering_ratio") .withValue("0.5") .withType(MeasureValueType.DOUBLE), new MeasureValue() .withName("video_playback_failures") .withValue("0") .withValueType(MeasureValueType.BIGINT), new MeasureValue() .withName("average_frame_rate") .withValue("0.5") .withValueType(MeasureValueType.DOUBLE)) records.add(videoMetrics); WriteRecordsRequest writeRecordsRequest = new WriteRecordsRequest() .withDatabaseName(DATABASE_NAME) .withTableName(TABLE_NAME) .withRecords(records); try { WriteRecordsResult writeRecordsResult = amazonTimestreamWrite.writeRecords(writeRecordsRequest); System.out.println("WriteRecords Status: " + writeRecordsResult.getSdkHttpMetadata().getHttpStatusCode()); } catch (RejectedRecordsException e) { System.out.println("RejectedRecords: " + e); for (RejectedRecord rejectedRecord : e.getRejectedRecords()) { System.out.println("Rejected Index " + rejectedRecord.getRecordIndex() + ": " + rejectedRecord.getReason()); Writes 36 Amazon Timestream } System.out.println("Other records were written successfully. "); } catch (Exception e) { System.out.println("Error: " + e); } } Developer Guide When you store multi-measure records, the data is logically represented as follows. Time device_id device_ty os_versio n pe region measure_n ame video_sta rtup_time rebuﬀeri ng_ratio video_ playback_ average_f rame_rate failures 2021-09-0 7 12345678iPhone 21:48:44 .00000000 0 2021-09-0 7 12345678iPhone 11 11 14.8 us- east-1 video_met rics 200 0.5 0 0.85 14.8 us- east-1 video_met rics 500 1.5 10 0.2 21:53:44 .00000000 0 Queries: You can write a query that retrieves all of the data points with the same timestamp received over the past 15 minutes as follows. SELECT time, device_id, device_type, os_version, region, video_startup_time, rebuffering_ratio, video_playback_failures, average_frame_rate FROM table where time >= ago(15m) Workload cost: The cost of workload is estimated to be $127.43 with multi-measure records. Note In this case, using multi-measure records reduces the overall estimated monthly spend by 2.5x, with the data writes cost reduced by 3.3x, the storage cost reduced by 3.3x, and the query cost reduced by 1.2x. Writes 37 Amazon Timestream Developer Guide Writing data with a timestamp that exists in the past or in the future Timestream for Live Analytics oﬀers the ability to write data with a timestamp that lies outside of the memory store retention window through a couple diﬀerent mechanisms. • Magnetic store writes – You can write late-arriving data directly into the magnetic store through magnetic store writes. To use magnetic store writes, you must ﬁrst enable magnetic store writes for a table. You can then ingest data into the table using the same mechanism used for writing data into the memory store. Amazon Timestream for Live Analytics will automatically write the data into the magnetic store based on its timestamp. Note The write-to-read latency for the magnetic store can be up to 6 hours, unlike writing data into the memory store, where the write-to-read latency is in the sub-second range. • TIMESTAMP data type for measures – You can use the TIMESTAMP data type to store data from the past, present, or future. A multi-measure record can have multiple attributes of TIMESTAMP data type, in addition to the time ﬁeld in a record. TIMESTAMP attributes, in a multi-measure record, can have timestamps in the future or the past and behave like the time ﬁeld except that Timestream for Live Analytics does not index on the values of type TIMESTAMP in a multi- measure record. Note
timestream-017	timestream.pdf	17	writing data into the memory store, where the write-to-read latency is in the sub-second range. • TIMESTAMP data type for measures – You can use the TIMESTAMP data type to store data from the past, present, or future. A multi-measure record can have multiple attributes of TIMESTAMP data type, in addition to the time ﬁeld in a record. TIMESTAMP attributes, in a multi-measure record, can have timestamps in the future or the past and behave like the time ﬁeld except that Timestream for Live Analytics does not index on the values of type TIMESTAMP in a multi- measure record. Note The TIMESTAMP data type is supported only for multi-measure records. Eventual consistency for reads Timestream for Live Analytics supports eventual consistency semantics for reads. This means that when you query data immediately after writing a batch of data into Timestream for Live Analytics, the query results might not reﬂect the results of a recently completed write operation. If you repeat these query requests after a short time, the results should return the latest data. Batching writes with WriteRecords API Amazon Timestream for Live Analytics enables you to write data points from a single time series and/or data points from many series in a single write request. Batching multiple data points in Writes 38 Amazon Timestream Developer Guide a single write operation is beneﬁcial from a performance and cost perspective. See Writes in the Metering and Pricing section for more details. Note Your write requests to Timestream for Live Analytics may be throttled as Timestream for Live Analytics scales to adapt to the data ingestion needs of your application. If your applications encounter throttling exceptions, you must continue to send data at the same (or higher) throughput to allow Timestream for Live Analytics to automatically scale to your application's needs. Batch load With batch load for Amazon Timestream for LiveAnalytics, you can ingest CSV ﬁles stored in Amazon S3 into Timestream in batches. With this new functionality, you can have your data in Timestream for LiveAnalytics without having to rely on other tools or write custom code. You can use batch load for backﬁlling data with ﬂexible wait times, such as data that isn't immediately required for querying or analysis. You can create batch load tasks by using the AWS Management Console, the AWS CLI, and the AWS SDKs. For more information, see Using batch load with the console, Using batch load with the AWS CLI, and Using batch load with the AWS SDKs. For more information about batch load, see Using batch load in Timestream for LiveAnalytics. Choosing between the WriteRecords API operation and batch load With the WriteRecords API operation, you can write your streaming time series data into Timestream for LiveAnalytics as it's generated by your system. By using WriteRecords, you can continuously ingest a single data point or smaller batches of data in real time. Timestream for LiveAnalytics oﬀers you a ﬂexible schema that auto detects the column names and data types for your Timestream for LiveAnalytics tables, based on the dimension names and data types of the data points you specify when invoking writes into the database. In contrast, batch load enables the robust ingestion of batched time-series data from source ﬁles (CSV ﬁles) into Timestream for LiveAnalytics, using a data model that you deﬁne. A few examples for when to use batch load with a source ﬁle are importing time series data in bulk for the evaluation of Timestream for LiveAnalytics through a proof of concept, importing time series Writes 39 Amazon Timestream Developer Guide data in bulk from an IoT device that was oﬄine for some time, and migrating historical time series data from Amazon S3 to Timestream for LiveAnalytics. For information about batch load, see Using batch load in Timestream for LiveAnalytics. Both solutions are secure, reliable, and performant. Use WriteRecords when: • Streaming smaller amounts (less than 10 MB) of data per request. • Populating existing tables. • Ingesting data from a log stream. • Performing real-time analytics. • Requiring lower latency. Use batch load when: • Ingesting larger loads of data that originate in Amazon S3 in CSV ﬁles. For more information about limits, see Quotas. • Populating new tables, such as in the case of a data migration. • Enriching databases with historical data (ingestion into new tables). • You have source data that changes slowly or not at all. • You have ﬂexible wait times because a batch load task might be in a pending state until resources are available, especially if you load a very large amount of data. Batch load is suitable for data that doesn't need to be readily available for querying or analysis to add more clarity. Storage Timestream for Live Analytics stores and organizes your time series data to optimize query processing time and
timestream-018	timestream.pdf	18	as in the case of a data migration. • Enriching databases with historical data (ingestion into new tables). • You have source data that changes slowly or not at all. • You have ﬂexible wait times because a batch load task might be in a pending state until resources are available, especially if you load a very large amount of data. Batch load is suitable for data that doesn't need to be readily available for querying or analysis to add more clarity. Storage Timestream for Live Analytics stores and organizes your time series data to optimize query processing time and to reduce storage costs. It oﬀers data storage tiering and supports two storage tiers: a memory store and a magnetic store. The memory store is optimized for high throughput data writes and fast point-in-time queries. The magnetic store is optimized for lower throughput late-arriving data writes, long term data storage, and fast analytical queries. Timestream for Live Analytics ensures durability of your data by automatically replicating your memory and magnetic store data across diﬀerent Availability Zones within a single AWS Region. All of your data is written to disk before acknowledging your write request as complete. Storage 40 Amazon Timestream Developer Guide Timestream for Live Analytics enables you to conﬁgure retention policies to move data from the memory store to the magnetic store. When the data reaches the conﬁgured value, Timestream for Live Analytics automatically moves the data to the magnetic store. You can also set a retention value on the magnetic store. When data expires out of the magnetic store, it is permanently deleted. For example, consider a scenario where you conﬁgure the memory store to hold a week's-worth of data and the magnetic store to hold 1 year's-worth of data. The age of the data is computed using the timestamp associated with the data point. When the data in the memory store becomes a week old it is automatically moved to the magnetic store. It is then retained in the magnetic store for a year. When the data becomes a year old, it is deleted from Timestream for Live Analytics. The retention values of the memory store and the magnetic store cumulatively deﬁne the amount of time that your data will be stored in Timestream for Live Analytics. This means that for the above scenario, from the time of data arrival, the data is stored in Timestream for Live Analytics for a total period of 1 year and 1 week. Note When you upgrade the retention period of the memory or magnetic store, the retention change takes eﬀect from that point onwards. For example, if the retention period of the memory store was set to 2 hours and then changed to 24 hours by updating the table retention policies, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream for Live Analytics does not retrieve data from the magnetic store to populate the memory store. To ensure the security of your time series data, your data in Timestream for Live Analytics is always encrypted by default. This applies to data in transit and at rest. Furthermore, Timestream for Live Analytics enables you to use customer managed keys to secure your data in the magnetic store. For more information on customer managed keys, see AWS KMS keys. Queries With Timestream for Live Analytics, you can easily store and analyze metrics for DevOps, sensor data for IoT applications, and industrial telemetry data for equipment maintenance, as well as many other use cases. The purpose-built, adaptive query engine in Timestream for Live Analytics allows you to access data across storage tiers using a single SQL statement. It transparently accesses and combines data across storage tiers without requiring you to specify the data location. Queries 41 Amazon Timestream Developer Guide You can use SQL to query data in Timestream for Live Analytics to retrieve time series data from one or more tables. You can access the metadata information for databases and tables. Timestream for Live Analytics SQL also supports built-in functions for time series analytics. You can refer to the Query language reference reference for additional details. Timestream for Live Analytics is designed to have a fully decoupled data ingestion, storage, and query architecture where each component can scale independently of other components (allowing it to oﬀer virtually inﬁnite scale for an application's needs). This means that Timestream for Live Analytics does not "tip over" when your applications send hundreds of terabytes of data per day or run millions of queries processing small or large amounts of data. As your data grows over time, the query latency in Timestream for Live Analytics remains mostly unchanged. This is because the Timestream for Live Analytics
timestream-019	timestream.pdf	19	reference for additional details. Timestream for Live Analytics is designed to have a fully decoupled data ingestion, storage, and query architecture where each component can scale independently of other components (allowing it to oﬀer virtually inﬁnite scale for an application's needs). This means that Timestream for Live Analytics does not "tip over" when your applications send hundreds of terabytes of data per day or run millions of queries processing small or large amounts of data. As your data grows over time, the query latency in Timestream for Live Analytics remains mostly unchanged. This is because the Timestream for Live Analytics query architecture can leverage massive amounts of parallelism to process larger data volumes and automatically scale to match query throughput needs of an application. Data model Timestream supports two data models for queries—the ﬂat model and the time series model. Note Data in Timestream is stored using the ﬂat model and it is the default model for querying data. The time series model is a query-time concept and is used for time series analytics. • Flat model • Time series model Flat model The ﬂat model is Timestream's default data model for queries. It represents time series data in a tabular format. The dimension names, time, measure names and measure values appear as columns. Each row in the table is an atomic data point corresponding to a measurement at a speciﬁc time within a time series. Timestream databases, tables, and columns have some naming constraints. Those are described in Service limits. The table below shows an illustrative example for how Timestream stores data representing the CPU utilization, memory utilization, and network activity of EC2 instances, when the data is sent as a single-measure record. In this case, the dimensions are the region, availability zone, Queries 42 Amazon Timestream Developer Guide virtual private cloud, and instance IDs of the EC2 instances. The measures are the CPU utilization, memory utilization, and the incoming network data for the EC2 instances. The columns region, az, vpc, and instance_id contain the dimension values. The column time contains the timestamp for each record. The column measure_name contains the names of the measures represented by cpu-utilization, memory_utilization, and network_bytes_in. The columns measure_value::double contains measurements emitted as doubles (e.g. CPU utilization and memory utilization). The column measure_value::bigint contains measurements emitted as integers e.g. the incoming network data. Time region az vpc instance_ id measure_n ame measure_v alue::dou measure_v alue::big us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef cpu_utili zation 0 ble 35.0 int null us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef cpu_utili zation 38.2 null 0 us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef cpu_utili zation 45.3 null 0 us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef 0 memory_ut ilization 54.9 us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef 0 memory_ut ilization 42.6 null null 2019-12-0 4 19:00:00. 000000000 2019-12-0 4 19:00:01. 000000000 2019-12-0 4 19:00:02. 000000000 2019-12-0 4 19:00:00. 000000000 2019-12-0 4 19:00:01. 000000000 Queries 43 Amazon Timestream Developer Guide Time region az vpc instance_ id measure_n ame measure_v alue::dou measure_v alue::big us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef memory_ut ilization 33.3 0 ble int null us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef network_b ytes 34,400 null 0 us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef network_b ytes 1,500 null 0 us-east-1 us-east-1 d vpc-1a2b3 c4d i-1234567 890abcdef network_b ytes 6,000 null 0 2019-12-0 4 19:00:02. 000000000 2019-12-0 4 19:00:00. 000000000 2019-12-0 4 19:00:01. 000000000 2019-12-0 4 19:00:02. 000000000 The table below shows an illustrative example for how Timestream stores data representing the CPU utilization, memory utilization, and network activity of EC2 instances, when the data is sent as a multi-measure record. Time region az vpc instance_ id measure_n ame cpu_utili zation memory_ut ilization network_b ytes us- east-1 2019-12-0 4 19:00:00. 000000000 us- east-1d vpc-1a2b3 c4d i-1234567 890abcdef 0 metrics 35.0 54.9 34,400 Queries 44 Amazon Timestream Developer Guide Time region az vpc instance_ id measure_n ame cpu_utili zation memory_ut ilization network_b ytes vpc-1a2b3 c4d i-1234567 890abcdef metrics 0 vpc-1a2b3 c4d i-1234567 890abcdef metrics 0 38.2 42.6 1,500 45.3 33.3 6,600 2019-12-0 4 us- east-1 us- east-1d 19:00:01. 000000000 2019-12-0 4 us- east-1 us- east-1d 19:00:02. 000000000 Time series model The time series model is a query time construct used for time series analytics. It represents data as an ordered sequence of (time, measure value) pairs. Timestream supports time series functions such as interpolation to enable you to ﬁll the gaps in your data. To use these functions, you must convert your data into the time series model using functions such as create_time_series. Refer to Query language reference for more details. Using the earlier example of the EC2 instance, here is the CPU utilization data expressed as a timeseries. region az vpc instance_id cpu_utilization us-east-1 us-east-1d vpc-1a2b3c4d i-1234567 890abcdef0 [{time: 2019-12-0 4 19:00:00. 000000000, value: 35}, {time: 2019-12-0 4 19:00:01. 000000000 ,
timestream-020	timestream.pdf	20	series analytics. It represents data as an ordered sequence of (time, measure value) pairs. Timestream supports time series functions such as interpolation to enable you to ﬁll the gaps in your data. To use these functions, you must convert your data into the time series model using functions such as create_time_series. Refer to Query language reference for more details. Using the earlier example of the EC2 instance, here is the CPU utilization data expressed as a timeseries. region az vpc instance_id cpu_utilization us-east-1 us-east-1d vpc-1a2b3c4d i-1234567 890abcdef0 [{time: 2019-12-0 4 19:00:00. 000000000, value: 35}, {time: 2019-12-0 4 19:00:01. 000000000 , value: 38.2}, {time: 2019-12-0 Queries 45 Amazon Timestream Developer Guide region az vpc instance_id cpu_utilization 4 19:00:02. 000000000, value: 45.3}] Scheduled queries The scheduled query feature in Amazon Timestream for Live Analytics is a fully managed, serverless, and scalable solution for calculating and storing aggregates, rollups, and other forms of preprocessed data typically used to power operational dashboards, business reports, ad hoc analytics, and other applications. Scheduled queries make real-time analytics more performant and cost-eﬀective, so you can derive additional insights from your data, and can continue to make better business decisions. For more information about scheduled query, see Using scheduled queries in Timestream for LiveAnalytics. Timestream Compute Unit (TCU) Amazon Timestream for Live Analytics measures the compute capacity allocated to you for your query needs in Timestream compute unit (TCU). One TCU comprises of 4 vCPUs and 16 GB of memory. When you run queries in Timestream for Live Analytics, the service allocates TCUs on- demand based on the complexity of your queries and the amount of data being processed. The number of TCUs that a query consumes determines the associated cost. Note All AWS accounts that onboard to the service after April 29, 2024 will default to using TCUs for query pricing. In this topic: • Provisioned Timestream Compute Units • MaxQuery TCU • Billing for TCU Scheduled queries 46 Developer Guide Amazon Timestream • Conﬁguring TCU • Estimating required compute units • When to increase MaxQueryTCU • When to decrease MaxQueryTCU • Monitoring usage with CloudWatch metrics • Understanding variations in compute units usage Provisioned Timestream Compute Units Note Provisioned TCU is available only in the Asia Paciﬁc (Mumbai) region. With provisioned Timestream Compute Units (TCUs), you can allocate a ﬁxed number of TCUs to your account, ensuring predictable performance and cost for your queries. By provisioning TCUs, you gain greater control over compute capacity, enabling you to optimize both performance and query costs based on your application's speciﬁc needs. Topics • Beneﬁts of Provisioning TCU • How Provisioned TCU Works • Monitoring Provisioned TCU usage • Modifying your Provisioned TCUs • Pricing for Provisioned TCUs Beneﬁts of Provisioning TCU Provisioning TCU provides several beneﬁts for customers with dedicated workloads, including: 1. Predictable Performance: By allocating a ﬁxed number of TCUs, you ensure consistent performance for your queries. 2. Cost Control: With provisioned TCU, you can better predict and manage your costs, as you are only charged for the duration of the provisioned TCUs. Timestream Compute Unit (TCU) 47 Amazon Timestream Developer Guide 3. Flexibility: Provisioned TCU ensures that your workload has dedicated compute resources and you can adjust the number of provisioned TCUs to match your workload requirements, providing the required scalability as your application’s needs change. How Provisioned TCU Works Each Timestream Compute Unit (TCU) is comprised of 4 vCPUs and 16GB of memory. To provision TCUs, use the AWS Management Console or the UpdateAccountSettings API operation to allocate a ﬁxed number of TCUs to your account, which are then dedicated to your workload. This ensures predictable performance and cost for your queries. The minimum number of provisioned TCUs is 4, with subsequent increments also in multiples of 4 (e.g., 4, 8, 12, 16). Once provisioned, you can run your query workloads uninterrupted. As your workload demands change, you can adjust the provisioned TCUs using the AWS Management Console or the UpdateAccountSettings API operation at any time. However, you can only decrease the number of TCUs after a minimum of 1 hour has passed since provisioning them. For example, if you provision 8 TCUs at 10:00 AM, you will be charged for a minimum of 1 hour, until 11:00 AM. During this time, you can increment the TCUs to 12 or more, but you cannot decrement them until 11:00 AM. The time it takes to provision the requested Timestream Compute Units (TCUs) in your account varies depending on the number of TCUs requested. For example, provisioning 100 TCUs could take up to 30 minutes. However, you will only be charged for the resources once they are provisioned and available to serve your query workload. To ensure a smooth experience during planned increases in usage, we recommend provisioning the required resources in advance. This allows suﬃcient
timestream-021	timestream.pdf	21	1 hour, until 11:00 AM. During this time, you can increment the TCUs to 12 or more, but you cannot decrement them until 11:00 AM. The time it takes to provision the requested Timestream Compute Units (TCUs) in your account varies depending on the number of TCUs requested. For example, provisioning 100 TCUs could take up to 30 minutes. However, you will only be charged for the resources once they are provisioned and available to serve your query workload. To ensure a smooth experience during planned increases in usage, we recommend provisioning the required resources in advance. This allows suﬃcient time for the resources to become available and ensures that your workload can be handled without interruption. Monitoring Provisioned TCU usage To monitor your provisioned TCU usage, you can use the following CloudWatch metrics: • Provisioned QueryTCU: This metric speciﬁes the number of TCUs provisioned in your account. • QueryTCU: This metric speciﬁes the number of TCUs used by your workload. • InsuﬃcientTCUThrottles: This metric speciﬁes the number of queries throttled due to insuﬃcient compute capacity. Timestream Compute Unit (TCU) 48 Amazon Timestream Developer Guide Modifying your Provisioned TCUs You can adjust the number of provisioned Timestream Compute Units (TCUs) to match your changing workload demands using the AWS Management Console, AWS Command Line Interface (CLI), or AWS SDKs. To view the current number of provisioned TCUs in your account, navigate to the "Admin Dashboard" section in the AWS Management Console. From there, you can easily monitor and manage your provisioned TCUs. In the Query Compute Settings, you can verify that the compute mode is set to "Provisioned" and view the current number of provisioned Timestream Compute Units (TCUs) in your account, which is displayed as "Active Query TCU". The default value is 0. You need to provision TCUs before you run your query workload. To modify the query compute settings, click the "Modify" button. For instance, if you want to increase the provisioned TCUs from 32 to 64, simply enter your desired target value (64) in the "Target Query TCU" ﬁeld. Additionally, you can specify an Amazon Simple Notiﬁcation Service (SNS) topic to receive a notiﬁcation when the provisioning process is complete. After conﬁrming your desired conﬁguration by selecting "Save settings", you will see that the current request status is updated to "Pending". The "Target Query TCU" ﬁeld will now reﬂect the desired number of compute units, which is 64 in this case, indicating that the provisioning process has been initiated and is awaiting completion. Timestream Compute Unit (TCU) 49 Amazon Timestream Developer Guide Once provisioned, the "Active Query TCU" ﬁeld will be updated to reﬂect the new provisioned capacity of 64 Timestream Compute Units, indicating that the provisioning process is complete and the additional resources are now available for use in your account. To reduce the number of provisioned Timestream Compute Units (TCUs) in your account, follow the same steps as before and enter your desired target value. For example, if you want to decrease the provisioned TCUs to 16, simply set the "Target Query TCU" ﬁeld to 16. Please note that you can only decrease the number of provisioned TCUs after a minimum of 1 hour has passed since the last provisioning request. This means that if you provisioned or modiﬁed your TCUs within the last hour, you will need to wait until the 1-hour window has elapsed before you can decrement the TCUs. After requesting a decrease in provisioned Timestream Compute Units (TCUs), the service will decrement the TCUs when it determines it is safe to do so, which may take up to a few minutes. During this time, the "Target Query TCU" ﬁeld will continue to display the desired target value, in this case, 16 TCUs, indicating the pending change. Once the decrement is complete, the "Active Query TCU" ﬁeld will be updated to reﬂect the new provisioned capacity of 16 TCUs. Timestream Compute Unit (TCU) 50 Amazon Timestream Developer Guide Once the request is successfully completed, the "Active Query TCU" ﬁeld will be updated to reﬂect the new provisioned capacity of 16 Timestream Compute Units (TCUs). If you no longer anticipate any query workload, you can further decrement the provisioned TCUs to 0, eﬀectively releasing all provisioned resources and stopping any associated charges. Pricing for Provisioned TCUs You are charged for the duration of the Timestream Compute Units (TCUs) provisioned in your account, with a minimum charge of 1 hour. After the ﬁrst hour, the TCUs are metered per second. To calculate the total metered hours, multiply the number of provisioned TCUs by the duration of use. For example: If you provision 16 TCUs for 2 hours, the total metered hours are 16 TCU * 2 hours = 32 TCU-hours. If you provision 16 TCUs for 4 hours, then decrement to 8 TCUs and
timestream-022	timestream.pdf	22	releasing all provisioned resources and stopping any associated charges. Pricing for Provisioned TCUs You are charged for the duration of the Timestream Compute Units (TCUs) provisioned in your account, with a minimum charge of 1 hour. After the ﬁrst hour, the TCUs are metered per second. To calculate the total metered hours, multiply the number of provisioned TCUs by the duration of use. For example: If you provision 16 TCUs for 2 hours, the total metered hours are 16 TCU * 2 hours = 32 TCU-hours. If you provision 16 TCUs for 4 hours, then decrement to 8 TCUs and use them for 6 hours, the total metered hours are 16 TCU * 4 hours + 8 TCU * 6 hours = 112 TCU-hours. Your total spend will depend on the prevailing TCU-hour cost in your region. Please refer to the Amazon Timestream Pricing page for detailed information. Best Practices for managing Provisioned TCU To get the most out of the Provisioned TCU feature, follow these best practices: • Monitor your workload: Monitor your workload's performance, QueryTCU used and view InsufficientTCUThrottles to understand your usage patterns and adjust your provisioned TCUs accordingly. • Pro-active adjustment: Increase or decrease provisioned TCUs based on observed trends and anticipated workload changes. Make adjustments for your peak and oﬀ-peak periods. • Maintain Headroom: Maintain your consumed QueryTCU to within 80% - 90% of your ProvisionedQueryTCU to handle unexpected spikes. • Optimize Queries: Leverage features such as Query Insights and follow Timestream Query best practices to optimize queries for reduced compute usage. • Implement Retries:Timestream for LiveAnalytics Query SDK supports a retry mechanism with a default of 3 retries. Adjust the value accordingly to handle occasional and unanticipated bursts. Timestream Compute Unit (TCU) 51 Amazon Timestream MaxQuery TCU Developer Guide This setting speciﬁes the maximum number of compute units the service will use at any point in time to serve your queries. To run queries, you must set the minimum capacity to 4 TCUs. You can set the maximum number of TCUs in multiples of 4, for example, 4, 8, 16, 32, and so on. You're charged only for the compute resources you use for your workload. For example, if you set the maximum TCUs to 128, but consistently use only 8 TCUs. You'll be charged only for the duration during which you used the 8 TCUs. The default MaxQueryTCU in your account is set to 200. You can adjust MaxQueryTCU from 4 to 1000, using the AWS Management Console or UpdateAccountSettings API operation with the AWS SDK or AWS CLI. We recommend setting the MaxQueryTCU for your account. Setting a maximum TCU limit helps control costs by restricting the number of compute units the service can use for your query workload. This allows you to better predict and manage your query spending. Billing for TCU Each TCU is billed on an hourly basis with per-second granularity and for a minimum of 30 seconds. The usage unit of these compute units is TCU-hour. When you run queries, you're billed for the TCUs used during the query execution time, measured in TCU-hours. For example: • Your workload uses 20 TCUs for 3 hours. You're billed for 60 TCU-hours (20 TCUs x 3 hours). • Your workload uses 10 TCUs for 30 minutes, and then 20 TCUs for the next 30 minutes. You're billed for 15 TCU-hours (10 TCUs x 0.5 hours + 20 TCUs x 0.5 hours). The pricing per TCU-hour varies by AWS Region. Refer to Amazon Timestream pricing for additional details. As your workload grows, the service automatically scales the compute capacity up to the speciﬁed maximum TCU limit (MaxQueryTCU) to maintain consistent performance. The MaxQueryTCU setting acts as a ceiling for the compute capacity that the service can scale to. This setting helps you to control the number of compute resources and as a result their cost. Conﬁguring TCU When you onboard the service, each AWS account has a default MaxQueryTCU limit of 200. You can update this limit as required at any point in time using the AWS Management Console or UpdateAccountSettings API operation with the AWS SDK or AWS CLI. Timestream Compute Unit (TCU) 52 Amazon Timestream Developer Guide If you're unsure about the values to conﬁgure, monitor the QueryTCU metric for your account. This metric is available in the AWS Management Console and Amazon CloudWatch. This metric provides insight into the maximum number of TCUs used at a minute granularity. Based on historical data and your estimation of future growth, set the MaxQueryTCU to accommodate the spikes in your usage. We recommend having a headroom of at least 4-16 TCUs above your peak usage. For example, if your peak QueryTCU in the last 30 days was 128, we recommend setting MaxQueryTCU between 132 to 144. Estimating required compute units Compute
timestream-023	timestream.pdf	23	unsure about the values to conﬁgure, monitor the QueryTCU metric for your account. This metric is available in the AWS Management Console and Amazon CloudWatch. This metric provides insight into the maximum number of TCUs used at a minute granularity. Based on historical data and your estimation of future growth, set the MaxQueryTCU to accommodate the spikes in your usage. We recommend having a headroom of at least 4-16 TCUs above your peak usage. For example, if your peak QueryTCU in the last 30 days was 128, we recommend setting MaxQueryTCU between 132 to 144. Estimating required compute units Compute units can process queries concurrently. To determine the number of compute units required, consider the general guidelines in the following table: Concurrent queries 7 14 21 Note TCUs 4 8 12 • These are general guidelines and the actual number of compute units required depends on several factors, such as: • The eﬀective concurrency of queries. • Query patterns. • The number of partitions scanned. • Other workload-speciﬁc characteristics. • This guideline pertains to queries that scan for the last few minutes to an hour of data and adhere to the Timestream query best practices and Data modeling guidelines. • Monitor your application's performance and the QueryTCU metric to adjust the compute units, as required. Timestream Compute Unit (TCU) 53 Amazon Timestream Developer Guide When to increase MaxQueryTCU You should consider increasing the MaxQueryTCU in the following scenarios: • Your peak query consumption is approaching or reaching the current conﬁgured maximum query TCU. We recommend setting the maximum query TCU at least 4-16 TCUs higher than your peak consumption. • Your queries are returning a 4xx error with the message MaxQueryTCU exceeded. If you anticipate a planned increase in your workload, revisit and adjust the conﬁgured maximum query TCU accordingly. When to decrease MaxQueryTCU You should consider decreasing the MaxQueryTCU in the following scenarios: • Your workload has a predictable and stable usage pattern, and you have a good understanding of your compute usage requirements. Lowering the maximum query TCU to within 4-16 TCU above your peak consumption can help prevent unintentional usage and costs. You can modify the value using the UpdateAccountSettings API operation. • Your workload's peak usage has decreased over time, either due to changes in your application or user behavior patterns. Lowering the maximum TCU can help mitigate unintentional costs. Note Depending on your current usage, reducing the maximum TCU limit change might take up to 24 hours to be eﬀective. You're billed only for the TCUs that your queries actually consume. Having a higher maximum query TCU limit does not impact your costs unless those TCUs are used by your workload. Monitoring usage with CloudWatch metrics To monitor your TCU usage, Timestream for Live Analytics provides the following CloudWatch metric: QueryTCU. This metric speciﬁes the number of compute units used in a minute and is emitted every minute. You can choose to monitor the maximum and minimum TCUs used in a minute. You can also set alarms on this metric to track your query costs in real-time. Timestream Compute Unit (TCU) 54 Amazon Timestream Developer Guide Understanding variations in compute units usage The number of compute resources required for your queries can either increase or decrease based on several parameters. For example, data volume, data ingestion patterns, query latency, query shape, query eﬃciency, and query combinations that use real-time and analytical queries. These parameters can lead to either higher or lower TCU units required for your workload. In a steady state where these parameters don't change, you might observe that the number of compute units required for your workload decrease. Consequently, this can lower your monthly cost. Additionally, if any of these parameters in your workload or data change, the number of compute units required might increase. When Timestream receives a query, depending upon the data partitions the query accesses, Timestream decides the number of compute resources to performantly address the query. At periodic intervals, based on your ingest and query access patterns, Timestream optimizes the data layout. Timestream performs the optimization by clubbing less accessed partitions into a single partition or splitting a hot partition into multiple partitions for performance. Consequently, the compute capacity used by the same query might vary slightly at diﬀerent points in time. Opting-in to use TCU pricing for your queries As an existing user, you can do a one-time opt-in to use TCUs for better cost management and removal of per query minimum bytes metered. You can opt-in using the AWS Management Console or UpdateAccountSettings API operation with the AWS SDK or AWS CLI. In the API operation, set the QueryPricingModel parameter to COMPUTE_UNITS. Opting into the compute-based pricing model is an irreversible change. Accessing Timestream for LiveAnalytics You can access Timestream for LiveAnalytics using the console, CLI or
timestream-024	timestream.pdf	24	used by the same query might vary slightly at diﬀerent points in time. Opting-in to use TCU pricing for your queries As an existing user, you can do a one-time opt-in to use TCUs for better cost management and removal of per query minimum bytes metered. You can opt-in using the AWS Management Console or UpdateAccountSettings API operation with the AWS SDK or AWS CLI. In the API operation, set the QueryPricingModel parameter to COMPUTE_UNITS. Opting into the compute-based pricing model is an irreversible change. Accessing Timestream for LiveAnalytics You can access Timestream for LiveAnalytics using the console, CLI or the API. For information about accessing Timestream for LiveAnalytics, review the following: Topics • Sign up for an AWS account • Create a user with administrative access • Provide Timestream for LiveAnalytics access Accessing Timestream for LiveAnalytics 55 Amazon Timestream • Grant programmatic access Sign up for an AWS account Developer Guide If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a veriﬁcation code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a conﬁrmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Accessing Timestream for LiveAnalytics 56 Amazon Timestream Developer Guide Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Conﬁgure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Provide Timestream for LiveAnalytics access The permissions that are required to access Timestream for LiveAnalytics are already granted to the administrator. For other users, you should grant them Timestream for LiveAnalytics access using the following policy: { "Version": "2012-10-17", "Statement": [ Accessing Timestream for LiveAnalytics 57 Developer Guide Amazon Timestream { "Effect": "Allow", "Action": [ "timestream:", "kms:DescribeKey", "kms:CreateGrant", "kms:Decrypt", "dbqms:CreateFavoriteQuery", "dbqms:DescribeFavoriteQueries", "dbqms:UpdateFavoriteQuery", "dbqms:DeleteFavoriteQueries", "dbqms:GetQueryString", "dbqms:CreateQueryHistory", "dbqms:UpdateQueryHistory", "dbqms:DeleteQueryHistory", "dbqms:DescribeQueryHistory", "s3:ListAllMyBuckets" ], "Resource": "" } ] } Note For information about dbqms, see Actions, resources, and condition keys for Database Query Metadata Service. For information about kms see Actions, resources, and condition keys for AWS Key Management Service. Grant programmatic access Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. To grant users programmatic access, choose one of the following options. Accessing Timestream for LiveAnalytics 58 Amazon Timestream Developer Guide Which user needs programmatic access? To By Workforce identity (Users managed in IAM Identity
timestream-025	timestream.pdf	25	Note For information about dbqms, see Actions, resources, and condition keys for Database Query Metadata Service. For information about kms see Actions, resources, and condition keys for AWS Key Management Service. Grant programmatic access Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. To grant users programmatic access, choose one of the following options. Accessing Timestream for LiveAnalytics 58 Amazon Timestream Developer Guide Which user needs programmatic access? To By Workforce identity (Users managed in IAM Identity Center) Use temporary credentials to sign programmatic requests Following the instructions for the interface that you want to to the AWS CLI, AWS SDKs, or use. AWS APIs. • For the AWS CLI, see Conﬁguring the AWS CLI to use AWS IAM Identity Center in the AWS Command Line Interface User Guide. • For AWS SDKs, tools, and AWS APIs, see IAM Identity Center authentication in the AWS SDKs and Tools Reference Guide. IAM IAM Use temporary credentials to sign programmatic requests Following the instructions in Using temporary credentia to the AWS CLI, AWS SDKs, or ls with AWS resources in the AWS APIs. IAM User Guide. (Not recommended) Use long-term credentials to Following the instructions for the interface that you want to sign programmatic requests use. to the AWS CLI, AWS SDKs, or AWS APIs. • For the AWS CLI, see Authenticating using IAM user credentials in the AWS Command Line Interface User Guide. • For AWS SDKs and tools, see Authenticate using long-term credentials in Accessing Timestream for LiveAnalytics 59 Amazon Timestream Developer Guide Which user needs programmatic access? To By the AWS SDKs and Tools Reference Guide. • For AWS APIs, see Managing access keys for IAM users in the IAM User Guide. Using the console You can use the AWS Management Console for Timestream Live Analytics to create, edit, delete, describe, and list databases and tables. You can also use the console to run queries. Topics • Tutorial • Create a database • Create a table • Run a query • Create a scheduled query • Delete a scheduled query • Delete a table • Delete a database • Edit a table • Edit a database Tutorial This tutorial shows you how to create a database populated with sample data sets and run sample queries. The sample datasets used in this tutorial are frequently seen in IoT and DevOps scenarios. The IoT dataset contains time series data such as the speed, location, and load of a truck, to streamline ﬂeet management and identify optimization opportunities. The DevOps dataset Using the console 60 Amazon Timestream Developer Guide contains EC2 instance metrics such as CPU, network, and memory utilization to improve application performance and availability. Here's a video tutorial for the instructions described in this section Follow these steps to create a database populated with the sample data sets and run sample queries using the AWS Console. 1. Open the AWS Console. 2. In the navigation pane, choose Databases 3. Click on Create database. 4. On the create database page, enter the following: • Choose conﬁguration—Select Sample database. • Name—Enter a database name of your choice. • Choose sample datasets—Select IoT and DevOps. • Click on Create database to create a database containing two tables—IoT and DevOps populated with sample data. 5. 6. In the navigation pane, choose Query editor Select Sample queries from the top menu. 7. Click on one of the sample queries. This will take you back to the query editor with the editor populated with the sample query. 8. Click Run to run the query and see query results. Create a database Follow these steps to create a database using the AWS Console. 1. Open the AWS Console. 2. In the navigation pane, choose Databases 3. Click on Create database. 4. On the create database page, enter the following. • Choose conﬁguration—Select Standard database. • Name—Enter a database name of your choice. • Encryption —Choose a KMS key or use the default option, where Timestream Live Analytics will create a KMS key in your account if one does not already exist. Using the console 61 Amazon Timestream Developer Guide 5. Click on Create database to create a database. Create a table Follow these steps to create a table using the AWS Console. 1. Open the AWS Console. 2. In the navigation pane, choose Tables 3. Click on Create table. 4. On the create table page, enter the following. • Database name—Select the name of the database created in Create a database. • Table name—Enter a table name of your choice. • Memory store retention—Specify how long you want to retain data in the memory store. The memory store processes incoming data, including late arriving
timestream-026	timestream.pdf	26	61 Amazon Timestream Developer Guide 5. Click on Create database to create a database. Create a table Follow these steps to create a table using the AWS Console. 1. Open the AWS Console. 2. In the navigation pane, choose Tables 3. Click on Create table. 4. On the create table page, enter the following. • Database name—Select the name of the database created in Create a database. • Table name—Enter a table name of your choice. • Memory store retention—Specify how long you want to retain data in the memory store. The memory store processes incoming data, including late arriving data (data with a timestamp earlier than the current time) and is optimized for fast point-in-time queries. • Magnetic store retention—Specify how long you want to retain data in the magnetic store. The magnetic store is meant for long term storage and is optimized for fast analytical queries. 5. Click on Create table. Run a query Follow these steps to run queries using the AWS Console. 1. Open the AWS Console. 2. 3. 4. 5. In the navigation pane, choose Query editor In the left pane, select the database created in Create a database. In the left pane, select the database created in Create a table. In the query editor, you can run a query. To see the latest 10 rows in the table, run: SELECT * FROM <database_name>.<table_name> ORDER BY time DESC LIMIT 10 6. (Optional) Turn on Enable Insights to get insights about the eﬃciency of your queries. Using the console 62 Amazon Timestream Create a scheduled query Developer Guide Follow these steps to create a scheduled query using the AWS Console. 1. Open the AWS Console. 2. In the navigation pane, choose Scheduled queries. 3. Click on Create scheduled query. 4. In the Query Name and Destination Table sections, enter the following. • Name—Enter a query name. • Database name—Select the name of the database created in Create a database. • Table name—Select the name of the table created in Create a table. 5. 6. 7. 8. 9. In the Query Statement section, enter a valid query statement. Then click Validate query. From Destination table model, deﬁne the model for any undeﬁned attributes. You can use Visual builder or JSON. In the Run schedule section, choose Fixed rate or Chron expression.For chron expressions, refer to Schedule Expressions for Scheduled Queries for more details on schedule expressions. In the SNS topic section, enter the SNS topic that will be used to for notiﬁcation. In the Error log report section enter the S3 location that will be used to report errors. Choose the Encryption key type. 10. In the Security settings section from AWS KMS key, choose the type of AWS KMS key. Enter the IAM role that Timestream for LiveAnalytics will use to run the scheduled query. Refer to the IAM policy examples for scheduled queries for details on the required permissions and trust relationship for the role. 11. Click Create scheduled query. Delete a scheduled query Follow these steps to delete or disable a scheduled query using the AWS Console. 1. Open the AWS Console. 2. 3. In the navigation pane, choose Scheduled queries Select the scheduled query created in Create a scheduled query. Using the console 63 Developer Guide Amazon Timestream 4. Select Actions. 5. Choose Disable or Delete. 6. If you selected Delete, conﬁrm the action and select Delete. Delete a table Follow these steps to delete a database using the AWS Console. 1. Open the AWS Console. 2. 3. In the navigation pane, choose Tables Select the table that you created in Create a table. 4. Click Delete. 5. Type delete in the conﬁrmation box. Delete a database Follow these steps to delete a database using the AWS Console: 1. Open the AWS Console. 2. 3. In the navigation pane, choose Databases Select the database that you created in Create a database. 4. Click Delete. 5. Type delete in the conﬁrmation box. Edit a table Follow these steps to edit a table using the AWS Console. 1. Open the AWS Console. 2. 3. In the navigation pane, choose Tables Select the table that you created in Create a table. 4. Click Edit 5. Edit the table details and save. Using the console 64 Amazon Timestream Developer Guide • Memory store retention—Specify how long you want to retain data in the memory store. The memory store processes incoming data, including late arriving data (data with a timestamp earlier than the current time) and is optimized for fast point-in-time queries. • Magnetic store retention—Specify how long you want to retain data in the magnetic store. The magnetic store is meant for long term storage and is optimized for fast analytical queries. Edit a database Follow these steps to edit a database using the AWS Console. 1.
timestream-027	timestream.pdf	27	the table details and save. Using the console 64 Amazon Timestream Developer Guide • Memory store retention—Specify how long you want to retain data in the memory store. The memory store processes incoming data, including late arriving data (data with a timestamp earlier than the current time) and is optimized for fast point-in-time queries. • Magnetic store retention—Specify how long you want to retain data in the magnetic store. The magnetic store is meant for long term storage and is optimized for fast analytical queries. Edit a database Follow these steps to edit a database using the AWS Console. 1. Open the AWS Console. 2. 3. In the navigation pane, choose Databases Select the database that you created in Create a database. 4. Click Edit 5. Edit the database details and save. Accessing Amazon Timestream for LiveAnalytics using the AWS CLI You can use the AWS Command Line Interface (AWS CLI) to control multiple AWS services from the command line and automate them through scripts. You can use the AWS CLI for ad hoc operations. You can also use it to embed Amazon Timestream for LiveAnalytics operations within utility scripts. Before you can use the AWS CLI with Timestream for LiveAnalytics, you must set up programmatic access. For more information, see Grant programmatic access. For a complete listing of all the commands available for the Timestream for LiveAnalytics Query API in the AWS CLI, see the AWS CLI Command Reference. For a complete listing of all the commands available for the Timestream for LiveAnalytics Write API in the AWS CLI, see the AWS CLI Command Reference. Topics • Downloading and conﬁguring the AWS CLI • Using the AWS CLI with Timestream for LiveAnalytics Using the AWS CLI 65 Amazon Timestream Developer Guide Downloading and conﬁguring the AWS CLI The AWS CLI runs on Windows, macOS, or Linux. To download, install, and conﬁgure it, follow these steps: 1. Download the AWS CLI at http://aws.amazon.com/cli. 2. Follow the instructions for Installing the AWS CLI and Conﬁguring the AWS CLI in the AWS Command Line Interface User Guide. Using the AWS CLI with Timestream for LiveAnalytics The command line format consists of an Amazon Timestream for LiveAnalytics operation name, followed by the parameters for that operation. The AWS CLI supports a shorthand syntax for the parameter values, in addition to JSON. Use help to list all available commands in Timestream for LiveAnalytics. For example: aws timestream-write help aws timestream-query help You can also use help to describe a speciﬁc command and learn more about its usage: aws timestream-write create-database help For example, to create a database: aws timestream-write create-database --database-name myFirstDatabase To create a table with magnetic store writes enabled: aws timestream-write create-table \ --database-name metricsdb \ --table-name metrics \ --magnetic-store-write-properties "{\"EnableMagneticStoreWrites\": true}" To write data using single-measure records: aws timestream-write write-records \ Using the AWS CLI 66 Amazon Timestream --database-name metricsdb \ Developer Guide --table-name metrics \ --common-attributes "{\"Dimensions\":[{\"Name\":\"asset_id\", \"Value\":\"100\"}], \"Time\":\"1631051324000\",\"TimeUnit\":\"MILLISECONDS\"}" \ --records "[{\"MeasureName\":\"temperature\", \"MeasureValueType\":\"DOUBLE\", \"MeasureValue\":\"30\"},{\"MeasureName\":\"windspeed\", \"MeasureValueType\":\"DOUBLE \",\"MeasureValue\":\"7\"},{\"MeasureName\":\"humidity\", \"MeasureValueType\":\"DOUBLE \",\"MeasureValue\":\"15\"},{\"MeasureName\":\"brightness\", \"MeasureValueType\": \"DOUBLE\",\"MeasureValue\":\"17\"}]" To write data using multi-measure records: # wide model helper method to create Multi-measure records function ingest_multi_measure_records { epoch=`date +%s` epoch+=$i # multi-measure records aws timestream-write write-records \ --database-name $src_db_wide \ --table-name $src_tbl_wide \ --common-attributes "{\"Dimensions\":[{\"Name\":\"device_id\", \ \"Value\":\"12345678\"},\ {\"Name\":\"device_type\", \"Value\":\"iPhone\"}, \ {\"Name\":\"os_version\", \"Value\":\"14.8\"}, \ {\"Name\":\"region\", \"Value\":\"us-east-1\"} ], \ \"Time\":\"$epoch\",\"TimeUnit\":\"MILLISECONDS\"}" \ --records "[{\"MeasureName\":\"video_metrics\", \"MeasureValueType\":\"MULTI\", \ \"MeasureValues\": \ [{\"Name\":\"video_startup_time\",\"Value\":\"0\",\"Type\":\"BIGINT\"}, \ {\"Name\":\"rebuffering_ratio\",\"Value\":\"0.5\",\"Type\":\"DOUBLE\"}, \ {\"Name\":\"video_playback_failures\",\"Value\":\"0\",\"Type\":\"BIGINT\"}, \ {\"Name\":\"average_frame_rate\",\"Value\":\"0.5\",\"Type\":\"DOUBLE\"}]}]" \ --endpoint-url $ingest_endpoint \ --region $region } # create 5 records for i in {100..105}; do ingest_multi_measure_records $i; done To query a table: Using the AWS CLI 67 Amazon Timestream Developer Guide aws timestream-query query \ --query-string "SELECT time, device_id, device_type, os_version, region, video_startup_time, rebuffering_ratio, video_playback_failures, \ average_frame_rate \ FROM metricsdb.metrics \ where time >= ago (15m)" To create a scheduled query: aws timestream-query create-scheduled-query \ --name scheduled_query_name \ --query-string "select bin(time, 1m) as time, \ avg(measure_value::double) as avg_cpu, min(measure_value::double) as min_cpu, region \ from $src_db.$src_tbl where measure_name = 'cpu' \ and time BETWEEN @scheduled_runtime - (interval '5' minute) AND @scheduled_runtime \ group by region, bin(time, 1m)" \ --schedule-configuration "{\"ScheduleExpression\":\"$cron_exp\"}" \ --notification-configuration "{\"SnsConfiguration\":{\"TopicArn\":\"$sns_topic_arn \"}}" \ --scheduled-query-execution-role-arn "arn:aws:iam::452360119086:role/ TimestreamSQExecutionRole" \ --target-configuration "{\"TimestreamConfiguration\":{\ \"DatabaseName\": \"$dest_db\",\ \"TableName\": \"$dest_tbl\",\ \"TimeColumn\":\"time\",\ \"DimensionMappings\":[{\ \"Name\": \"region\", \"DimensionValueType\": \"VARCHAR\" }],\ \"MultiMeasureMappings\":{\ \"TargetMultiMeasureName\": \"mma_name\", \"MultiMeasureAttributeMappings\":[{\ \"SourceColumn\": \"avg_cpu\", \"MeasureValueType\": \"DOUBLE\", \"TargetMultiMeasureAttributeName\": \"target_avg_cpu\" },\ { \ \"SourceColumn\": \"min_cpu\", \"MeasureValueType\": \"DOUBLE\", \"TargetMultiMeasureAttributeName\": \"target_min_cpu\" }] \ }\ }}" \ --error-report-configuration "{\"S3Configuration\": {\ Using the AWS CLI 68 Amazon Timestream Developer Guide \"BucketName\": \"$s3_err_bucket\",\ \"ObjectKeyPrefix\": \"scherrors\",\ \"EncryptionOption\": \"SSE_S3\"\ }\ }" Using the API In addition to the SDKs, Amazon Timestream for LiveAnalytics provides direct REST API access via the endpoint discovery pattern. The endpoint discovery pattern is described below, along with its use cases. The endpoint discovery pattern Because Timestream Live Analytics's SDKs are designed to transparently work with the service's architecture, including the management and mapping of the service endpoints,
timestream-028	timestream.pdf	28	\"avg_cpu\", \"MeasureValueType\": \"DOUBLE\", \"TargetMultiMeasureAttributeName\": \"target_avg_cpu\" },\ { \ \"SourceColumn\": \"min_cpu\", \"MeasureValueType\": \"DOUBLE\", \"TargetMultiMeasureAttributeName\": \"target_min_cpu\" }] \ }\ }}" \ --error-report-configuration "{\"S3Configuration\": {\ Using the AWS CLI 68 Amazon Timestream Developer Guide \"BucketName\": \"$s3_err_bucket\",\ \"ObjectKeyPrefix\": \"scherrors\",\ \"EncryptionOption\": \"SSE_S3\"\ }\ }" Using the API In addition to the SDKs, Amazon Timestream for LiveAnalytics provides direct REST API access via the endpoint discovery pattern. The endpoint discovery pattern is described below, along with its use cases. The endpoint discovery pattern Because Timestream Live Analytics's SDKs are designed to transparently work with the service's architecture, including the management and mapping of the service endpoints, it is recommended that you use the SDKs for most applications. However, there are a few instances where use of the Timestream for LiveAnalytics REST API endpoint discovery pattern is necessary: • You are using VPC endpoints (AWS PrivateLink) with Timestream for LiveAnalytics • Your application uses a programming language that does not yet have SDK support • You require better control over the client-side implementation This section includes information on how the endpoint discovery pattern works, how to implement the endpoint discovery pattern, and usage notes. Select a topic below to learn more. Topics • How the endpoint discovery pattern works • Implementing the endpoint discovery pattern How the endpoint discovery pattern works Timestream is built using a cellular architecture to ensure better scaling and traﬃc isolation properties. Because each customer account is mapped to a speciﬁc cell in a region, your application must use the correct cell-speciﬁc endpoints that your account has been mapped to. When using the SDKs, this mapping is transparently handled for you and you do not need to manage the cell- speciﬁc endpoints. However, when directly accessing the REST API, you will need to manage and map the correct endpoints yourself. This process, the endpoint discovery pattern, is described below: Using the API 69 Amazon Timestream Developer Guide 1. The endpoint discovery pattern starts with a call to the DescribeEndpoints action (described in the DescribeEndpoints section). 2. The endpoint should be cached and reused for the amount of time speciﬁed by the returned time-to-live (TTL) value (the CachePeriodInMinutes). Calls to the Timestream Live Analytics API can then be made for the duration of the TTL. 3. After the TTL expires, a new call to DescribeEndpoints should be made to refresh the endpoint (in other words, start over at Step 1). Note Syntax, parameters and other usage information for the DescribeEndpoints action are described in the API Reference. Note that the DescribeEndpoints action is available via both SDKs, and is identical for each. For implementation of the endpoint discovery pattern, see Implementing the endpoint discovery pattern. Implementing the endpoint discovery pattern To implement the endpoint discovery pattern, choose an API (Write or Query), create a DescribeEndpoints request, and use the returned endpoint(s) for the duration of the returned TTL value(s). The implementation procedure is described below. Note Ensure you are familiar with the usage notes. Implementation procedure 1. Acquire the endpoint for the API you would like to make calls against (Write or Query). using the DescribeEndpoints request. a. Create a request for DescribeEndpoints that corresponds to the API of interest (Write or Query) using one of the two endpoints described below. There are no input parameters for the request. Ensure that you read the notes below. Using the API 70 Amazon Timestream Write SDK: Developer Guide ingest.timestream.<region>.amazonaws.com Query SDK: query.timestream.<region>.amazonaws.com An example CLI call for region us-east-1 follows. REGION_ENDPOINT="https://query.timestream.us-east-1.amazonaws.com" REGION=us-east-1 aws timestream-write describe-endpoints \ --endpoint-url $REGION_ENDPOINT \ --region $REGION Note The HTTP "Host" header must also contain the API endpoint. The request will fail if the header is not populated. This is a standard requirement for all HTTP/1.1 requests. If you use an HTTP library supporting 1.1 or later, the HTTP library should automatically populate the header for you. Note Substitute <region> with the region identiﬁer for the region the request is being made in, e.g. us-east-1 b. Parse the response to extract the endpoint(s), and cache TTL value(s). The response is an array of one or more Endpoint objects . Each Endpoint object contains an endpoint address (Address) and the TTL for that endpoint (CachePeriodInMinutes). 2. Cache the endpoint for up to the speciﬁed TTL. 3. When the TTL expires, retrieve a new endpoint by starting over at step 1 of the Implementation. Using the API 71 Amazon Timestream Developer Guide Usage notes for the endpoint discovery pattern • The DescribeEndpoints action is the only action that Timestream Live Analytics regional endpoints recognize. • The response contains a list of endpoints to make Timestream Live Analytics API calls against. • On successful response, there should be at least one endpoint in the list. If there is more than one endpoint in the list, any of them are equally usable for the API calls,
timestream-029	timestream.pdf	29	speciﬁed TTL. 3. When the TTL expires, retrieve a new endpoint by starting over at step 1 of the Implementation. Using the API 71 Amazon Timestream Developer Guide Usage notes for the endpoint discovery pattern • The DescribeEndpoints action is the only action that Timestream Live Analytics regional endpoints recognize. • The response contains a list of endpoints to make Timestream Live Analytics API calls against. • On successful response, there should be at least one endpoint in the list. If there is more than one endpoint in the list, any of them are equally usable for the API calls, and the caller may choose the endpoint to use at random. • In addition to the DNS address of the endpoint, each endpoint in the list will specify a time to live (TTL) that is allowable for using the endpoint speciﬁed in minutes. • The endpoint should be cached and reused for the amount of time speciﬁed by the returned TTL value (in minutes). After the TTL expires a new call to DescribeEndpoints should be made to refresh the endpoint to use, as the endpoint will no longer work after the TTL has expired. Using the AWS SDKs You can access Amazon Timestream using the AWS SDKs. Timestream supports two SDKs per language; namely, the Write SDK and the Query SDK. The Write SDK is used to perform CRUD operations and to insert your time series data into Timestream. The Query SDK is used to query your existing time series data stored in Timestream. Once you've completed the necessary prerequisites for your SDK of choice, you can get started with the Code samples. Topics • Java • Java v2 • Go • Python • Node.js • .NET Using the AWS SDKs 72 Amazon Timestream Java Developer Guide To get started with the Java 1.0 SDK and Amazon Timestream, complete the prerequisites, described below. Once you've completed the necessary prerequisites for the Java SDK, you can get started with the Code samples. Prerequisites Before you get started with Java, you must do the following: 1. 2. Follow the AWS setup instructions in Accessing Timestream for LiveAnalytics. Set up a Java development environment by downloading and installing the following: • Java SE Development Kit 8 (such as Amazon Corretto 8). • Java IDE (such as Eclipse or IntelliJ). For more information, see Getting Started with the AWS SDK for Java 3. Conﬁgure your AWS credentials and Region for development: • Set up your AWS security credentials for use with the AWS SDK for Java. • Set your AWS Region to determine your default Timestream for LiveAnalytics endpoint. Using Apache Maven You can use Apache Maven to conﬁgure and build AWS SDK for Java projects. Note To use Apache Maven, ensure your Java SDK and runtime are 1.8 or higher. You can conﬁgure the AWS SDK as a Maven dependency as described in Using the SDK with Apache Maven. You can run compile and run your source code with the following command: mvn clean compile Using the AWS SDKs 73 Amazon Timestream Developer Guide mvn exec:java -Dexec.mainClass=<your source code Main class> Note <your source code Main class> is the path to your Java source code's main class. Setting your AWS credentials The AWS SDK for Java requires that you provide AWS credentials to your application at runtime. The code examples in this guide assume that you are using an AWS credentials ﬁle, as described in Set up AWS Credentials and Region for Development in the AWS SDK for Java Developer Guide. The following is an example of an AWS credentials ﬁle named ~/.aws/credentials, where the tilde character (~) represents your home directory. [default] aws_access_key_id = AWS access key ID goes here aws_secret_access_key = Secret key goes here Java v2 To get started with the Java 2.0 SDK and Amazon Timestream, complete the prerequisites, described below. Once you've completed the necessary prerequisites for the Java 2.0 SDK, you can get started with the Code samples. Prerequisites Before you get started with Java, you must do the following: 1. Follow the AWS setup instructions in Accessing Timestream for LiveAnalytics. 2. You can conﬁgure the AWS SDK as a Maven dependency as described in Using the SDK with Apache Maven. 3. Set up a Java development environment by downloading and installing the following: • Java SE Development Kit 8 (such as Amazon Corretto 8). • Java IDE (such as Eclipse or IntelliJ). Using the AWS SDKs 74 Amazon Timestream Developer Guide For more information, see Getting Started with the AWS SDK for Java Using Apache Maven You can use Apache Maven to conﬁgure and build AWS SDK for Java projects. Note To use Apache Maven, ensure your Java SDK and runtime are 1.8 or higher. You can conﬁgure the AWS SDK as a Maven dependency as
timestream-030	timestream.pdf	30	SDK with Apache Maven. 3. Set up a Java development environment by downloading and installing the following: • Java SE Development Kit 8 (such as Amazon Corretto 8). • Java IDE (such as Eclipse or IntelliJ). Using the AWS SDKs 74 Amazon Timestream Developer Guide For more information, see Getting Started with the AWS SDK for Java Using Apache Maven You can use Apache Maven to conﬁgure and build AWS SDK for Java projects. Note To use Apache Maven, ensure your Java SDK and runtime are 1.8 or higher. You can conﬁgure the AWS SDK as a Maven dependency as described in Using the SDK with Apache Maven. The changes required to the pom.xml ﬁle are described here. You can run compile and run your source code with the following command: mvn clean compile mvn exec:java -Dexec.mainClass=<your source code Main class> Note <your source code Main class> is the path to your Java source code's main class. Go To get started with the Go SDK and Amazon Timestream, complete the prerequisites, described below. Once you've completed the necessary prerequisites for the Go SDK, you can get started with the Code samples. Prerequisites 1. Download the GO SDK 1.14. 2. Conﬁgure the GO SDK. 3. Construct your client. Using the AWS SDKs 75 Amazon Timestream Python Developer Guide To get started with the Python SDK and Amazon Timestream, complete the prerequisites, described below. Once you've completed the necessary prerequisites for the Python SDK, you can get started with the Code samples. Prerequisites To use Python, install and conﬁgure Boto3, following the instructions here. Node.js To get started with the Node.js SDK and Amazon Timestream, complete the prerequisites, described below. Once you've completed the necessary prerequisites for the Node.js SDK, you can get started with the Code samples. Prerequisites Before you get started with Node.js, you must do the following: 1. 2. Install Node.js. Install the AWS SDK for JavaScript. .NET To get started with the .NET SDK and Amazon Timestream, complete the prerequisites, described below. Once you've completed the necessary prerequisites for the .NET SDK, you can get started with the Code samples. Prerequisites Before you get started with .NET, install the required NuGet packages and ensure that AWSSDK.Core version is 3.3.107 or newer by running the following commands: dotnet add package AWSSDK.Core Using the AWS SDKs 76 Amazon Timestream Developer Guide dotnet add package AWSSDK.TimestreamWrite dotnet add package AWSSDK.TimestreamQuery Getting started This section includes a tutorial to get you started with Amazon Timestream Live Analytics, as well as instructions for setting up a fully functional sample application. You can get started with the tutorial or the sample application by selecting one of the links below. Topics • Tutorial • Sample application Tutorial This tutorial shows you how to create a database populated with sample data sets and run sample queries. The sample data sets used in this tutorial are frequently seen in IoT and DevOps scenarios. The IoT data set contains time series data such as the speed, location, and load of a truck, to streamline ﬂeet management and identify optimization opportunities. The DevOps data set contains EC2 instance metrics such as CPU, network, and memory utilization to improve application performance and availability. Here's a video tutorial for the instructions described in this section. Follow these steps to create a database populated with the sample data sets and run sample queries using the AWS Console: Using the console Follow these steps to create a database populated with the sample data sets and run sample queries using the AWS Console: 1. Open the AWS Console. 2. In the navigation pane, choose Databases. 3. Click on Create database. 4. On the create database page, enter the following: • Choose conﬁguration—Select Sample database. Getting started 77 Amazon Timestream Developer Guide • Name—Enter a database name of your choice. Note After creating a database with sample data sets, to use the sample queries which are available in the console, you can adjust the database name referenced in the query to match the database name you enter here. There are sample queries for each combination of sample data set and type of time series records. • Choose sample data sets—Select IoT and DevOps. • Choose the type of time series records—Select Multi-measure records. • Click on Create database to create a database containing two tables populated with sample data. The table names for sample data sets with multi-measure records are DevOpsMulti and IoTMulti. The table names for sample datasets with single-measure records are DevOps and IoT. 5. 6. In the navigation pane, choose Query editor. Select Sample queries from the top menu. 7. Click on one of the sample queries for a data set you chose when creating the sample database. This will take you back to the query editor with the editor populated with
timestream-031	timestream.pdf	31	the type of time series records—Select Multi-measure records. • Click on Create database to create a database containing two tables populated with sample data. The table names for sample data sets with multi-measure records are DevOpsMulti and IoTMulti. The table names for sample datasets with single-measure records are DevOps and IoT. 5. 6. In the navigation pane, choose Query editor. Select Sample queries from the top menu. 7. Click on one of the sample queries for a data set you chose when creating the sample database. This will take you back to the query editor with the editor populated with the sample query. 8. Adjust the database name for the sample query. 9. Click Run to run the query and see query results. Using the SDKs Timestream Live Analytics provides a fully functional sample application that shows you how to create a database and table, populate the table with ~126K rows of sample data, and run sample queries. The sample application is available in GitHub for Java, Python, Node.js, Go, and .NET. 1. Clone the GitHub repository Timestream Live Analytics sample applications following the instructions from GitHub. 2. Conﬁgure the AWS SDK to connect to Amazon Timestream Live Analytics following the instructions described in Using the AWS SDKs. 3. Compile and run the sample application using the instructions below: • Instructions for the Java sample application. Tutorial 78 Amazon Timestream Developer Guide • Instructions for the Java v2 sample application. • Instructions for the Go sample application. • Instructions for the Python sample application. • Instructions for the Node.js sample application. • Instructions for the .NET sample application. Sample application Timestream ships with a fully functional sample application that shows how to create a database and table, populate the table with ~126K rows of sample data, and run sample queries. Follow the steps below to get started with the sample application in any of the supported languages: Java 1. Clone the GitHub repository Timestream for LiveAnalytics sample applications following the instructions from GitHub. 2. Conﬁgure the AWS SDK to connect to Timestream for LiveAnalytics following the instructions described in Getting Started with Java. 3. Run the Java sample application following the instructions described here Java v2 1. Clone the GitHub repository Timestream for LiveAnalytics sample applications following the instructions from GitHub. 2. Conﬁgure the AWS SDK to connect to Amazon Timestream for LiveAnalytics following the instructions described in Getting Started with Java v2. 3. Run the Java 2.0 sample application following the instructions described here Go 1. Clone the GitHub repository Timestream for LiveAnalytics sample applications following the instructions from GitHub. 2. Conﬁgure the AWS SDK to connect to Amazon Timestream for LiveAnalytics following the instructions described in Getting Started with Go. 3. Run the Go sample application following the instructions described here Sample application 79 Amazon Timestream Python Developer Guide 1. Clone the GitHub repository Timestream for LiveAnalytics sample applications following the instructions from GitHub. 2. Conﬁgure the AWS SDK to connect to Amazon Timestream for LiveAnalytics following the instructions described in Python. 3. Run the Python sample application following the instructions described here Node.js 1. Clone the GitHub repository Timestream for LiveAnalytics sample applications following the instructions from GitHub. 2. Conﬁgure the AWS SDK to connect to Amazon Timestream for LiveAnalytics following the instructions described in Getting Started with Node.js. 3. Run the Node.js sample application following the instructions described here .NET 1. Clone the GitHub repository Timestream for LiveAnalytics sample applications following the instructions from GitHub. 2. Conﬁgure the AWS SDK to connect to Amazon Timestream for LiveAnalytics following the instructions described in Getting Started with .NET. 3. Run the .NET sample application following the instructions described here Code samples You can access Amazon Timestream using the AWS SDKs. Timestream supports two SDKs per language; namely, the Write SDK and the Query SDK. The Write SDK is used to perform CRUD operations and to insert your time series data into Timestream. The Query SDK is used to query your existing time series data stored in Timestream. Select a topic from the list below for more details, including code samples for each of the supported SDKs. Topics • Write SDK client • Query SDK client Code samples 80 Developer Guide Amazon Timestream • Create database • Describe database • Update database • Delete database • List databases • Create table • Describe table • Update table • Delete table • List tables • Write data (inserts and upserts) • Run query • Run UNLOAD query • Cancel query • Create batch load task • Describe batch load task • List batch load tasks • Resume batch load task • Create scheduled query • List scheduled query • Describe scheduled query • Execute scheduled query • Update scheduled query • Delete scheduled query Write SDK client You can use
timestream-032	timestream.pdf	32	Developer Guide Amazon Timestream • Create database • Describe database • Update database • Delete database • List databases • Create table • Describe table • Update table • Delete table • List tables • Write data (inserts and upserts) • Run query • Run UNLOAD query • Cancel query • Create batch load task • Describe batch load task • List batch load tasks • Resume batch load task • Create scheduled query • List scheduled query • Describe scheduled query • Execute scheduled query • Update scheduled query • Delete scheduled query Write SDK client You can use the following code snippets to create a Timestream client for the Write SDK. The Write SDK is used to perform CRUD operations and to insert your time series data into Timestream. Write SDK client 81 Amazon Timestream Note Developer Guide These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java private static AmazonTimestreamWrite buildWriteClient() { final ClientConfiguration clientConfiguration = new ClientConfiguration() .withMaxConnections(5000) .withRequestTimeout(20 * 1000) .withMaxErrorRetry(10); return AmazonTimestreamWriteClientBuilder .standard() .withRegion("us-east-1") .withClientConfiguration(clientConfiguration) .build(); } Java v2 private static TimestreamWriteClient buildWriteClient() { ApacheHttpClient.Builder httpClientBuilder = ApacheHttpClient.builder(); httpClientBuilder.maxConnections(5000); RetryPolicy.Builder retryPolicy = RetryPolicy.builder(); retryPolicy.numRetries(10); ClientOverrideConfiguration.Builder overrideConfig = ClientOverrideConfiguration.builder(); overrideConfig.apiCallAttemptTimeout(Duration.ofSeconds(20)); overrideConfig.retryPolicy(retryPolicy.build()); return TimestreamWriteClient.builder() .httpClientBuilder(httpClientBuilder) .overrideConfiguration(overrideConfig.build()) .region(Region.US_EAST_1) .build(); Write SDK client 82 Amazon Timestream } Go Developer Guide tr := &http.Transport{ ResponseHeaderTimeout: 20 * time.Second, // Using DefaultTransport values for other parameters: https://golang.org/ pkg/net/http/#RoundTripper Proxy: http.ProxyFromEnvironment, DialContext: (&net.Dialer{ KeepAlive: 30 * time.Second, DualStack: true, Timeout: 30 * time.Second, }).DialContext, MaxIdleConns: 100, IdleConnTimeout: 90 * time.Second, TLSHandshakeTimeout: 10 * time.Second, ExpectContinueTimeout: 1 * time.Second, } // So client makes HTTP/2 requests http2.ConfigureTransport(tr) sess, err := session.NewSession(&aws.Config{ Region: aws.String("us-east-1"), MaxRetries: aws.Int(10), HTTPClient: &http.Client{ Transport: tr }}) writeSvc := timestreamwrite.New(sess) Python write_client = session.client('timestream-write', config=Config(read_timeout=20, max_pool_connections = 5000, retries={'max_attempts': 10})) Node.js The following snippet uses AWS SDK for JavaScript v3. For more information about how to install the client and usage, see Timestream Write Client - AWS SDK for JavaScript v3. An additional command import is shown here. The CreateDatabaseCommand import is not required to create the client. import { TimestreamWriteClient, CreateDatabaseCommand } from "@aws-sdk/client- timestream-write"; Write SDK client 83 Amazon Timestream Developer Guide const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); The following snippet uses the AWS SDK for JavaScript V2 style. It is based on the sample application at Node.js sample Amazon Timestream for LiveAnalytics application on GitHub. var https = require('https'); var agent = new https.Agent({ maxSockets: 5000 }); writeClient = new AWS.TimestreamWrite({ maxRetries: 10, httpOptions: { timeout: 20000, agent: agent } }); .NET var writeClientConfig = new AmazonTimestreamWriteConfig { RegionEndpoint = RegionEndpoint.USEast1, Timeout = TimeSpan.FromSeconds(20), MaxErrorRetry = 10 }; var writeClient = new AmazonTimestreamWriteClient(writeClientConfig); We recommend you use the following conﬁguration. • Set the SDK retry count to 10. • Use SDK DEFAULT_BACKOFF_STRATEGY. • Set RequestTimeout to 20 seconds. • Set the max connections to 5000 or higher. Query SDK client You can use the following code snippets to create a Timestream client for the Query SDK. The Query SDK is used to query your existing time series data stored in Timestream. Query SDK client 84 Amazon Timestream Note Developer Guide These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java private static AmazonTimestreamQuery buildQueryClient() { AmazonTimestreamQuery client = AmazonTimestreamQueryClient.builder().withRegion("us-east-1").build(); return client; } Java v2 private static TimestreamQueryClient buildQueryClient() { return TimestreamQueryClient.builder() .region(Region.US_EAST_1) .build(); } Go sess, err := session.NewSession(&aws.Config{Region: aws.String("us-east-1")}) Python query_client = session.client('timestream-query') Node.js The following snippet uses AWS SDK for JavaScript v3. For more information about how to install the client and usage, see Timestream Query Client - ,AWS SDK for JavaScript v3. An additional command import is shown here. The QueryCommand import is not required to create the client. import { TimestreamQueryClient, QueryCommand } from "@aws-sdk/client-timestream- query"; Query SDK client 85 Amazon Timestream Developer Guide const queryClient = new TimestreamQueryClient({ region: "us-east-1" }); The following snippet uses the AWS SDK for JavaScript V2 style. It is based on the sample application at Node.js sample Amazon Timestream for LiveAnalytics application on GitHub. queryClient = new AWS.TimestreamQuery(); .NET var queryClientConfig = new AmazonTimestreamQueryConfig { RegionEndpoint = RegionEndpoint.USEast1 }; var queryClient = new AmazonTimestreamQueryClient(queryClientConfig); Create database You can use the following code snippets to create a database. Note These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java public void createDatabase() { System.out.println("Creating database"); CreateDatabaseRequest request = new CreateDatabaseRequest(); request.setDatabaseName(DATABASE_NAME); try { amazonTimestreamWrite.createDatabase(request); System.out.println("Database [" + DATABASE_NAME + "] created successfully"); } catch (ConflictException e) { System.out.println("Database [" + DATABASE_NAME + "] exists. Skipping database creation"); } Create database 86 Amazon Timestream }
timestream-033	timestream.pdf	33	queryClientConfig = new AmazonTimestreamQueryConfig { RegionEndpoint = RegionEndpoint.USEast1 }; var queryClient = new AmazonTimestreamQueryClient(queryClientConfig); Create database You can use the following code snippets to create a database. Note These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java public void createDatabase() { System.out.println("Creating database"); CreateDatabaseRequest request = new CreateDatabaseRequest(); request.setDatabaseName(DATABASE_NAME); try { amazonTimestreamWrite.createDatabase(request); System.out.println("Database [" + DATABASE_NAME + "] created successfully"); } catch (ConflictException e) { System.out.println("Database [" + DATABASE_NAME + "] exists. Skipping database creation"); } Create database 86 Amazon Timestream } Java v2 Developer Guide public void createDatabase() { System.out.println("Creating database"); CreateDatabaseRequest request = CreateDatabaseRequest.builder().databaseName(DATABASE_NAME).build(); try { timestreamWriteClient.createDatabase(request); System.out.println("Database [" + DATABASE_NAME + "] created successfully"); } catch (ConflictException e) { System.out.println("Database [" + DATABASE_NAME + "] exists. Skipping database creation"); } } Go // Create database. createDatabaseInput := &timestreamwrite.CreateDatabaseInput{ DatabaseName: aws.String(*databaseName), } _, err = writeSvc.CreateDatabase(createDatabaseInput) if err != nil { fmt.Println("Error:") fmt.Println(err) } else { fmt.Println("Database successfully created") } fmt.Println("Describing the database, hit enter to continue") Python def create_database(self): print("Creating Database") try: self.client.create_database(DatabaseName=Constant.DATABASE_NAME) Create database 87 Amazon Timestream Developer Guide print("Database [%s] created successfully." % Constant.DATABASE_NAME) except self.client.exceptions.ConflictException: print("Database [%s] exists. Skipping database creation" % Constant.DATABASE_NAME) except Exception as err: print("Create database failed:", err) Node.js The following snippet uses AWS SDK for JavaScript v3. For more information about how to install the client and usage, see Timestream Write Client - AWS SDK for JavaScript v3. Also see Class CreateDatabaseCommand and CreateDatabase. import { TimestreamWriteClient, CreateDatabaseCommand } from "@aws-sdk/client- timestream-write"; const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); const params = { DatabaseName: "testDbFromNode" }; const command = new CreateDatabaseCommand(params); try { const data = await writeClient.send(command); console.log(`Database ${data.Database.DatabaseName} created successfully`); } catch (error) { if (error.code === 'ConflictException') { console.log(`Database ${params.DatabaseName} already exists. Skipping creation.`); } else { console.log("Error creating database", error); } } The following snippet uses the AWS SDK for JavaScript V2 style. It is based on the sample application at Node.js sample Amazon Timestream for LiveAnalytics application on GitHub. async function createDatabase() { console.log("Creating Database"); const params = { DatabaseName: constants.DATABASE_NAME Create database 88 Amazon Timestream }; Developer Guide const promise = writeClient.createDatabase(params).promise(); await promise.then( (data) => { console.log(`Database ${data.Database.DatabaseName} created successfully`); }, (err) => { if (err.code === 'ConflictException') { console.log(`Database ${params.DatabaseName} already exists. Skipping creation.`); } else { console.log("Error creating database", err); } } ); } .NET public async Task CreateDatabase() { Console.WriteLine("Creating Database"); try { var createDatabaseRequest = new CreateDatabaseRequest { DatabaseName = Constants.DATABASE_NAME }; CreateDatabaseResponse response = await writeClient.CreateDatabaseAsync(createDatabaseRequest); Console.WriteLine($"Database {Constants.DATABASE_NAME} created"); } catch (ConflictException) { Console.WriteLine("Database already exists."); } catch (Exception e) { Console.WriteLine("Create database failed:" + e.ToString()); Create database 89 Amazon Timestream } } Describe database Developer Guide You can use the following code snippets to get information about the attributes of your newly created database. Note These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java public void describeDatabase() { System.out.println("Describing database"); final DescribeDatabaseRequest describeDatabaseRequest = new DescribeDatabaseRequest(); describeDatabaseRequest.setDatabaseName(DATABASE_NAME); try { DescribeDatabaseResult result = amazonTimestreamWrite.describeDatabase(describeDatabaseRequest); final Database databaseRecord = result.getDatabase(); final String databaseId = databaseRecord.getArn(); System.out.println("Database " + DATABASE_NAME + " has id " + databaseId); } catch (final Exception e) { System.out.println("Database doesn't exist = " + e); throw e; } } Java v2 public void describeDatabase() { System.out.println("Describing database"); final DescribeDatabaseRequest describeDatabaseRequest = DescribeDatabaseRequest.builder() Describe database 90 Amazon Timestream Developer Guide .databaseName(DATABASE_NAME).build(); try { DescribeDatabaseResponse response = timestreamWriteClient.describeDatabase(describeDatabaseRequest); final Database databaseRecord = response.database(); final String databaseId = databaseRecord.arn(); System.out.println("Database " + DATABASE_NAME + " has id " + databaseId); } catch (final Exception e) { System.out.println("Database doesn't exist = " + e); throw e; } } Go describeDatabaseOutput, err := writeSvc.DescribeDatabase(describeDatabaseInput) if err != nil { fmt.Println("Error:") fmt.Println(err) } else { fmt.Println("Describe database is successful, below is the output:") fmt.Println(describeDatabaseOutput) } Python def describe_database(self): print("Describing database") try: result = self.client.describe_database(DatabaseName=Constant.DATABASE_NAME) print("Database [%s] has id [%s]" % (Constant.DATABASE_NAME, result['Database']['Arn'])) except self.client.exceptions.ResourceNotFoundException: print("Database doesn't exist") except Exception as err: print("Describe database failed:", err) Describe database 91 Amazon Timestream Node.js Developer Guide The following snippet uses AWS SDK for JavaScript v3. For more information about how to install the client and usage, see Timestream Write Client - AWS SDK for JavaScript v3. Also see Class DescribeDatabaseCommand and DescribeDatabase. import { TimestreamWriteClient, DescribeDatabaseCommand } from "@aws-sdk/client- timestream-write"; const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); const params = { DatabaseName: "testDbFromNode" }; const command = new DescribeDatabaseCommand(params); try { const data = await writeClient.send(command); console.log(`Database ${data.Database.DatabaseName} has id ${data.Database.Arn}`); } catch (error) { if (error.code === 'ResourceNotFoundException') { console.log("Database doesn't exist."); } else { console.log("Describe database failed.", error); throw error; } } The following snippet uses the AWS SDK for JavaScript V2 style. It
timestream-034	timestream.pdf	34	information about how to install the client and usage, see Timestream Write Client - AWS SDK for JavaScript v3. Also see Class DescribeDatabaseCommand and DescribeDatabase. import { TimestreamWriteClient, DescribeDatabaseCommand } from "@aws-sdk/client- timestream-write"; const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); const params = { DatabaseName: "testDbFromNode" }; const command = new DescribeDatabaseCommand(params); try { const data = await writeClient.send(command); console.log(`Database ${data.Database.DatabaseName} has id ${data.Database.Arn}`); } catch (error) { if (error.code === 'ResourceNotFoundException') { console.log("Database doesn't exist."); } else { console.log("Describe database failed.", error); throw error; } } The following snippet uses the AWS SDK for JavaScript V2 style. It is based on the sample application at Node.js sample Amazon Timestream for LiveAnalytics application on GitHub. async function describeDatabase () { console.log("Describing Database"); const params = { DatabaseName: constants.DATABASE_NAME }; const promise = writeClient.describeDatabase(params).promise(); await promise.then( (data) => { Describe database 92 Amazon Timestream Developer Guide console.log(`Database ${data.Database.DatabaseName} has id ${data.Database.Arn}`); }, (err) => { if (err.code === 'ResourceNotFoundException') { console.log("Database doesn't exist."); } else { console.log("Describe database failed.", err); throw err; } } ); } .NET public async Task DescribeDatabase() { Console.WriteLine("Describing Database"); try { var describeDatabaseRequest = new DescribeDatabaseRequest { DatabaseName = Constants.DATABASE_NAME }; DescribeDatabaseResponse response = await writeClient.DescribeDatabaseAsync(describeDatabaseRequest); Console.WriteLine($"Database {Constants.DATABASE_NAME} has id: {response.Database.Arn}"); } catch (ResourceNotFoundException) { Console.WriteLine("Database does not exist."); } catch (Exception e) { Console.WriteLine("Describe database failed:" + e.ToString()); } } Describe database 93 Amazon Timestream Update database Developer Guide You can use the following code snippets to update your databases. Note These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java public void updateDatabase(String kmsId) { System.out.println("Updating kmsId to " + kmsId); UpdateDatabaseRequest request = new UpdateDatabaseRequest(); request.setDatabaseName(DATABASE_NAME); request.setKmsKeyId(kmsId); try { UpdateDatabaseResult result = amazonTimestreamWrite.updateDatabase(request); System.out.println("Update Database complete"); } catch (final ValidationException e) { System.out.println("Update database failed:"); e.printStackTrace(); } catch (final ResourceNotFoundException e) { System.out.println("Database " + DATABASE_NAME + " doesn't exist = " + e); } catch (final Exception e) { System.out.println("Could not update Database " + DATABASE_NAME + " = " + e); throw e; } } Java v2 public void updateDatabase(String kmsKeyId) { if (kmsKeyId == null) { System.out.println("Skipping UpdateDatabase because KmsKeyId was not given"); return; Update a database 94 Amazon Timestream } Developer Guide System.out.println("Updating database"); UpdateDatabaseRequest request = UpdateDatabaseRequest.builder() .databaseName(DATABASE_NAME) .kmsKeyId(kmsKeyId) .build(); try { timestreamWriteClient.updateDatabase(request); System.out.println("Database [" + DATABASE_NAME + "] updated successfully with kmsKeyId " + kmsKeyId); } catch (ResourceNotFoundException e) { System.out.println("Database [" + DATABASE_NAME + "] does not exist. Skipping UpdateDatabase"); } catch (Exception e) { System.out.println("UpdateDatabase failed: " + e); } } Go // Update Database. updateDatabaseInput := &timestreamwrite.UpdateDatabaseInput { DatabaseName: aws.String(databaseName), KmsKeyId: aws.String(kmsKeyId), } updateDatabaseOutput, err := writeSvc.UpdateDatabase(updateDatabaseInput) if err != nil { fmt.Println("Error:") fmt.Println(err) } else { fmt.Println("Update database is successful, below is the output:") fmt.Println(updateDatabaseOutput) } Python def update_database(self, kms_id): print("Updating database") try: Update a database 95 Amazon Timestream result = Developer Guide self.client.update_database(DatabaseName=Constant.DATABASE_NAME, KmsKeyId=kms_id) print("Database [%s] was updated to use kms [%s] successfully" % (Constant.DATABASE_NAME, result['Database']['KmsKeyId'])) except self.client.exceptions.ResourceNotFoundException: print("Database doesn't exist") except Exception as err: print("Update database failed:", err) Node.js The following snippet uses AWS SDK for JavaScript v3. For more information about how to install the client and usage, see Timestream Write Client - AWS SDK for JavaScript v3. Also see Class UpdateDatabaseCommand and UpdateDatabase. import { TimestreamWriteClient, UpdateDatabaseCommand } from "@aws-sdk/client- timestream-write"; const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); let updatedKmsKeyId = "<updatedKmsKeyId>"; const params = { DatabaseName: "testDbFromNode", KmsKeyId: updatedKmsKeyId }; const command = new UpdateDatabaseCommand(params); try { const data = await writeClient.send(command); console.log(`Database ${data.Database.DatabaseName} updated kmsKeyId to ${updatedKmsKeyId}`); } catch (error) { if (error.code === 'ResourceNotFoundException') { console.log("Database doesn't exist."); } else { console.log("Update database failed.", error); } } Update a database 96 Amazon Timestream Developer Guide The following snippet uses the AWS SDK for JavaScript V2 style. It is based on the sample application at Node.js sample Amazon Timestream for LiveAnalytics application on GitHub. async function updateDatabase(updatedKmsKeyId) { if (updatedKmsKeyId === undefined) { console.log("Skipping UpdateDatabase; KmsKeyId was not given"); return; } console.log("Updating Database"); const params = { DatabaseName: constants.DATABASE_NAME, KmsKeyId: updatedKmsKeyId } const promise = writeClient.updateDatabase(params).promise(); await promise.then( (data) => { console.log(`Database ${data.Database.DatabaseName} updated kmsKeyId to ${updatedKmsKeyId}`); }, (err) => { if (err.code === 'ResourceNotFoundException') { console.log("Database doesn't exist."); } else { console.log("Update database failed.", err); } } ); } .NET public async Task UpdateDatabase(String updatedKmsKeyId) { Console.WriteLine("Updating Database"); try { var updateDatabaseRequest = new UpdateDatabaseRequest { DatabaseName = Constants.DATABASE_NAME, Update a database 97 Amazon Timestream Developer Guide KmsKeyId = updatedKmsKeyId }; UpdateDatabaseResponse response = await writeClient.UpdateDatabaseAsync(updateDatabaseRequest); Console.WriteLine($"Database {Constants.DATABASE_NAME} updated with KmsKeyId {updatedKmsKeyId}"); } catch (ResourceNotFoundException) { Console.WriteLine("Database does not exist."); } catch (Exception e) { Console.WriteLine("Update database failed: " + e.ToString()); } } private void PrintDatabases(List<Database> databases) { foreach (Database database in databases) Console.WriteLine($"Database:{database.DatabaseName}"); } Delete database
timestream-035	timestream.pdf	35	(err) => { if (err.code === 'ResourceNotFoundException') { console.log("Database doesn't exist."); } else { console.log("Update database failed.", err); } } ); } .NET public async Task UpdateDatabase(String updatedKmsKeyId) { Console.WriteLine("Updating Database"); try { var updateDatabaseRequest = new UpdateDatabaseRequest { DatabaseName = Constants.DATABASE_NAME, Update a database 97 Amazon Timestream Developer Guide KmsKeyId = updatedKmsKeyId }; UpdateDatabaseResponse response = await writeClient.UpdateDatabaseAsync(updateDatabaseRequest); Console.WriteLine($"Database {Constants.DATABASE_NAME} updated with KmsKeyId {updatedKmsKeyId}"); } catch (ResourceNotFoundException) { Console.WriteLine("Database does not exist."); } catch (Exception e) { Console.WriteLine("Update database failed: " + e.ToString()); } } private void PrintDatabases(List<Database> databases) { foreach (Database database in databases) Console.WriteLine($"Database:{database.DatabaseName}"); } Delete database You can use the following code snippet to delete a database. Note These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java public void deleteDatabase() { System.out.println("Deleting database"); final DeleteDatabaseRequest deleteDatabaseRequest = new DeleteDatabaseRequest(); deleteDatabaseRequest.setDatabaseName(DATABASE_NAME); Delete database 98 Amazon Timestream try { Developer Guide DeleteDatabaseResult result = amazonTimestreamWrite.deleteDatabase(deleteDatabaseRequest); System.out.println("Delete database status: " + result.getSdkHttpMetadata().getHttpStatusCode()); } catch (final ResourceNotFoundException e) { System.out.println("Database " + DATABASE_NAME + " doesn't exist = " + e); throw e; } catch (final Exception e) { System.out.println("Could not delete Database " + DATABASE_NAME + " = " + e); throw e; } } Java v2 public void deleteDatabase() { System.out.println("Deleting database"); final DeleteDatabaseRequest deleteDatabaseRequest = new DeleteDatabaseRequest(); deleteDatabaseRequest.setDatabaseName(DATABASE_NAME); try { DeleteDatabaseResult result = amazonTimestreamWrite.deleteDatabase(deleteDatabaseRequest); System.out.println("Delete database status: " + result.getSdkHttpMetadata().getHttpStatusCode()); } catch (final ResourceNotFoundException e) { System.out.println("Database " + DATABASE_NAME + " doesn't exist = " + e); throw e; } catch (final Exception e) { System.out.println("Could not delete Database " + DATABASE_NAME + " = " + e); throw e; } } Go deleteDatabaseInput := &timestreamwrite.DeleteDatabaseInput{ DatabaseName: aws.String(databaseName), Delete database 99 Amazon Timestream } Developer Guide _, err = writeSvc.DeleteDatabase(deleteDatabaseInput) if err != nil { fmt.Println("Error:") fmt.Println(err) } else { fmt.Println("Database deleted:", databaseName) } Python def delete_database(self): print("Deleting Database") try: result = self.client.delete_database(DatabaseName=Constant.DATABASE_NAME) print("Delete database status [%s]" % result['ResponseMetadata'] ['HTTPStatusCode']) except self.client.exceptions.ResourceNotFoundException: print("database [%s] doesn't exist" % Constant.DATABASE_NAME) except Exception as err: print("Delete database failed:", err) Node.js The following snippet uses AWS SDK for JavaScript v3. For more information about how to install the client and usage, see Timestream Write Client - AWS SDK for JavaScript v3. Also see Class DeleteDatabaseCommand and DeleteDatabase. import { TimestreamWriteClient, DeleteDatabaseCommand } from "@aws-sdk/client- timestream-write"; const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); const params = { DatabaseName: "testDbFromNode" }; const command = new DeleteDatabaseCommand(params); try { Delete database 100 Amazon Timestream Developer Guide const data = await writeClient.send(command); console.log("Deleted database"); } catch (error) { if (error.code === 'ResourceNotFoundException') { console.log(`Database ${params.DatabaseName} doesn't exists.`); } else { console.log("Delete database failed.", error); throw error; } } The following snippet uses the AWS SDK for JavaScript V2 style. It is based on the sample application at Node.js sample Amazon Timestream for LiveAnalytics application on GitHub. async function deleteDatabase() { console.log("Deleting Database"); const params = { DatabaseName: constants.DATABASE_NAME }; const promise = writeClient.deleteDatabase(params).promise(); await promise.then( function (data) { console.log("Deleted database"); }, function(err) { if (err.code === 'ResourceNotFoundException') { console.log(`Database ${params.DatabaseName} doesn't exists.`); } else { console.log("Delete database failed.", err); throw err; } } ); } .NET public async Task DeleteDatabase() { Console.WriteLine("Deleting database"); try Delete database 101 Amazon Timestream { Developer Guide var deleteDatabaseRequest = new DeleteDatabaseRequest { DatabaseName = Constants.DATABASE_NAME }; DeleteDatabaseResponse response = await writeClient.DeleteDatabaseAsync(deleteDatabaseRequest); Console.WriteLine($"Database {Constants.DATABASE_NAME} delete request status:{response.HttpStatusCode}"); } catch (ResourceNotFoundException) { Console.WriteLine($"Database {Constants.DATABASE_NAME} does not exists"); } catch (Exception e) { Console.WriteLine("Exception while deleting database:" + e.ToString()); } } List databases You can use the following code snippets to list your databases. Note These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java public void listDatabases() { System.out.println("Listing databases"); ListDatabasesRequest request = new ListDatabasesRequest(); ListDatabasesResult result = amazonTimestreamWrite.listDatabases(request); final List<Database> databases = result.getDatabases(); printDatabases(databases); List databases 102 Amazon Timestream Developer Guide String nextToken = result.getNextToken(); while (nextToken != null && !nextToken.isEmpty()) { request.setNextToken(nextToken); ListDatabasesResult nextResult = amazonTimestreamWrite.listDatabases(request); final List<Database> nextDatabases = nextResult.getDatabases(); printDatabases(nextDatabases); nextToken = nextResult.getNextToken(); } } private void printDatabases(List<Database> databases) { for (Database db : databases) { System.out.println(db.getDatabaseName()); } } Java v2 public void listDatabases() { System.out.println("Listing databases"); ListDatabasesRequest request = ListDatabasesRequest.builder().maxResults(2).build(); ListDatabasesIterable listDatabasesIterable = timestreamWriteClient.listDatabasesPaginator(request); for(ListDatabasesResponse listDatabasesResponse : listDatabasesIterable) { final List<Database> databases = listDatabasesResponse.databases(); databases.forEach(database -> System.out.println(database.databaseName())); } } Go // List databases. listDatabasesMaxResult := int64(15) listDatabasesInput := &timestreamwrite.ListDatabasesInput{ MaxResults: &listDatabasesMaxResult, } listDatabasesOutput, err := writeSvc.ListDatabases(listDatabasesInput) List databases 103 Amazon Timestream Developer Guide if err != nil { fmt.Println("Error:") fmt.Println(err) } else { fmt.Println("List databases is successful, below is the output:") fmt.Println(listDatabasesOutput) } Python def list_databases(self): print("Listing databases") try: result = self.client.list_databases(MaxResults=5) self._print_databases(result['Databases']) next_token = result.get('NextToken', None) while next_token: result = self.client.list_databases(NextToken=next_token, MaxResults=5) self._print_databases(result['Databases']) next_token = result.get('NextToken', None) except
timestream-036	timestream.pdf	36	v2 public void listDatabases() { System.out.println("Listing databases"); ListDatabasesRequest request = ListDatabasesRequest.builder().maxResults(2).build(); ListDatabasesIterable listDatabasesIterable = timestreamWriteClient.listDatabasesPaginator(request); for(ListDatabasesResponse listDatabasesResponse : listDatabasesIterable) { final List<Database> databases = listDatabasesResponse.databases(); databases.forEach(database -> System.out.println(database.databaseName())); } } Go // List databases. listDatabasesMaxResult := int64(15) listDatabasesInput := &timestreamwrite.ListDatabasesInput{ MaxResults: &listDatabasesMaxResult, } listDatabasesOutput, err := writeSvc.ListDatabases(listDatabasesInput) List databases 103 Amazon Timestream Developer Guide if err != nil { fmt.Println("Error:") fmt.Println(err) } else { fmt.Println("List databases is successful, below is the output:") fmt.Println(listDatabasesOutput) } Python def list_databases(self): print("Listing databases") try: result = self.client.list_databases(MaxResults=5) self._print_databases(result['Databases']) next_token = result.get('NextToken', None) while next_token: result = self.client.list_databases(NextToken=next_token, MaxResults=5) self._print_databases(result['Databases']) next_token = result.get('NextToken', None) except Exception as err: print("List databases failed:", err) Node.js The following snippet uses AWS SDK for JavaScript v3. For more information about how to install the client and usage, see Timestream Write Client - AWS SDK for JavaScript v3. Also see Class ListDatabasesCommand and ListDatabases. import { TimestreamWriteClient, ListDatabasesCommand } from "@aws-sdk/client- timestream-write"; const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); const params = { MaxResults: 15 }; const command = new ListDatabasesCommand(params); getDatabasesList(null); List databases 104 Amazon Timestream Developer Guide async function getDatabasesList(nextToken) { if (nextToken) { params.NextToken = nextToken; } try { const data = await writeClient.send(command); data.Databases.forEach(function (database) { console.log(database.DatabaseName); }); if (data.NextToken) { return getDatabasesList(data.NextToken); } } catch (error) { console.log("Error while listing databases", error); } } The following snippet uses the AWS SDK for JavaScript V2 style. It is based on the sample application at Node.js sample Amazon Timestream for LiveAnalytics application on GitHub. async function listDatabases() { console.log("Listing databases:"); const databases = await getDatabasesList(null); databases.forEach(function(database){ console.log(database.DatabaseName); }); } function getDatabasesList(nextToken, databases = []) { var params = { MaxResults: 15 }; if(nextToken) { params.NextToken = nextToken; } return writeClient.listDatabases(params).promise() .then( (data) => { List databases 105 Amazon Timestream Developer Guide databases.push.apply(databases, data.Databases); if (data.NextToken) { return getDatabasesList(data.NextToken, databases); } else { return databases; } }, (err) => { console.log("Error while listing databases", err); }); } .NET public async Task ListDatabases() { Console.WriteLine("Listing Databases"); try { var listDatabasesRequest = new ListDatabasesRequest { MaxResults = 5 }; ListDatabasesResponse response = await writeClient.ListDatabasesAsync(listDatabasesRequest); PrintDatabases(response.Databases); var nextToken = response.NextToken; while (nextToken != null) { listDatabasesRequest.NextToken = nextToken; response = await writeClient.ListDatabasesAsync(listDatabasesRequest); PrintDatabases(response.Databases); nextToken = response.NextToken; } } catch (Exception e) { Console.WriteLine("List database failed:" + e.ToString()); } } List databases 106 Amazon Timestream Create table Topics • Memory store writes • Magnetic store writes Memory store writes Developer Guide You can use the following code snippet to create a table that has magnetic store writes disabled, as a result you can only write data into your memory store retention window. Note These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java public void createTable() { System.out.println("Creating table"); CreateTableRequest createTableRequest = new CreateTableRequest(); createTableRequest.setDatabaseName(DATABASE_NAME); createTableRequest.setTableName(TABLE_NAME); final RetentionProperties retentionProperties = new RetentionProperties() .withMemoryStoreRetentionPeriodInHours(HT_TTL_HOURS) .withMagneticStoreRetentionPeriodInDays(CT_TTL_DAYS); createTableRequest.setRetentionProperties(retentionProperties); try { amazonTimestreamWrite.createTable(createTableRequest); System.out.println("Table [" + TABLE_NAME + "] successfully created."); } catch (ConflictException e) { System.out.println("Table [" + TABLE_NAME + "] exists on database [" + DATABASE_NAME + "] . Skipping database creation"); } } Create table 107 Amazon Timestream Java v2 Developer Guide public void createTable() { System.out.println("Creating table"); final RetentionProperties retentionProperties = RetentionProperties.builder() .memoryStoreRetentionPeriodInHours(HT_TTL_HOURS) .magneticStoreRetentionPeriodInDays(CT_TTL_DAYS).build(); final CreateTableRequest createTableRequest = CreateTableRequest.builder() .databaseName(DATABASE_NAME).tableName(TABLE_NAME).retentionProperties(retentionProperties).build(); try { timestreamWriteClient.createTable(createTableRequest); System.out.println("Table [" + TABLE_NAME + "] successfully created."); } catch (ConflictException e) { System.out.println("Table [" + TABLE_NAME + "] exists on database [" + DATABASE_NAME + "] . Skipping database creation"); } } Go // Create table. createTableInput := &timestreamwrite.CreateTableInput{ DatabaseName: aws.String(databaseName), TableName: aws.String(tableName), } _, err = writeSvc.CreateTable(createTableInput) if err != nil { fmt.Println("Error:") fmt.Println(err) } else { fmt.Println("Create table is successful") } Python def create_table(self): print("Creating table") retention_properties = { Create table 108 Amazon Timestream Developer Guide 'MemoryStoreRetentionPeriodInHours': Constant.HT_TTL_HOURS, 'MagneticStoreRetentionPeriodInDays': Constant.CT_TTL_DAYS } try: self.client.create_table(DatabaseName=Constant.DATABASE_NAME, TableName=Constant.TABLE_NAME, RetentionProperties=retention_properties) print("Table [%s] successfully created." % Constant.TABLE_NAME) except self.client.exceptions.ConflictException: print("Table [%s] exists on database [%s]. Skipping table creation" % ( Constant.TABLE_NAME, Constant.DATABASE_NAME)) except Exception as err: print("Create table failed:", err) Node.js The following snippet uses AWS SDK for JavaScript v3. For more information about how to install the client and usage, see Timestream Write Client - AWS SDK for JavaScript v3. Also see Class CreateTableCommand and CreateTable. import { TimestreamWriteClient, CreateTableCommand } from "@aws-sdk/client- timestream-write"; const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); const params = { DatabaseName: "testDbFromNode", TableName: "testTableFromNode", RetentionProperties: { MemoryStoreRetentionPeriodInHours: 24, MagneticStoreRetentionPeriodInDays: 365 } }; const command = new CreateTableCommand(params); try { const data = await writeClient.send(command); console.log(`Table ${data.Table.TableName} created successfully`); } catch (error) { if (error.code === 'ConflictException') { console.log(`Table ${params.TableName} already exists on db ${params.DatabaseName}. Skipping creation.`); Create table 109 Amazon Timestream } else { console.log("Error creating table. ", error); throw error; } } Developer Guide The following snippet uses the AWS SDK for JavaScript V2 style. It is
timestream-037	timestream.pdf	37	and CreateTable. import { TimestreamWriteClient, CreateTableCommand } from "@aws-sdk/client- timestream-write"; const writeClient = new TimestreamWriteClient({ region: "us-east-1" }); const params = { DatabaseName: "testDbFromNode", TableName: "testTableFromNode", RetentionProperties: { MemoryStoreRetentionPeriodInHours: 24, MagneticStoreRetentionPeriodInDays: 365 } }; const command = new CreateTableCommand(params); try { const data = await writeClient.send(command); console.log(`Table ${data.Table.TableName} created successfully`); } catch (error) { if (error.code === 'ConflictException') { console.log(`Table ${params.TableName} already exists on db ${params.DatabaseName}. Skipping creation.`); Create table 109 Amazon Timestream } else { console.log("Error creating table. ", error); throw error; } } Developer Guide The following snippet uses the AWS SDK for JavaScript V2 style. It is based on the sample application at Node.js sample Amazon Timestream for LiveAnalytics application on GitHub. async function createTable() { console.log("Creating Table"); const params = { DatabaseName: constants.DATABASE_NAME, TableName: constants.TABLE_NAME, RetentionProperties: { MemoryStoreRetentionPeriodInHours: constants.HT_TTL_HOURS, MagneticStoreRetentionPeriodInDays: constants.CT_TTL_DAYS } }; const promise = writeClient.createTable(params).promise(); await promise.then( (data) => { console.log(`Table ${data.Table.TableName} created successfully`); }, (err) => { if (err.code === 'ConflictException') { console.log(`Table ${params.TableName} already exists on db ${params.DatabaseName}. Skipping creation.`); } else { console.log("Error creating table. ", err); throw err; } } ); } .NET public async Task CreateTable() { Console.WriteLine("Creating Table"); Create table 110 Amazon Timestream Developer Guide try { var createTableRequest = new CreateTableRequest { DatabaseName = Constants.DATABASE_NAME, TableName = Constants.TABLE_NAME, RetentionProperties = new RetentionProperties { MagneticStoreRetentionPeriodInDays = Constants.CT_TTL_DAYS, MemoryStoreRetentionPeriodInHours = Constants.HT_TTL_HOURS } }; CreateTableResponse response = await writeClient.CreateTableAsync(createTableRequest); Console.WriteLine($"Table {Constants.TABLE_NAME} created"); } catch (ConflictException) { Console.WriteLine("Table already exists."); } catch (Exception e) { Console.WriteLine("Create table failed:" + e.ToString()); } } Magnetic store writes You can use the following code snippet to create a table with magnetic store writes enabled. With magnetic store writes you can write data into both your memory store retention window and magnetic store retention window. Note These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Create table 111 Amazon Timestream Java Developer Guide public void createTable(String databaseName, String tableName) { System.out.println("Creating table"); CreateTableRequest createTableRequest = new CreateTableRequest(); createTableRequest.setDatabaseName(databaseName); createTableRequest.setTableName(tableName); final RetentionProperties retentionProperties = new RetentionProperties() .withMemoryStoreRetentionPeriodInHours(HT_TTL_HOURS) .withMagneticStoreRetentionPeriodInDays(CT_TTL_DAYS); createTableRequest.setRetentionProperties(retentionProperties); // Enable MagneticStoreWrite final MagneticStoreWriteProperties magneticStoreWriteProperties = new MagneticStoreWriteProperties() .withEnableMagneticStoreWrites(true); createTableRequest.setMagneticStoreWriteProperties(magneticStoreWriteProperties); try { amazonTimestreamWrite.createTable(createTableRequest); System.out.println("Table [" + tableName + "] successfully created."); } catch (ConflictException e) { System.out.println("Table [" + tableName + "] exists on database [" + databaseName + "] . Skipping table creation"); //We do not throw exception here, we use the existing table instead } } Java v2 public void createTable(String databaseName, String tableName) { System.out.println("Creating table"); // Enable MagneticStoreWrite final MagneticStoreWriteProperties magneticStoreWriteProperties = MagneticStoreWriteProperties.builder() .enableMagneticStoreWrites(true) .build(); CreateTableRequest createTableRequest = CreateTableRequest.builder() .databaseName(databaseName) .tableName(tableName) .retentionProperties(RetentionProperties.builder() Create table 112 Amazon Timestream Developer Guide .memoryStoreRetentionPeriodInHours(HT_TTL_HOURS) .magneticStoreRetentionPeriodInDays(CT_TTL_DAYS) .build()) .magneticStoreWriteProperties(magneticStoreWriteProperties) .build(); try { timestreamWriteClient.createTable(createTableRequest); System.out.println("Table [" + tableName + "] successfully created."); } catch (ConflictException e) { System.out.println("Table [" + tableName + "] exists in database [" + databaseName + "] . Skipping table creation"); } } Go // Create table. createTableInput := &timestreamwrite.CreateTableInput{ DatabaseName: aws.String(databaseName), TableName: aws.String(tableName), // Enable MagneticStoreWrite MagneticStoreWriteProperties: &timestreamwrite.MagneticStoreWriteProperties{ EnableMagneticStoreWrites: aws.Bool(true), }, } _, err = writeSvc.CreateTable(createTableInput) Python def create_table(self): print("Creating table") retention_properties = { 'MemoryStoreRetentionPeriodInHours': Constant.HT_TTL_HOURS, 'MagneticStoreRetentionPeriodInDays': Constant.CT_TTL_DAYS } magnetic_store_write_properties = { 'EnableMagneticStoreWrites': True } try: self.client.create_table(DatabaseName=Constant.DATABASE_NAME, TableName=Constant.TABLE_NAME, RetentionProperties=retention_properties, Create table 113 Amazon Timestream Developer Guide MagneticStoreWriteProperties=magnetic_store_write_properties) print("Table [%s] successfully created." % Constant.TABLE_NAME) except self.client.exceptions.ConflictException: print("Table [%s] exists on database [%s]. Skipping table creation" % ( Constant.TABLE_NAME, Constant.DATABASE_NAME)) except Exception as err: print("Create table failed:", err) Node.js async function createTable() { console.log("Creating Table"); const params = { DatabaseName: constants.DATABASE_NAME, TableName: constants.TABLE_NAME, RetentionProperties: { MemoryStoreRetentionPeriodInHours: constants.HT_TTL_HOURS, MagneticStoreRetentionPeriodInDays: constants.CT_TTL_DAYS }, MagneticStoreWriteProperties: { EnableMagneticStoreWrites: true } }; const promise = writeClient.createTable(params).promise(); await promise.then( (data) => { console.log(`Table ${data.Table.TableName} created successfully`); }, (err) => { if (err.code === 'ConflictException') { console.log(`Table ${params.TableName} already exists on db ${params.DatabaseName}. Skipping creation.`); } else { console.log("Error creating table. ", err); throw err; } } ); } Create table 114 Amazon Timestream .NET Developer Guide public async Task CreateTable() { Console.WriteLine("Creating Table"); try { var createTableRequest = new CreateTableRequest { DatabaseName = Constants.DATABASE_NAME, TableName = Constants.TABLE_NAME, RetentionProperties = new RetentionProperties { MagneticStoreRetentionPeriodInDays = Constants.CT_TTL_DAYS, MemoryStoreRetentionPeriodInHours = Constants.HT_TTL_HOURS }, // Enable MagneticStoreWrite MagneticStoreWriteProperties = new MagneticStoreWriteProperties { EnableMagneticStoreWrites = true, } }; CreateTableResponse response = await writeClient.CreateTableAsync(createTableRequest); Console.WriteLine($"Table {Constants.TABLE_NAME} created"); } catch (ConflictException) { Console.WriteLine("Table already exists."); } catch (Exception e) { Console.WriteLine("Create table failed:" + e.ToString()); } } Describe table You can use the following code snippets to get information about the attributes of your table. Describe table 115 Amazon Timestream Note Developer Guide These code snippets are based on full sample applications on GitHub. For more information about how to get started with the sample applications, see Sample application. Java public void describeTable() { System.out.println("Describing table"); final DescribeTableRequest describeTableRequest = new DescribeTableRequest(); describeTableRequest.setDatabaseName(DATABASE_NAME); describeTableRequest.setTableName(TABLE_NAME); try { DescribeTableResult result = amazonTimestreamWrite.describeTable(describeTableRequest); String tableId = result.getTable().getArn();

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.