Skip to content

Commit f90c7a4

Browse files
author
AWS
committed
AWS IoT SiteWise Update: This release adds support for customer managed customer master key (CMK) based encryption in IoT SiteWise.
1 parent cb6df91 commit f90c7a4

File tree

2 files changed

+155
-3
lines changed

2 files changed

+155
-3
lines changed

‎.changes/next-release/feature-AWSIoTSiteWise-bf4dfc0.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT SiteWise",
4+
"contributor": "",
5+
"description": "This release adds support for customer managed customer master key (CMK) based encryption in IoT SiteWise."
6+
}

‎services/iotsitewise/src/main/resources/codegen-resources/service-2.json

Lines changed: 149 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
{"shape":"InternalFailureException"},
220220
{"shape":"ThrottlingException"}
221221
],
222-
"documentation":"<p>Creates a pre-signed URL to a portal. Use this operation to create URLs to portals that use AWS Identity and Access Management (IAM) to authenticate users. An IAM user with access to a portal can call this API to get a URL to that portal. The URL contains a session token that lets the IAM user access the portal.</p>",
222+
"documentation":"<p>Creates a pre-signed URL to a portal. Use this operation to create URLs to portals that use AWS Identity and Access Management (IAM) to authenticate users. An IAM user with access to a portal can call this API to get a URL to that portal. The URL contains an authentication token that lets the IAM user access the portal.</p>",
223223
"endpoint":{"hostPrefix":"monitor."}
224224
},
225225
"CreateProject":{
@@ -455,6 +455,21 @@
455455
"documentation":"<p>Retrieves information about a dashboard.</p>",
456456
"endpoint":{"hostPrefix":"monitor."}
457457
},
458+
"DescribeDefaultEncryptionConfiguration":{
459+
"name":"DescribeDefaultEncryptionConfiguration",
460+
"http":{
461+
"method":"GET",
462+
"requestUri":"/configuration/account/encryption"
463+
},
464+
"input":{"shape":"DescribeDefaultEncryptionConfigurationRequest"},
465+
"output":{"shape":"DescribeDefaultEncryptionConfigurationResponse"},
466+
"errors":[
467+
{"shape":"InvalidRequestException"},
468+
{"shape":"InternalFailureException"},
469+
{"shape":"ThrottlingException"}
470+
],
471+
"documentation":"<p>Retrieves information about the default encryption configuration for the AWS account in the default or specified region. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html\">Key management</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>"
472+
},
458473
"DescribeGateway":{
459474
"name":"DescribeGateway",
460475
"http":{
@@ -780,6 +795,23 @@
780795
],
781796
"documentation":"<p>Retrieves the list of tags for an AWS IoT SiteWise resource.</p>"
782797
},
798+
"PutDefaultEncryptionConfiguration":{
799+
"name":"PutDefaultEncryptionConfiguration",
800+
"http":{
801+
"method":"POST",
802+
"requestUri":"/configuration/account/encryption"
803+
},
804+
"input":{"shape":"PutDefaultEncryptionConfigurationRequest"},
805+
"output":{"shape":"PutDefaultEncryptionConfigurationResponse"},
806+
"errors":[
807+
{"shape":"InvalidRequestException"},
808+
{"shape":"InternalFailureException"},
809+
{"shape":"ThrottlingException"},
810+
{"shape":"LimitExceededException"},
811+
{"shape":"ConflictingOperationException"}
812+
],
813+
"documentation":"<p>Sets the default encryption configuration for the AWS account. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html\">Key management</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>"
814+
},
783815
"PutLoggingOptions":{
784816
"name":"PutLoggingOptions",
785817
"http":{
@@ -1795,6 +1827,47 @@
17951827
"min":36,
17961828
"pattern":"\\S{36,64}"
17971829
},
1830+
"ConfigurationErrorDetails":{
1831+
"type":"structure",
1832+
"required":[
1833+
"code",
1834+
"message"
1835+
],
1836+
"members":{
1837+
"code":{
1838+
"shape":"ErrorCode",
1839+
"documentation":"<p/>"
1840+
},
1841+
"message":{
1842+
"shape":"ErrorMessage",
1843+
"documentation":"<p/>"
1844+
}
1845+
},
1846+
"documentation":"<p/>"
1847+
},
1848+
"ConfigurationState":{
1849+
"type":"string",
1850+
"enum":[
1851+
"ACTIVE",
1852+
"UPDATE_IN_PROGRESS",
1853+
"UPDATE_FAILED"
1854+
]
1855+
},
1856+
"ConfigurationStatus":{
1857+
"type":"structure",
1858+
"required":["state"],
1859+
"members":{
1860+
"state":{
1861+
"shape":"ConfigurationState",
1862+
"documentation":"<p/>"
1863+
},
1864+
"error":{
1865+
"shape":"ConfigurationErrorDetails",
1866+
"documentation":"<p/>"
1867+
}
1868+
},
1869+
"documentation":"<p/>"
1870+
},
17981871
"ConflictingOperationException":{
17991872
"type":"structure",
18001873
"required":[
@@ -2143,7 +2216,7 @@
21432216
},
21442217
"sessionDurationSeconds":{
21452218
"shape":"SessionDurationSeconds",
2146-
"documentation":"<p>The duration (in seconds) for which the session at the URL is valid.</p> <p>Default: 900 seconds (15 minutes)</p>",
2219+
"documentation":"<p>The duration (in seconds) for which the session at the URL is valid.</p> <p>Default: 43,200 seconds (12 hours)</p>",
21472220
"location":"querystring",
21482221
"locationName":"sessionDurationSeconds"
21492222
}
@@ -2155,7 +2228,7 @@
21552228
"members":{
21562229
"presignedPortalUrl":{
21572230
"shape":"Url",
2158-
"documentation":"<p>The pre-signed URL to the portal. The URL contains the portal ID and a session token that lets you access the portal. The URL has the following format.</p> <p> <code>https://&lt;portal-id&gt;.app.iotsitewise.aws/auth?token=&lt;encrypted-token&gt;</code> </p>"
2231+
"documentation":"<p>The pre-signed URL to the portal. The URL contains the portal ID and an authentication token that lets you access the portal. The URL has the following format.</p> <p> <code>https://&lt;portal-id&gt;.app.iotsitewise.aws/iam?token=&lt;encrypted-token&gt;</code> </p>"
21592232
}
21602233
}
21612234
},
@@ -2711,6 +2784,32 @@
27112784
}
27122785
}
27132786
},
2787+
"DescribeDefaultEncryptionConfigurationRequest":{
2788+
"type":"structure",
2789+
"members":{
2790+
}
2791+
},
2792+
"DescribeDefaultEncryptionConfigurationResponse":{
2793+
"type":"structure",
2794+
"required":[
2795+
"encryptionType",
2796+
"configurationStatus"
2797+
],
2798+
"members":{
2799+
"encryptionType":{
2800+
"shape":"EncryptionType",
2801+
"documentation":"<p>The type of encryption used for the encryption configuration.</p>"
2802+
},
2803+
"kmsKeyArn":{
2804+
"shape":"ARN",
2805+
"documentation":"<p>The key ARN of the customer managed customer master key (CMK) used for AWS KMS encryption if you use <code>KMS_BASED_ENCRYPTION</code>.</p>"
2806+
},
2807+
"configurationStatus":{
2808+
"shape":"ConfigurationStatus",
2809+
"documentation":"<p>The status of the account configuration. This contains the <code>ConfigurationState</code>. If there's an error, it also contains the <code>ErrorDetails</code>.</p>"
2810+
}
2811+
}
2812+
},
27142813
"DescribeGatewayCapabilityConfigurationRequest":{
27152814
"type":"structure",
27162815
"required":[
@@ -3001,6 +3100,13 @@
30013100
"min":1,
30023101
"pattern":"[^@]+@[^@]+"
30033102
},
3103+
"EncryptionType":{
3104+
"type":"string",
3105+
"enum":[
3106+
"SITEWISE_DEFAULT_ENCRYPTION",
3107+
"KMS_BASED_ENCRYPTION"
3108+
]
3109+
},
30043110
"EntryId":{
30053111
"type":"string",
30063112
"max":64,
@@ -3486,6 +3592,11 @@
34863592
"error":{"httpStatusCode":400},
34873593
"exception":true
34883594
},
3595+
"KmsKeyId":{
3596+
"type":"string",
3597+
"max":2048,
3598+
"min":1
3599+
},
34893600
"LimitExceededException":{
34903601
"type":"structure",
34913602
"required":["message"],
@@ -4282,6 +4393,41 @@
42824393
},
42834394
"documentation":"<p>Contains a list of value updates for an asset property in the list of asset entries consumed by the <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html\">BatchPutAssetPropertyValue</a> API operation.</p>"
42844395
},
4396+
"PutDefaultEncryptionConfigurationRequest":{
4397+
"type":"structure",
4398+
"required":["encryptionType"],
4399+
"members":{
4400+
"encryptionType":{
4401+
"shape":"EncryptionType",
4402+
"documentation":"<p>The type of encryption used for the encryption configuration.</p>"
4403+
},
4404+
"kmsKeyId":{
4405+
"shape":"KmsKeyId",
4406+
"documentation":"<p>The Key ID of the customer managed customer master key (CMK) used for AWS KMS encryption. This is required if you use <code>KMS_BASED_ENCRYPTION</code>.</p>"
4407+
}
4408+
}
4409+
},
4410+
"PutDefaultEncryptionConfigurationResponse":{
4411+
"type":"structure",
4412+
"required":[
4413+
"encryptionType",
4414+
"configurationStatus"
4415+
],
4416+
"members":{
4417+
"encryptionType":{
4418+
"shape":"EncryptionType",
4419+
"documentation":"<p>The type of encryption used for the encryption configuration.</p>"
4420+
},
4421+
"kmsKeyArn":{
4422+
"shape":"ARN",
4423+
"documentation":"<p>The Key ARN of the AWS KMS CMK used for AWS KMS encryption if you use <code>KMS_BASED_ENCRYPTION</code>.</p>"
4424+
},
4425+
"configurationStatus":{
4426+
"shape":"ConfigurationStatus",
4427+
"documentation":"<p>The status of the account configuration. This contains the <code>ConfigurationState</code>. If there is an error, it also contains the <code>ErrorDetails</code>.</p>"
4428+
}
4429+
}
4430+
},
42854431
"PutLoggingOptionsRequest":{
42864432
"type":"structure",
42874433
"required":["loggingOptions"],

0 commit comments

Comments
 (0)